1. Epic GamesDeveloper
  3. ACompositingElement

ACompositingElement

API > API/Plugins > API/Plugins/Composure

   
Name ACompositingElement
Type class
Header File /Engine/Plugins/Compositing/Composure/Source/Composure/Classes/CompositingElement.h
Include Path #include "CompositingElement.h"

Syntax

UCLASS (BlueprintType,  
       Meta=(DisplayName="Empty Comp Shot", ShortTooltip="A simple base actor used to composite multiple render layers together."))  
class ACompositingElement :  
    public AComposurePipelineBaseActor ,  
    public ICompImageColorPickerInterface

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

ACompositingElement ( const FObjectInitializer& ObjectInitializer
)

   CompositingElement.h  

Typedefs

Name Type Remarks Include Path
FOnCompElementConstructed TMulticastDelegate_OneParam< void, ACompositingElement * >   CompositingElement.h
FOnFinalPassRendered TMulticastDelegate_TwoParams< void, ACompositingElement *, UTexture * > Called when this comp shot element has rendered its final output CompositingElement.h
FOnTransformPassRendered TMulticastDelegate_ThreeParams< void, ACompositingElement *, UTexture *, FName > Called when this comp shot element has rendered one of its internal transform passes CompositingElement.h
FSharedTargetPoolPtr TSharedPtr< FCompElementRenderTargetPool >   CompositingElement.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bUseSharedTargetPool bool   CompositingElement.h
  • EditDefaultsOnly
  • Category="Composure|Output"
  • AdvancedDisplay
CameraSource ESceneCameraLinkType   CompositingElement.h
  • EditAnywhere
  • Category="Composure|Input"
CompositingTarget TObjectPtr< UComposureCompositingTargetComponent >   CompositingElement.h
  • BlueprintReadOnly
  • Category="Composure"
DefaultInputType TSubclassOf< UCompositingElementInput >   CompositingElement.h
  • EditDefaultsOnly
  • Category="Composure|Editor"
DefaultOutputType TSubclassOf< UCompositingElementOutput >   CompositingElement.h
  • EditDefaultsOnly
  • Category="Composure|Editor"
DefaultTransformType TSubclassOf< UCompositingElementTransform >   CompositingElement.h
  • EditDefaultsOnly
  • Category="Composure|Editor"
FreezeFrameController FCompFreezeFrameController   CompositingElement.h  
OnConstructed FOnCompElementConstructed   CompositingElement.h  
OnFinalPassRendered FOnFinalPassRendered   CompositingElement.h  
OnFinalPassRendered_BP FDynamicOnFinalPassRendered Called when the final output of this element is rendered CompositingElement.h
  • BlueprintAssignable
  • BlueprintCallable
  • DisplayName=OnFinalPassRendered
  • Category="Composure"
OnTransformPassRendered FOnTransformPassRendered   CompositingElement.h  
OnTransformPassRendered_BP FDynamicOnTransformPassRendered Called when a transform pass on this element is rendered CompositingElement.h
  • BlueprintAssignable
  • BlueprintCallable
  • DisplayName=OnTransformPassRendered
  • Category="Composure"
PostProcessProxy TObjectPtr< UComposurePostProcessingPassProxy >   CompositingElement.h
  • BlueprintReadOnly
  • Category="Composure"
PreviewTransform TObjectPtr< UCompositingElementTransform >   CompositingElement.h
  • EditAnywhere
  • Instanced
  • Category="Composure|Preview"
PreviewTransformSource EInheritedSourceType   CompositingElement.h
  • EditAnywhere
  • Category="Composure|Preview"
RenderFormat TEnumAsByte< ETextureRenderTargetFormat >   CompositingElement.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composure|Output"
  • AdvancedDisplay
ResolutionSource EInheritedSourceType   CompositingElement.h
  • EditAnywhere
  • Category="Composure|Output"
