UCompositePassMasking

Masks the layer alpha using a texture, a geometry render of selected actors, or a combination of both.

API > API/Plugins > API/Plugins/Composite

Masks the layer alpha using a texture, a geometry render of selected actors, or a combination of both. The resulting mask is multiplied into the input alpha.

   
Name UCompositePassMasking
Type class
Header File /Engine/Plugins/Compositing/Composite/Source/Composite/Public/Passes/CompositePassMasking.h
Include Path #include "Passes/CompositePassMasking.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Blueprintable, EditInlineNew, CollapseCategories,  
       Meta=(DisplayName="Masking"))  
class UCompositePassMasking :  
    public UCompositePassBase ,  
    public FTickableGameObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCompositePassMasking ( const FObjectInitializer& ObjectInitializer
)

 Constructor Passes/CompositePassMasking.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~UCompositePassMasking()

 Destructor Passes/CompositePassMasking.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bInputIsPremultiplied bool Set true when the input texture stores premultiplied alpha (RGB already scaled by A). Passes/CompositePassMasking.h
  • BlueprintReadWrite
  • EditAnywhere
  • Interp
  • Category="Composite"
bInvert bool Invert mask alpha. Passes/CompositePassMasking.h
  • BlueprintReadWrite
  • EditAnywhere
  • Interp
  • Category="Composite"
bPremultipliedInDisplaySpace bool Set true when the input's premultiplication was applied in sRGB display space rather than linear (e.g. an Ultimatte fill, where the upstream processor multiplies the camera fill by the matte in display before delivering it). Passes/CompositePassMasking.h
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
MaskSource ECompositeColorChannel Color channel used as the mask source. Passes/CompositePassMasking.h
  • BlueprintReadWrite
  • EditAnywhere
  • Interp
  • Category="Composite"
  • Meta=(EditCondition="MaskingMode == ECompositeMaskingMode::Texture", EditConditionHides)
MaskTexture TObjectPtr< UTexture > Masking texture. Passes/CompositePassMasking.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
  • Meta=(AllowedClasses="/Script/Engine.Texture2D, /Script/Engine.Texture2DDynamic, /Script/Engine.TextureRenderTarget2D, /Script/MediaAssets.MediaTexture", EditCondition="MaskingMode == ECompositeMaskingMode::Texture", EditConditionHides)

Protected

Name Type Remarks Include Path Unreal Specifiers
bVisibleInSceneCaptureOnly bool Visibility setting applied to mask actors. Passes/CompositePassMasking.h
  • EditAnywhere
  • BlueprintGetter=IsVisibleInSceneCaptureOnly
  • BlueprintSetter=SetVisibleInSceneCaptureOnly
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true, EditCondition="MaskingMode == ECompositeMaskingMode::Geometry", EditConditionHides)
MaskActors TArray< TSoftObjectPtr< AActor > > Actors whose mesh primitives are rendered as a geometry mask. Passes/CompositePassMasking.h
  • EditAnywhere
  • BlueprintGetter=GetMaskActors
  • BlueprintSetter=SetMaskActors
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true, EditCondition="MaskingMode == ECompositeMaskingMode::Geometry", EditConditionHides)
MaskingMode ECompositeMaskingMode Masking source mode. Passes/CompositePassMasking.h
  • EditAnywhere
  • BlueprintGetter=GetMaskingMode
  • BlueprintSetter=SetMaskingMode
  • Interp
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
PreEditMaskingMode ECompositeMaskingMode Cached masking mode from PreEditChange, used to detect transitions in PostEditChangeProperty. Passes/CompositePassMasking.h  
RenderTargetResolution FIntPoint Render target resolution for the geometry mask scene capture. Passes/CompositePassMasking.h
  • EditAnywhere
  • BlueprintGetter=GetRenderTargetResolution
  • BlueprintSetter=SetRenderTargetResolution
  • Interp
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true, EditCondition="MaskingMode == ECompositeMaskingMode::Geometry", EditConditionHides)
SpawnableBindings FCompositeSpawnableBindings Parallel spawnable binding data for the MaskActors array. Passes/CompositePassMasking.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TArray< TSoftObjectPtr< AActor > > GetMaskActors()

 Get mask actors. Passes/CompositePassMasking.h
  • BlueprintGetter

ECompositeMaskingMode GetMaskingMode()

 Get the masking mode. Passes/CompositePassMasking.h
  • BlueprintGetter

FIntPoint GetRenderTargetResolution()

 Get the render target resolution for the geometry mask. Passes/CompositePassMasking.h
  • BlueprintGetter

bool IsVisibleInSceneCaptureOnly()

 Get whether mask meshes are visible in scene capture only. Passes/CompositePassMasking.h
  • BlueprintGetter

void SetMaskActors ( TArray< TSoftObjectPtr< AActor > > InMaskActors
)

 Set mask actors. Passes/CompositePassMasking.h
  • BlueprintSetter

void SetMaskingMode ( ECompositeMaskingMode InMaskingMode
)

 Set the masking mode. Passes/CompositePassMasking.h
  • BlueprintSetter

void SetRenderTargetResolution ( FIntPoint InRenderTargetResolution
)

 Set the render target resolution for the geometry mask. Passes/CompositePassMasking.h
  • BlueprintSetter

void SetVisibleInSceneCaptureOnly ( bool bInVisible
)

 Set whether mask meshes are visible in scene capture only. Passes/CompositePassMasking.h
  • BlueprintSetter

Public Virtual

Overridden from UCompositePassBase

Name Remarks Include Path Unreal Specifiers

virtual bool GetIsActive ()

 Returns true if the pass should participate in rendering this frame. Passes/CompositePassMasking.h  

virtual FCompositeCorePassProxy * GetProxy ( const UE::CompositeCore::FPassInputDecl& InputDecl,
FCompositeTraversalContext& InContext,
FSceneRenderingBulkObjectAllocator& InFrameAllocator
) const

 Override to return a render-thread proxy for this pass. Passes/CompositePassMasking.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Passes/CompositePassMasking.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Passes/CompositePassMasking.h  

virtual void PostEditUndo()

   Passes/CompositePassMasking.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Passes/CompositePassMasking.h  

Overridden from FTickableGameObject

Name Remarks Include Path Unreal Specifiers

virtual UWorld * GetTickableGameObjectWorld()

   Passes/CompositePassMasking.h  

virtual bool IsTickableInEditor()

   Passes/CompositePassMasking.h  

virtual bool IsTickableWhenPaused()

   Passes/CompositePassMasking.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   Passes/CompositePassMasking.h  

virtual ETickableTickType GetTickableTickType()

   Passes/CompositePassMasking.h  

virtual bool IsTickable()

   Passes/CompositePassMasking.h  

virtual void Tick ( float DeltaTime
)

   Passes/CompositePassMasking.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page