Navigation
API > API/Plugins > API/Plugins/Composite
Morphologically dilates or erodes selected channels of the layer input by a configurable pixel radius. Used to grow or shrink mattes before downstream compositing operations.
| Name | UCompositePassDilation |
| Type | class |
| Header File | /Engine/Plugins/Compositing/Composite/Source/Composite/Public/Passes/CompositePassDilation.h |
| Include Path | #include "Passes/CompositePassDilation.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Blueprintable, EditInlineNew, CollapseCategories,
Meta=(DisplayName="Dilation"))
class UCompositePassDilation : public UCompositePassBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCompositePassBase → UCompositePassDilation
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCompositePassDilation
(
const FObjectInitializer& ObjectInitializer |
Constructor | Passes/CompositePassDilation.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~UCompositePassDilation() |
Destructor | Passes/CompositePassDilation.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCarryRGBWithAlpha | bool | When Alpha is selected, the alpha-winning neighbor's RGB is copied into any color channels that aren't explicitly in the Channels mask, so mattes grow/shrink visibly. | Passes/CompositePassDilation.h |
|
| bUseThreshold | bool | When true, the operation only fires on pixels that are essentially off (at or below a small epsilon), thus only affecting matte edges. | Passes/CompositePassDilation.h |
|
| meta | Channels the operation reads and writes. | Passes/CompositePassDilation.h |
|
|
| Size | int32 | Signed size: negative = erode (shrink), positive = dilate (expand), 0 = identity (pass disabled). | Passes/CompositePassDilation.h |
|
| Threshold | float | In standard opacity space (0 = transparent, 1 = opaque): a channel's value is treated as "off" at or below this threshold and "on" above it. | Passes/CompositePassDilation.h |
|
Functions
Public
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/CompositePassDilation.h | |
virtual FCompositeCorePassProxy * GetProxy
(
const UE::CompositeCore::FPassInputDecl& InputDecl, |
Override to return a render-thread proxy for this pass. | Passes/CompositePassDilation.h |