Navigation
API > API/Plugins > API/Plugins/Composite
Extracts alpha from pixel luminance (luma key). Useful for isolating bright or dark regions without a colored backdrop.
| Name | UCompositePassLumaKeyer |
| Type | class |
| Header File | /Engine/Plugins/Compositing/Composite/Source/Composite/Public/Passes/CompositePassColorKeyer.h |
| Include Path | #include "Passes/CompositePassColorKeyer.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Blueprintable, EditInlineNew, CollapseCategories,
Meta=(DisplayName="Luma Keyer"))
class UCompositePassLumaKeyer : public UCompositePassBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UCompositePassBase → UCompositePassLumaKeyer
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCompositePassLumaKeyer
(
const FObjectInitializer& ObjectInitializer |
Passes/CompositePassColorKeyer.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~UCompositePassLumaKeyer() |
Passes/CompositePassColorKeyer.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDisplaySpaceLuminance | bool | When enabled, luminance is computed after converting the pixel to display space (sRGB encoding) rather than in linear light. | Passes/CompositePassColorKeyer.h |
|
| bInvertAlpha | bool | Invert the alpha key. | Passes/CompositePassColorKeyer.h |
|
| DenoiseMethod | ECompositeDenoiseMethod | Denoising method applied before the keyer. | Passes/CompositePassColorKeyer.h |
|
| LumaRange | FVector2f | Luminance range [min, max] that maps to alpha [0, 1]. | Passes/CompositePassColorKeyer.h |
|
| Visualization | ECompositeColorKeyerVisualization | Vizualize the alpha key or fill. | Passes/CompositePassColorKeyer.h |
|
Functions
Public
Public Virtual
Overridden from UCompositePassBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FCompositeCorePassProxy * GetProxy
(
const UE::CompositeCore::FPassInputDecl& InputDecl, |
Override to return a render-thread proxy for this pass. | Passes/CompositePassColorKeyer.h |