Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > Composure > ACompositingElement

Light Theme

Dark Theme

ACompositingElement

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

AActor

AComposurePipelineBaseActor

ACompositingElement

ACompositingCaptureBase

References

Module	Composure
Header	/Engine/Plugins/Compositing/Composure/Source/Composure/Classes/CompositingElement.h
Include	#include "CompositingElement.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(BlueprintType,
       Meta=(DisplayName="Empty Comp Shot", ShortTooltip="A simple base actor used to composite multiple render layers together."))
class ACompositingElement :
    public AComposurePipelineBaseActor,
    public ICompImageColorPickerInterface

Variables

	Name	Description
bool	bUseSharedTargetPool
ESceneCameraLin...	CameraSource
UComposureCompo...	CompositingTarget
TSubclassOf< UC...	DefaultInputType
TSubclassOf< UC...	DefaultOutputType
TSubclassOf< UC...	DefaultTransformType
FCompFreezeFram...	FreezeFrameController
TArray< UCompos...	Inputs	Pipeline Passes
FOnCompElementC...	OnConstructed
FOnFinalPassRen...	OnFinalPassRendered
FDynamicOnFinal...	OnFinalPassRendered_BP	Called when the final output of this element is rendered
FOnTransformPas...	OnTransformPassRendered
FDynamicOnTrans...	OnTransformPassRendered_BP	Called when a transform pass on this element is rendered
TArray< UCompos...	Outputs
UComposurePostP...	PostProcessProxy
UCompositingEle...	PreviewTransform
EInheritedSourc...	PreviewTransformSource
TEnumAsByte< ET...	RenderFormat
FIntPoint	RenderResolution
EInheritedSourc...	ResolutionSource
TLazyObjectPtr<...	TargetCameraActor
TArray< UCompos...	TransformPasses

Constructors

	Name	Description
	ACompositingElement ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