TargetCameraActorPtr TWeakObjectPtr< ACameraActor >   CompositingElement.h
  • EditInstanceOnly
  • Category="Composure|Input"
  • DisplayName="Target Camera Actor"

Protected

Name Type Remarks Include Path Unreal Specifiers
bUsingDebugDisplayImage bool   CompositingElement.h
  • Transient
  • DuplicateTransient
ChildLayers TArray< TObjectPtr< ACompositingElement > >   CompositingElement.h  
ColorPickerDisplayImage TObjectPtr< UTexture >   CompositingElement.h
  • Transient
  • DuplicateTransient
ColorPickerTarget TObjectPtr< UTextureRenderTarget2D >   CompositingElement.h
  • Transient
  • DuplicateTransient
CompilerErrImage TObjectPtr< UTexture >   CompositingElement.h
  • Transient
CompShotIdName FName   CompositingElement.h  
DisabledMsgImage TObjectPtr< UTexture > EDITOR ONLY - Properties associated with CompositingElement.h
  • Transient
EditorPreviewImage TObjectPtr< UTexture >   CompositingElement.h
  • Transient
  • DuplicateTransient
EmptyWarnImage TObjectPtr< UTexture >   CompositingElement.h
  • Transient
FreezeFrameMask int32   CompositingElement.h
  • Meta=(Bitmask, BitmaskEnum="/Script/Composure.ETargetUsageFlags")
InternalAlphaPass TObjectPtr< UAlphaTransformPass >   CompositingElement.h
  • Transient
InternalInputs TArray< TObjectPtr< UCompositingElementInput > > Authoritative lists that we use to iterate on the passes - conjoined from the public lists and the CompositingElement.h
  • Instanced
  • Transient
  • DuplicateTransient
  • SkipSerialization
InternalOutputs TArray< TObjectPtr< UCompositingElementOutput > >   CompositingElement.h
  • Instanced
  • Transient
  • DuplicateTransient
  • SkipSerialization
InternalTransformPasses TArray< TObjectPtr< UCompositingElementTransform > >   CompositingElement.h
  • Instanced
  • Transient
  • DuplicateTransient
  • SkipSerialization
LastEnqueuedFrameId uint32   CompositingElement.h  
NextIntermediateTrackingTag ETargetUsageFlags   CompositingElement.h  
OutputOpacity float   CompositingElement.h  
Parent TObjectPtr< ACompositingElement >   CompositingElement.h  
PassResultsTable FCompositingTextureLookupTable   CompositingElement.h  
PreviewCount int32   CompositingElement.h  
RenderTargetPool FSharedTargetPoolPtr   CompositingElement.h  
SuspendedDbgImage TObjectPtr< UTexture >   CompositingElement.h
  • Transient
UserConstructedInputs TMap< TObjectPtr< UCompositingElementInput >, ECompPassConstructionType > Lists containing passes added programatically (or through Blueprints) via the AddNewPass() functions. CompositingElement.h  
UserConstructedOutputs TMap< TObjectPtr< UCompositingElementOutput >, ECompPassConstructionType >   CompositingElement.h  
UserConstructedTransforms TMap< TObjectPtr< UCompositingElementTransform >, ECompPassConstructionType >   CompositingElement.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

T * AddNewPass ( FName PassName,
ECompPassConstructionType ConstructedBy
)

   CompositingElement.h  
  CompositingElement.h  

bool AttachAsChildLayer ( ACompositingElement* Child
)

   CompositingElement.h  

UCompositingElementInput * CreateNewInputPass ( FName PassName,
TSubclassOf< UCompositingElementInput > InputType
)

 Create a new input pass into the public list which directly shows in the editor. CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Pass"
  • Meta=(DeterminesOutputType="InputType")

UCompositingElementOutput * CreateNewOutputPass ( FName PassName,
TSubclassOf< UCompositingElementOutput > OutputType
)

 Create a new Output pass into the public list which directly shows in the editor. CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Pass"
  • Meta=(DeterminesOutputType="OutputType")

