1. Epic GamesDeveloper
  3. UGeometryMaskCanvas

UGeometryMaskCanvas

A uniquely identified Canvas.

API > API/Plugins > API/Plugins/GeometryMask

Inheritance Hierarchy

  • UObject
  • UGeometryMaskCanvas

References

   
Module GeometryMask
Header /Engine/Plugins/Experimental/GeometryMask/Source/GeometryMask/Public/GeometryMaskCanvas.h
Include #include "GeometryMaskCanvas.h"

Syntax

UCLASS (BlueprintType, Transient)  
class UGeometryMaskCanvas : public UObject

Remarks

A uniquely identified Canvas.

Functions

  Type Name Description
Public function void

AddWriter ( const TScriptInterface< IGeometryMaskWriteInterface >& InWriter
)

 Adds a Mask Writer to the canvas.
Public function void

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

 Appends multiple writers to the canvas.
Public function void  
Public function Virtual void  
Public function void

Free ()

 Forcibly free the canvas - removed all writers and frees the resource.
Public function void  
Public function Static FName  
Public function Static FName  
Public function Const double Gets the current blur strength, if applicable.
Public function Static FName  
Public function Const const FGeometryMaskCanvasId & Get the unique canvas id based on the world and canvas name.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category EGeometryMaskColorChannel Get the color channel to write to in the texture.
Public function Const int32 Gets the current inner feather radius, in pixels.
Public function Static FName  
Public function Const ULevel *  
Public function Const int32 Gets the number of writers for the canvas.
Public function Const int32 Gets the current outer feather radius, in pixels.
Public function Static FName  
Public function Const const UGeometryMaskCanvasResource *  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category UCanvasRenderTarget2D * Get the underlying render target.
Public function Const const TArray< TWeakInterfacePtr< IGeometryMaskWriteInterface > > & Returns all writers.
Public function void

Initialize ( const ULevel* InLevel,
FName InCanvasName
)

 Setup with identifying info.
Public function Const bool Whether blur is applied or not.
Public function Const bool Returns true if this is the default/blank canvas.
Public function Const bool Whether feathering is applied or not.
Public function FOnGeometryMaskCanvasActivated & Called when Writers becomes non-empty.
Public function FOnGeometryMaskCanvasDeactivated & Called when Writers becomes empty.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& InPropertyChangedEvent
)

  
Public function void

RemoveWriter ( const TScriptInterface< IGeometryMaskWriteInterface >& InWriter
)

 Remove a writer from this canvas.
Public function void

SetApplyBlur ( const bool bInValue
)

 Sets whether blur is applied or not.
Public function void

SetApplyFeather ( const bool bInValue
)

 Sets whether feathering is applied or not.
Public function void

SetBlurStrength ( const double InValue
)

 Sets the blur strength. 0.0 will disable blur.
Public function void

SetInnerFeatherRadius ( const int32 InValue
)

 Sets the inner feather radius, in pixels.
Public function void

SetOuterFeatherRadius ( const int32 InValue
)

 Sets the outer feather radius, in pixels.
Public function void

Update ( const ULevel* InLevel,
FSceneView& InView
)

 Updates the canvas, intended to be called every frame.

Constants

Name Description
ApplyBlurPropertyName  
ApplyFeatherPropertyName  
BlurStrengthPropertyName  
InnerFeatherRadiusPropertyName  
OuterFeatherRadiusPropertyName  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page