UCompositePassColorKeyer

Extracts alpha from a colored background (red, green or blue) using chroma keying.

API > API/Plugins > API/Plugins/Composite

Extracts alpha from a colored background (red, green or blue) using chroma keying. Supports clean-plate differencing, despill and denoising.

   
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"))  
class UCompositePassColorKeyer : public UCompositePassBase

Inheritance Hierarchy

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
  • Interp
  • Category="Composite"
  • Meta=(UIMin=0.0f, UIMax=1.0f)
bDespillOnly bool Only apply the despill algorithm controlled by DespillStrength, alpha is unmodified. Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • AdvancedDisplay
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
  • Interp
  • Category="Composite"
  • AdvancedDisplay
BlueWeight float Weight of the foreground blue channel contributing to the key matte hardness. Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • 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
  • Interp
  • Category="Composite"
  • AdvancedDisplay
ChromaShift float Provided so users can compensate for upstream media whose chroma may be offset relative to luma with chroma-subsampled sources (such as 4:2:2 YUV captures). Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • AdvancedDisplay
  • Meta=(UIMin=1.0f, UIMax=1.0f, ClampMin=1.0f, ClampMax=1.0f)
CleanPlate TObjectPtr< UTexture > Clean plate background for calculating color differences per pixel, instead of the static key color. Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
  • Meta=(PropertyGroup="Keyer Settings", OnlyUpdateOnInteractionEnd, AllowedClasses="/Script/Engine.Texture2D, /Script/Engine.Texture2DDynamic, /Script/Engine.TextureRenderTarget2D, /Script/MediaAssets.MediaTexture", EditCondition="KeyerSource == ECompositeKeyerSource::CleanPlate", EditConditionHides)
CleanPlateCountdown float Setting that controls how long to delay before capturing a clean plate Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • Category="Composite"
  • Meta=(PropertyGroup="Keyer Settings", EditCondition="KeyerSource == ECompositeKeyerSource::CleanPlate", EditConditionHides, ClampMin=0.0, UIMin=0.0, ClampMax=60.0, UIMax=60.0)
DenoiseMethod ECompositeDenoiseMethod Denoising method applied before the keyer. Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
  • AdvancedDisplay
DespillStrength float Strength of the spill reduction, 0.0: none, 1.0: full. Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • 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
  • Interp
  • Category="Composite"
  • 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
  • Interp
  • Category="Composite"
  • Meta=(UIMin=0.0f, UIMax=1.0f, EditCondition="ScreenType != ECompositeColorKeyerScreenType::Green")
KeyColor FLinearColor Static background key color. Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(PropertyGroup="Keyer Settings", OnlyUpdateOnInteractionEnd, EditCondition="KeyerSource == ECompositeKeyerSource::Color", EditConditionHides)
KeyerSource ECompositeKeyerSource Source used by the keyer to derive the screen color: either a static key color or a clean plate texture. Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
  • Meta=(PropertyGroup="Keyer Settings")
PlateTexturePreviewSize float Setting that determines how large to display the plate texture 'picture-in-picture' preview in the level editor when using the eye dropper color picker Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • Category="Composite"
  • Meta=(PropertyGroup="Keyer Settings", EditCondition="KeyerSource == ECompositeKeyerSource::Color", EditConditionHides, ClampMin=1.0, UIMin=1.0, ClampMax=10.0, UIMax=10.0)
RedWeight float Weight of the foreground red channel contributing to the key matte hardness. Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • 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="Composite"
Visualization ECompositeColorKeyerVisualization Vizualize the alpha key or fill. Passes/CompositePassColorKeyer.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"

Functions

Public

Public Virtual

Overridden from UCompositePassBase

Name Remarks Include Path Unreal Specifiers

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

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Passes/CompositePassColorKeyer.h  

virtual void PostLoad()

   Passes/CompositePassColorKeyer.h  

virtual void PreEditChange ( FProperty* PropertyThatWillChange
)

   Passes/CompositePassColorKeyer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page