UCompositePassColorKeyer | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/Composite

Color keyer with clean plate & spill removal support.


Name	UCompositePassColorKeyer
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="Color Keyer Pass"))  
class UCompositePassColorKeyer : public UCompositePassBase

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UCompositePassBase → UCompositePassColorKeyer

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UCompositePassColorKeyer ( const FObjectInitializer& ObjectInitializer )	Constructor	Passes/CompositePassColorKeyer.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
~UCompositePassColorKeyer()	Destructor	Passes/CompositePassColorKeyer.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
AlphaThreshold	FVector2f	Thresholds any alpha value outside the specified range to zero or one respectively, with linear interpolation in-between.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category="" Meta=(UIMin=0.0f, UIMax=1.0f)
bEditorThrottleDisabled	bool	Flag tracking whether we disabled throttling to later restore it.	Passes/CompositePassColorKeyer.h
bInvertAlpha	bool	Invert the alpha key.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category=""
BlueWeight	float	Weight of the foreground blue channel contributing to the key matte hardness.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category="" Meta=(UIMin=0.0f, UIMax=1.0f, EditCondition="ScreenType != ECompositeColorKeyerScreenType::Blue")
bPreserveVignetteAfterKey	bool	When enabled, we undo devignetting before outputting the keyed plate.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category=""
CleanPlate	TObjectPtr< UTexture >	Clean plate background for calculating color differences per pixel, instead of the static key color.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category=""
DenoiseMethod	ECompositeDenoiseMethod	Denoising method applied before the keyer.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category=""
DespillStrength	float	Strength of the spill reduction, 0.0: none, 1.0: full.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category="" Meta=(UIMin=0.0f, UIMax=1.0f)
DevignetteStrength	float	Strength of the vignette removal. Used to improve plate uniformity & remove darker corners.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category="" Meta=(UIMin=0.0f, UIMax=1.0f)
GreenWeight	float	Weight of the foreground green channel contributing to the key matte hardness.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category="" Meta=(UIMin=0.0f, UIMax=1.0f, EditCondition="ScreenType != ECompositeColorKeyerScreenType::Green")
KeyColor	FLinearColor	Static background key color.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category="" Meta=(OnlyUpdateOnInteractionEnd, EditCondition="CleanPlate == nullptr")
RedWeight	float	Weight of the foreground red channel contributing to the key matte hardness.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category="" Meta=(UIMin=0.0f, UIMax=1.0f, EditCondition="ScreenType != ECompositeColorKeyerScreenType::Red")
ScreenType	ECompositeColorKeyerScreenType	Type of screen color (required). The keyer works best against red, green or blue backgrounds.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category=""
Visualization	ECompositeColorKeyerVisualization	Vizualize the alpha key or fill.	Passes/CompositePassColorKeyer.h	EditAnywhere BlueprintReadWrite Category=""

Functions

Public

Overridden from UCompositePassBase

Name	Remarks	Include Path	Unreal Specifiers
virtual bool GetProxy ( const UE::CompositeCore::FPassInputDecl& InputDecl, FSceneRenderingBulkObjectAllocator& InFrameAllocator, FCompositeCorePassProxy*& OutProxy ) const	Getter function to override, returning pass proxies to be passed to the render thread.	Passes/CompositePassColorKeyer.h

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )		Passes/CompositePassColorKeyer.h
virtual void PreEditChange ( FProperty* PropertyThatWillChange )		Passes/CompositePassColorKeyer.h

Navigation

Syntax

Inheritance Hierarchy

Constructors

Destructors

Variables

Public

Functions

Public

Overridden from UCompositePassBase

Overridden from UObject