UCompositingElementTransform * CreateNewTransformPass ( FName PassName,
TSubclassOf< UCompositingElementTransform > TransformType
)

 Create a new Transform pass into the public list which directly shows in the editor. CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Pass"
  • Meta=(DeterminesOutputType="TransformType")

bool DeletePass ( UCompositingElementPass* PassToDelete
)

 Delete a specific pass. CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Pass"

bool DetatchAsChildLayer ( ACompositingElement* Child
)

   CompositingElement.h  

virtual void EnqueueRendering_Implementation ( bool bCameraCutThisFrame
)

   CompositingElement.h  

UCompositingElementInput * FindInputPass ( TSubclassOf< UCompositingElementInput > InputType,
UTexture*& PassResult,
FName OptionalPassName
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure"
  • Meta=(DeterminesOutputType="InputType")

UTexture * FindNamedRenderResult ( FName PassName,
bool bSearchSubElements
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure"

UCompositingElementOutput * FindOutputPass ( TSubclassOf< UCompositingElementOutput > OutputType,
FName OptionalPassName
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure"
  • Meta=(DeterminesOutputType="OutputType")

ACameraActor * FindTargetCamera()

   CompositingElement.h
  • BlueprintPure
  • Category="Composure|Input"

UCompositingElementTransform * FindTransformPass ( TSubclassOf< UCompositingElementTransform > TransformType,
UTexture*& PassResult,
FName OptionalPassName
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure"
  • Meta=(DeterminesOutputType="TransformType")

const TArray< ACompositingElement * > GetChildElements()

 Get the first level of current element's child composure elements. CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Element"

FName GetCompElementName()

 Return the FName of the composure element object CompositingElement.h
  • BlueprintPure
  • Category="Composure|Element"

ACompositingElement * GetElementParent()

 Get the parent composure element of current element. CompositingElement.h
  • BlueprintPure
  • Category="Composure|Element"

TArray< UCompositingElementInput * > GetInputsList()

   CompositingElement.h
  • BlueprintGetter

UTexture * GetLatestRenderResult()

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure"

float GetOpacity()

 Return the rendering opacity of current composure actor. CompositingElement.h
  • BlueprintPure
  • Category="Composure|Element"

TArray< UCompositingElementOutput * > GetOutputsList()

   CompositingElement.h
  • BlueprintGetter

FIntPoint GetRenderResolution()

   CompositingElement.h
  • BlueprintGetter

TArray< UCompositingElementTransform * > GetTransformsList()

   CompositingElement.h
  • BlueprintGetter

virtual bool IsActivelyRunning_Implementation()

   CompositingElement.h  

bool IsSubElement()

 Determines whether current composure element is a child of another composure element or not. CompositingElement.h
  • BlueprintPure
  • Category="Composure|Element"

void RegisterPassResult ( FName ReferenceName,
UTexture* PassResult,
bool bSetAsLatestRenderResult
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure"

bool ReleaseOwnedTarget ( UTextureRenderTarget2D* OwnedTarget
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure"

bool RemovePass ( UCompositingElementPass* ElementPass
)

 Remove a pass from inner pass. CompositingElement.h  

int32 RemovePassesOfType ( TSubclassOf< UCompositingElementPass > PassType
)

   CompositingElement.h  

UTexture * RenderCompElement ( bool bCameraCutThisFrame
)

   CompositingElement.h
  • BlueprintNativeEvent
  • Category="Composure"
  • Meta=(CallInEditor="true")

UTexture * RenderCompositingMaterial ( FCompositingMaterial& CompMaterial,
float RenderScale,
FName ResultLookupName,
ETargetUsageFlags UsageTag
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure"

UTextureRenderTarget2D * RenderCompositingMaterialToTarget ( FCompositingMaterial& CompMaterial,
UTextureRenderTarget2D* RenderTarget,
FName ResultLookupName
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure"

UTextureRenderTarget2D * RequestNamedRenderTarget ( const FName ReferenceName,
const float RenderPercentage,
ETargetUsageFlags UsageTag
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure"

void SetEditorColorPickerDisplayImage ( UTexture* PickerDisplayImage
)

 EDITOR ONLY - Specifies an intermediate image to display when picking (if left unset, we default to the final output image) CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Editor"
NOTE: as we cannot make BlueprintCallable functions EditorOnly, we've previously flagged these as "DevelopmentOnly", and made them non-functional outside of the editor However, that restriction has now been removed, since the functions do nothing outside the Editor, so it is ok for them to be included in packaged games. CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Editor"

void SetElementName ( const FName NewName
)

 Rename composure actor's name CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Element"

void SetOpacity ( const float NewOpacity
)

 Set the rendering opacity of current composure actor. CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Element"

void SetRenderResolution ( FIntPoint NewResolution
)

   CompositingElement.h
  • BlueprintSetter

void SetTargetCamera ( ACameraActor* NewCameraActor
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Input"

Overridden from AComposurePipelineBaseActor

Name Remarks Include Path Unreal Specifiers

virtual int32 GetRenderPriority()

   CompositingElement.h
  • BlueprintPure
  • Category="Composure"

virtual void SetAutoRun ( bool bNewAutoRunVal
)

   CompositingElement.h  

virtual void SetAutoRunChildrenAndSelf ( bool bAutoRunChildAndSelf
)

 When set to false, all children composure actor and current actor's auto-rendering behavior will be disabled. CompositingElement.h  

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   CompositingElement.h  

virtual void OnConstruction ( const FTransform& Transform
)

   CompositingElement.h  

virtual void RerunConstructionScripts()

   CompositingElement.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   CompositingElement.h  

virtual void PostDuplicate ( bool bDuplicateForPIE
)

   CompositingElement.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedChainEvent
)

   CompositingElement.h  

virtual void PostEditUndo()

   CompositingElement.h  

virtual void PostInitProperties()

   CompositingElement.h  

virtual void PostLoad()

   CompositingElement.h  

virtual void Serialize ( FArchive& Ar
)

   CompositingElement.h  

Overridden from ICompImageColorPickerInterface

Name Remarks Include Path Unreal Specifiers

virtual UTexture * GetColorPickerDisplayImage()

   CompositingElement.h  

virtual UTextureRenderTarget2D * GetColorPickerTarget()

   CompositingElement.h  

virtual FCompFreezeFrameController * GetFreezeFrameController()

   CompositingElement.h  

Overridden from ICompEditorImagePreviewInterface

Name Remarks Include Path Unreal Specifiers

virtual UTexture * GetEditorPreviewImage()

   CompositingElement.h  

virtual void OnBeginPreview()

   CompositingElement.h  

virtual void OnEndPreview()

   CompositingElement.h  

virtual bool UseImplicitGammaForPreview()

   CompositingElement.h  

Protected

Name Remarks Include Path Unreal Specifiers

UCompositingElementInput * AddNewInputPass ( FName PassName,
TSubclassOf< UCompositingElementInput > InputType
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Input"
  • Meta=(DeterminesOutputType="InputType", BlueprintProtected)

UCompositingElementOutput * AddNewOutputPass ( FName PassName,
TSubclassOf< UCompositingElementOutput > OutputType
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Input"
  • Meta=(DeterminesOutputType="OutputType", BlueprintProtected)

UCompositingElementTransform * AddNewTransformPass ( FName PassName,
TSubclassOf< UCompositingElementTransform > TransformType
)

   CompositingElement.h
  • BlueprintCallable
  • Category="Composure|Input"
  • Meta=(DeterminesOutputType="TransformType", BlueprintProtected)

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
TargetCameraActor_DEPRECATED TLazyObjectPtr< ACameraActor >   CompositingElement.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page