1. Epic GamesDeveloper
  3. UGeometryMaskCanvasResource

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 ()  
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 (R, G, B, A) GeometryMaskCanvasResource.h
MaxTextureSize int32   GeometryMaskCanvasResource.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bApplyBlur bool   GeometryMaskCanvasResource.h  
bApplyDF bool   GeometryMaskCanvasResource.h  
CanvasObject TObjectPtr< UCanvas > Underlying UCanvas object. GeometryMaskCanvasResource.h
  • Transient
DefaultDrawingContext FGeometryMaskDrawingContext   GeometryMaskCanvasResource.h  
DependentCanvasIds TMap< EGeometryMaskColorChannel, FGeometryMaskCanvasId >   GeometryMaskCanvasResource.h
  • NoClear
  • EditFixedSize
  • Meta=(EditFixedOrder)
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="Auto"
  • Category="Rendering"
  • Meta=(AllowPrivateAccess="true")
NumUsedChannels int32   GeometryMaskCanvasResource.h  
OnDrawToCanvasDelegate FOnGeometryMaskCanvasDraw   GeometryMaskCanvasResource.h  
PostProcess_Blur TSharedPtr< FGeometryMaskPostProcess_Blur >   GeometryMaskCanvasResource.h  
PostProcess_DistanceField TSharedPtr< FGeometryMaskPostProcess_DistanceField >   GeometryMaskCanvasResource.h  
RenderTargetTexture TObjectPtr< UCanvasRenderTarget2D > The underlying Render Target texture. GeometryMaskCanvasResource.h
  • DuplicateTransient
UsedChannelMask TBitArray< TInlineAllocator< 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  
Will return the first available color channel without a canvas assigned. GeometryMaskCanvasResource.h  

int32 GetNumChannelsUsed()

   GeometryMaskCanvasResource.h  

UCanvasRenderTarget2D * GetRenderTargetTexture()

   GeometryMaskCanvasResource.h  

int32 GetViewportPadding ( const FGeometryMaskDrawingContext& InDrawingContext
) const

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

bool IsAnyChannelUsed()

   GeometryMaskCanvasResource.h  

FOnGeometryMaskCanvasDraw & OnDrawToCanvas()

   GeometryMaskCanvasResource.h  

void ResetRenderParameters ( EGeometryMaskColorChannel InColorChannel
)

 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 ( EGeometryMaskColorChannel InColorChannel,
bool bInApplyBlur,
double InBlurStrength,
bool bInApplyFeather,
int32 InOuterFeatherRadius,
int32 InInnerFeatherRadius
)

   GeometryMaskCanvasResource.h  

void UpdateViewportSize()

   GeometryMaskCanvasResource.h  

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