Navigation
API > API/Plugins > API/Plugins/Composite
Render-thread proxy for the alpha masking pass. Takes two inputs: [0] main, [1] mask.
| Name | FMaskingPassProxy |
| Type | class |
| Header File | /Engine/Plugins/Compositing/Composite/Source/Composite/Public/Passes/CompositePassMasking.h |
| Include Path | #include "Passes/CompositePassMasking.h" |
Syntax
class FMaskingPassProxy : public FCompositeCorePassProxy
Inheritance Hierarchy
- FCompositeCorePassProxy → FMaskingPassProxy
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bInputIsPremultiplied | bool | When true, RGB is divided by alpha before masking and multiplied back after, preserving straight-alpha color values. | Passes/CompositePassMasking.h | |
| bInvert | bool | When true, the mask value is inverted (1 − mask) before it is applied. | Passes/CompositePassMasking.h | |
| bPremultipliedInDisplaySpace | bool | When true (and bInputIsPremultiplied is true), the unpremultiply step is performed in display space rather than linear so display-premult content (e.g. an Ultimatte fill) round-trips to a clean linear-premult output. | Passes/CompositePassMasking.h | |
| MaskSourceChannel | uint32 | Index of the mask texture channel to read (0=R, 1=G, 2=B, 3=A). | Passes/CompositePassMasking.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Passes/CompositePassMasking.h | |||
FCompositeCorePassProxy
(
UE::CompositeCore::FPassInputDeclArray InPassDeclaredInputs |
Passes/CompositePassMasking.h |
Public Virtual
Overridden from FCompositeCorePassProxy
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FPassTexture Add
(
FRDGBuilder& GraphBuilder, |
Adds the masking RDG pass; multiplies the main input's alpha by the chosen mask channel and returns the masked output. | Passes/CompositePassMasking.h | |
virtual const FName & GetTypeName() |
Passes/CompositePassMasking.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const FName & GetTypeNameStatic() |
Passes/CompositePassMasking.h |