1. Epic GamesDeveloper
  3. UGeometryMaskCanvas

UGeometryMaskCanvas

A uniquely identified Canvas.

API > API/Plugins > API/Plugins/GeometryMask

A uniquely identified Canvas.

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

Syntax

UCLASS (BlueprintType, Transient)  
class UGeometryMaskCanvas : public UObject

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
ApplyBlurPropertyName const FName   GeometryMaskCanvas.h
ApplyFeatherPropertyName const FName   GeometryMaskCanvas.h
BlurStrengthPropertyName const FName   GeometryMaskCanvas.h
InnerFeatherRadiusPropertyName const FName   GeometryMaskCanvas.h
OuterFeatherRadiusPropertyName const FName   GeometryMaskCanvas.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bApplyBlur bool Optional Blur Toggle. GeometryMaskCanvas.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="IsBlurApplied"
  • Setter="SetApplyBlur"
  • Category="Canvas"
  • Meta=(AllowPrivateAccess="true")
bApplyFeather bool Optional Feather Toggle. GeometryMaskCanvas.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="IsFeatherApplied"
  • Setter="SetApplyFeather"
  • Category="Canvas"
  • Meta=(AllowPrivateAccess="true")
BlurStrength double Optional Blur Strength. GeometryMaskCanvas.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Canvas"
  • Meta=(AllowPrivateAccess="true", EditCondition="bApplyBlur", EditConditionHides, ClampMin=0.0)
CanvasId FGeometryMaskCanvasId   GeometryMaskCanvas.h
  • Transient
  • DuplicateTransient
CanvasName FName Uniquely identifies this canvas. GeometryMaskCanvas.h
  • VisibleAnywhere
  • BlueprintReadOnly
  • Getter="Auto"
  • Category="Canvas"
  • Meta=(AllowPrivateAccess="true")
CanvasResource TObjectPtr< UGeometryMaskCanvasResource > Canvas GPU resource to use. GeometryMaskCanvas.h
  • Transient
ColorChannel EGeometryMaskColorChannel Color Channel being written to in the texture. GeometryMaskCanvas.h
  • Transient
  • Getter
InnerFeatherRadius int32 Optional Inner Feather Radius. GeometryMaskCanvas.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Canvas"
  • Meta=(AllowPrivateAccess="true", EditCondition="bApplyFeather", EditConditionHides, ClampMin=0)
OnActivatedDelegate FOnGeometryMaskCanvasActivated   GeometryMaskCanvas.h  
OnDeactivatedDelegate FOnGeometryMaskCanvasDeactivated   GeometryMaskCanvas.h  
OuterFeatherRadius int32 Optional Outer Feather Radius. GeometryMaskCanvas.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category="Canvas"
  • Meta=(AllowPrivateAccess="true", EditCondition="bApplyFeather", EditConditionHides, ClampMin=0)
Writers TArray< TWeakInterfacePtr< IGeometryMaskWriteInterface > > List of objects that write to this canvas. GeometryMaskCanvas.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddWriter ( const TScriptInterface< IGeometryMaskWriteInterface >& InWriter
)

 Adds a Mask Writer to the canvas. GeometryMaskCanvas.h  

void AddWriters ( const TArray< TScriptInterface< IGeometryMaskWriteInterface > >& InWriters
)

 Appends multiple writers to the canvas. GeometryMaskCanvas.h  

void AssignResource ( UGeometryMaskCanvasResource* InResource,
EGeometryMaskColorChannel InColorChannel
)

   GeometryMaskCanvas.h  

void Free()

 Forcibly free the canvas - removed all writers and frees the resource. GeometryMaskCanvas.h  

void FreeResource()

   GeometryMaskCanvas.h  

double GetBlurStrength()

 Gets the current blur strength, if applicable. GeometryMaskCanvas.h  

const FGeometryMaskCanvasId & GetCanvasId()

 Get the unique canvas id based on the world and canvas name. GeometryMaskCanvas.h  

EGeometryMaskColorChannel GetColorChannel()

 Get the color channel to write to in the texture. GeometryMaskCanvas.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Rendering"

int32 GetInnerFeatherRadius()

 Gets the current inner feather radius, in pixels. GeometryMaskCanvas.h  

ULevel * GetLevel()

   GeometryMaskCanvas.h  

int32 GetNumWriters()

 Gets the number of writers for the canvas. GeometryMaskCanvas.h  

int32 GetOuterFeatherRadius()

 Gets the current outer feather radius, in pixels. GeometryMaskCanvas.h  

const UGeometryMaskCanvasResource * GetResource()

   GeometryMaskCanvas.h  

UGeometryMaskCanvasResource * GetResourceMutable()

   GeometryMaskCanvas.h  

UCanvasRenderTarget2D * GetTexture()

 Get the underlying render target. GeometryMaskCanvas.h
  • BlueprintCallable
  • BlueprintPure
  • Category="Rendering"
Returns all writers. GeometryMaskCanvas.h  

void Initialize ( const ULevel* InLevel,
FName InCanvasName
)

 Setup with identifying info. GeometryMaskCanvas.h  

bool IsBlurApplied()

 Whether blur is applied or not. GeometryMaskCanvas.h  

bool IsDefaultCanvas()

 Returns true if this is the default/blank canvas. GeometryMaskCanvas.h  

bool IsFeatherApplied()

 Whether feathering is applied or not. GeometryMaskCanvas.h  

FOnGeometryMaskCanvasActivated & OnActivated()

 Called when Writers becomes non-empty. GeometryMaskCanvas.h  

FOnGeometryMaskCanvasDeactivated & OnDeactivated()

 Called when Writers becomes empty. GeometryMaskCanvas.h  

void RemoveWriter ( const TScriptInterface< IGeometryMaskWriteInterface >& InWriter
)

 Remove a writer from this canvas. GeometryMaskCanvas.h  

void SetApplyBlur ( const bool bInValue
)

 Sets whether blur is applied or not. GeometryMaskCanvas.h  

void SetApplyFeather ( const bool bInValue
)

 Sets whether feathering is applied or not. GeometryMaskCanvas.h  

void SetBlurStrength ( const double InValue
)

 Sets the blur strength. 0.0 will disable blur. GeometryMaskCanvas.h  

void SetInnerFeatherRadius ( const int32 InValue
)

 Sets the inner feather radius, in pixels. GeometryMaskCanvas.h  

void SetOuterFeatherRadius ( const int32 InValue
)

 Sets the outer feather radius, in pixels. GeometryMaskCanvas.h  

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

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   GeometryMaskCanvas.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

   GeometryMaskCanvas.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName GetApplyBlurPropertyName()

   GeometryMaskCanvas.h  

static FName GetApplyFeatherPropertyName()

   GeometryMaskCanvas.h  

static FName GetBlurStrengthPropertyName()

   GeometryMaskCanvas.h  

static FName GetInnerFeatherRadiusPropertyName()

   GeometryMaskCanvas.h  

static FName GetOuterFeatherRadiusPropertyName()

   GeometryMaskCanvas.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page