1. Epic GamesDeveloper
  3. UGeometryMaskCanvasResource

UGeometryMaskCanvasResource

API > API/Plugins > API/Plugins/GeometryMask

Inheritance Hierarchy

  • UObject
  • UGeometryMaskCanvasResource

References

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

Syntax

UCLASS ()  
class UGeometryMaskCanvasResource : public UObject

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual void  
Public function bool

Checkin ( const FGeometryMaskCanvasId& InRequestingCanvasId
)

 Returns/frees the color channel associated with the given canvas name.
Public function bool

Checkout ( const EGeometryMaskColorChannel InColorChannel,
const FGeometryMaskCanvasId& InRequestingCanvasId
)

 Requests usage of the given color channel for this resource. Will return true if successful.
Public function int32

Compact ()

 Re-arranges used channels such that they are used sequentially. Returns number of unused channels.
Public function Const TArray< FGeometryMaskCanvasId > Get the list of dependent canvases, for debug purposes.
Public function Const const EGeometryMaskColorChannel Will return the first available color channel without a canvas assigned.
Public function Const int32  
Public function UCanvasRenderTarget2D *  
Public function Const int32

GetViewportPadding ( const FGeometryMaskDrawingContext& InDrawingContext
)

 Returns required viewport padding, in pixels - determined by certain effects.
Public function Const bool  
Public function FOnGeometryMaskCanvasDraw &  
Public function void Resets the render parameters for the given channel.
Public function void

SetViewportSize ( FGeometryMaskDrawingContext& InDrawingContext,
const FIntPoint& InViewportSize
)

  
Public function void

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

 Updates the canvas, intended to be called every frame.
Public function void

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

  
Public function void  

Constants

Name Description
MaxNumAvailableChannels  
MaxNumChannels (R, G, B, A)
MaxTextureSize  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page