UGeometryMaskCanvasResource

API > API/Plugins > API/Plugins/GeometryMask

   
Name UGeometryMaskCanvasResource
Type class
Header File /Engine/Plugins/VirtualProduction/GeometryMask/Source/GeometryMask/Public/GeometryMaskCanvasResource.h
Include Path #include "GeometryMaskCanvasResource.h"

Syntax

UCLASS (MinimalAPI)  
class UGeometryMaskCanvasResource : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UGeometryMaskCanvasResource()

   GeometryMaskCanvasResource.h  

Constants

Name Type Remarks Include Path
MaxNumAvailableChannels int32   GeometryMaskCanvasResource.h
MaxNumChannels int32   GeometryMaskCanvasResource.h
MaxTextureSize int32   GeometryMaskCanvasResource.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bApplyBlur bool   GeometryMaskCanvasResource.h  
bApplyDF bool   GeometryMaskCanvasResource.h  
Canvas TSharedPtr< FCanvas > Canvas used for drawing. GeometryMaskCanvasResource.h  
DefaultDrawingContext FGeometryMaskDrawingContext   GeometryMaskCanvasResource.h  
DrawingContextCache TSet< FGeometryMaskDrawingContext >   GeometryMaskCanvasResource.h  
MaxViewportSize FIntPoint The default viewport size to use when it can't be resolved from the actual viewport. GeometryMaskCanvasResource.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetMaxViewportSize"
  • Category="Rendering"
  • Meta=(AllowPrivateAccess="true")
PostProcess_Blur TSharedPtr< FGeometryMaskPostProcess_Blur >   GeometryMaskCanvasResource.h  
PostProcess_DistanceField TSharedPtr< FGeometryMaskPostProcess_DistanceField >   GeometryMaskCanvasResource.h  
RenderTarget TObjectPtr< UTextureRenderTarget2DArray > The Render Target that this resource uses GeometryMaskCanvasResource.h
  • DuplicateTransient
RenderTargetSliceIndex int16 The render target slice assigned to this resource GeometryMaskCanvasResource.h
  • DuplicateTransient
SharedData TSharedPtr< FGeometryMaskCanvasSharedData > Shared data between canvases using the same render target GeometryMaskCanvasResource.h  
UsedChannelMask TBitArray< TInlineAllocator< UE::GeometryMask::MaxNumChannels > >   GeometryMaskCanvasResource.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool Checkin ( const FGeometryMaskCanvasId& InRequestingCanvasId
)

 Returns/frees the color channel associated with the given canvas name. GeometryMaskCanvasResource.h  

bool Checkout ( const EGeometryMaskColorChannel InColorChannel,
const FGeometryMaskCanvasId& InRequestingCanvasId
)

 Requests usage of the given color channel for this resource. Will return true if successful. GeometryMaskCanvasResource.h  

int32 Compact()

 Re-arranges used channels such that they are used sequentially. Returns number of unused channels. GeometryMaskCanvasResource.h  

TArray< FGeometryMaskCanvasId > GetDependentCanvasIds()

 Get the list of dependent canvases, for debug purposes. GeometryMaskCanvasResource.h  

const FIntPoint & GetMaxViewportSize()

 Returns the maximum size that would cover all requested viewports GeometryMaskCanvasResource.h  
Will return the first available color channel without a canvas assigned. GeometryMaskCanvasResource.h  

int32 GetNumChannelsUsed()

   GeometryMaskCanvasResource.h  

UTextureRenderTarget2DArray * GetRenderTarget()

 Returns the render target the resource draws to GeometryMaskCanvasResource.h  

int16 GetRenderTargetSliceIndex()

 Get the index to the render target slice the resource draws to GeometryMaskCanvasResource.h  

UCanvasRenderTarget2D * GetRenderTargetTexture()

   GeometryMaskCanvasResource.h  

int32 GetRequiredViewportPadding()

 Returns the minimum required viewport padding, in pixels - determined by certain effects. GeometryMaskCanvasResource.h  

const TSharedPtr< FGeometryMaskCanvasSharedData > & GetSharedData()

 Gets the data shared between canvases using the same render target GeometryMaskCanvasResource.h  

int32 GetSharedViewportPadding()

 Returns the current viewport padding GeometryMaskCanvasResource.h  

int32 GetViewportPadding ( const FGeometryMaskDrawingContext& InDrawingContext
) const

   GeometryMaskCanvasResource.h  

void Initialize ( UTextureRenderTarget2DArray* InRenderTarget,
int32 InSliceIndex,
const TSharedPtr< FGeometryMaskCanvasSharedData >& InSharedData
)

   GeometryMaskCanvasResource.h  

bool IsAnyChannelUsed()

   GeometryMaskCanvasResource.h  

FOnGeometryMaskCanvasDraw & OnDrawToCanvas()

   GeometryMaskCanvasResource.h  
Resets the render parameters for the resource GeometryMaskCanvasResource.h  
Resets the render parameters for the given channel. GeometryMaskCanvasResource.h  

void SetViewportSize ( FGeometryMaskDrawingContext& InDrawingContext,
const FIntPoint& InViewportSize
)

   GeometryMaskCanvasResource.h  

void Update ( const ULevel* InLevel,
FSceneView& InView,
int32 InViewIndex
)

 Updates the canvas, intended to be called every frame. GeometryMaskCanvasResource.h  

void UpdateRenderParameters ( bool bInApplyBlur,
double InBlurStrength,
bool bInApplyFeather,
int32 InOuterFeatherRadius,
int32 InInnerFeatherRadius
)

   GeometryMaskCanvasResource.h  

void UpdateRenderParameters ( EGeometryMaskColorChannel InColorChannel,
bool bInApplyBlur,
double InBlurStrength,
bool bInApplyFeather,
int32 InOuterFeatherRadius,
int32 InInnerFeatherRadius
)

   GeometryMaskCanvasResource.h  

bool UpdateViewportSize()

 Validates that the render target size is up-to-date with the viewport size and updating it if not GeometryMaskCanvasResource.h  

Public Virtual

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   GeometryMaskCanvasResource.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page