UCompositing...	AddNewInputPass ( FName PassName, TSubclassOf< UCompositingElementInp... )
UCompositing...	AddNewOutputPass ( FName PassName, TSubclassOf< UCompositingElementOut... )
T *	AddNewPass ( FName PassName, ECompPassConstructionType Construct... )
UCompositing...	AddNewPass ( FName PassName, TSubclassOf< UCompositingElementPas..., ECompPassConstructionType Construct... )
UCompositing...	AddNewTransformPass ( FName PassName, TSubclassOf< UCompositingElementTra... )
bool	AttachAsChildLayer ( ACompositingElement* Child )
UCompositing...	CreateNewInputPass ( FName PassName, TSubclassOf< UCompositingElementInp... )	Create a new input pass into the public list which directly shows in the editor.
UCompositing...	CreateNewOutputPass ( FName PassName, TSubclassOf< UCompositingElementOut... )	Create a new Output pass into the public list which directly shows in the editor.
UCompositing...	CreateNewTransformPass ( FName PassName, TSubclassOf< UCompositingElementTra... )	Create a new Transform pass into the public list which directly shows in the editor.
bool	DeletePass ( UCompositingElementPass* PassT... )	Delete a specific pass.
bool	DetatchAsChildLayer ( ACompositingElement* Child )
void	EnqueueRendering_Implementation ( bool bCameraCutThisFrame )
UCompositing...	FindInputPass ( TSubclassOf< UCompositingElementInp..., UTexture*& PassResult, FName OptionalPassName )
UTexture ...	FindNamedRenderResult ( FName PassName, bool bSearchSubElements )
UCompositing...	FindOutputPass ( TSubclassOf< UCompositingElementOut..., FName OptionalPassName )
ACameraActor...	FindTargetCamera()
UCompositing...	FindTransformPass ( TSubclassOf< UCompositingElementTra..., UTexture*& PassResult, FName OptionalPassName )
const TArray...	GetChildElements()	Get the first level of current element's child composure elements.
FName	GetCompElementName()	Return the FName of the composure element object
ACompositing...	GetElementParent()	Get the parent composure element of current element.
TArray< UCom...	GetInputsList()
UTexture ...	GetLatestRenderResult()
float	GetOpacity()	Return the rendering opacity of current composure actor.
TArray< UCom...	GetOutputsList()
FIntPoint	GetRenderResolution()
TArray< UCom...	GetTransformsList()
bool	IsActivelyRunning_Implementation()
bool	IsSubElement()	Determines whether current composure element is a child of another composure element or not.
void	RegisterPassResult ( FName ReferenceName, UTexture* PassResult, bool bSetAsLatestRenderResult )
bool	ReleaseOwnedTarget ( UTextureRenderTarget2D* OwnedT... )
bool	RemovePass ( UCompositingElementPass* Eleme... )	Remove a pass from inner pass.
int32	RemovePassesOfType ( TSubclassOf< UCompositingElementPas... )
UTexture ...	RenderCompElement ( bool bCameraCutThisFrame )
UTexture ...	RenderCompositingMaterial ( FCompositingMaterial& CompMaterial, float RenderScale, FName ResultLookupName, ETargetUsageFlags UsageTag )
UTextureRend...	RenderCompositingMaterialToTarget ( FCompositingMaterial& CompMaterial, UTextureRenderTarget2D* Render..., FName ResultLookupName )
UTextureRend...	RequestNamedRenderTarget ( const FName ReferenceName, const float RenderPercentage, ETargetUsageFlags UsageTag )
void	SetEditorColorPickerDisplayImage ( UTexture* PickerDisplayImage )	EDITOR ONLY - Specifies an intermediate image to display when picking (if left unset, we default to the final output image)
void	SetEditorColorPickingTarget ( UTextureRenderTarget2D* Pickin... )	"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.EDITOR ONLY - Specifies which intermediate target to pick colors from (if left unset, we default to the display image)
void	SetElementName ( const FName NewName )	Rename composure actor's name
void	SetOpacity ( const float NewOpacity )	Set the rendering opacity of current composure actor.
void	SetRenderResolution ( FIntPoint NewResolution )
void	SetTargetCamera ( ACameraActor* NewCameraActor )

Overridden from AComposurePipelineBaseActor

	Name	Description
int32	GetRenderPriority()
void	SetAutoRun ( bool bNewAutoRunVal )
void	SetAutoRunChildrenAndSelf ( bool bAutoRunChildAndSelf )	When set to false, all children composure actor and current actor's auto-rendering behavior will be disabled.

Overridden from AActor

	Name	Description
void	BeginPlay()	Overridable native event for when play begins for this actor.
void	OnConstruction ( const FTransform& Transform )	Called when an instance of this class is placed (in editor) or spawned.
void	RerunConstructionScripts()	Rerun construction scripts, destroying all autogenerated components; will attempt to preserve the root component location.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostDuplicate ( bool bDuplicateForPIE )	Called after duplication & serialization and before PostLoad.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostEditUndo()	Called after applying a transaction to the object.
void	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.
void	Serialize ( FArchive& Ar )	Handles reading, writing, and reference collecting using FArchive.

Overridden from ICompImageColorPickerInterface

		Name	Description
	UTexture ...	GetColorPickerDisplayImage()
	UTextureRend...	GetColorPickerTarget()
	FCompFreezeF...	GetFreezeFrameController()

Overridden from ICompEditorImagePreviewInterface

		Name	Description
	UTexture ...	GetEditorPreviewImage()
	void	OnBeginPreview()
	void	OnEndPreview()
	bool	UseImplicitGammaForPreview()

Typedefs

Name	Description
FOnCompElementConstructed
FOnFinalPassRendered	Called when this comp shot element has rendered its final output
FOnTransformPassRendered	Called when this comp shot element has rendered one of its internal transform passes
FSharedTargetPoolPtr

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss