1. Epic GamesDeveloper
  3. ACompositingElement

ACompositingElement

API > API/Plugins > API/Plugins/Composure

Inheritance Hierarchy

References

   
Module Composure
Header /Engine/Plugins/Compositing/Composure/Source/Composure/Classes/CompositingElement.h
Include #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

Variables

  Type Name Description
Public variable UProperty Category, EditDefaultsOnly, AdvancedDisplay bool bUseSharedTargetPool  
Public variable UProperty Category, EditAnywhere ESceneCameraLinkType CameraSource  
Public variable UProperty Category BlueprintReadOnly TObjectPtr< UComposureCompositingTargetComponent > CompositingTarget  
Public variable UProperty Category, EditDefaultsOnly TSubclassOf< UCompositingElementInput > DefaultInputType  
Public variable UProperty Category, EditDefaultsOnly TSubclassOf< UCompositingElementOutput > DefaultOutputType  
Public variable UProperty Category, EditDefaultsOnly TSubclassOf< UCompositingElementTransform > DefaultTransformType  
Public variable FCompFreezeFrameController FreezeFrameController  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly blueprintgetter, instanced TArray< TObjectPtr< UCompositingElementInput > > Inputs Pipeline Passes
Public variable FOnCompElementConstructed OnConstructed  
Public variable FOnFinalPassRendered OnFinalPassRendered  
Public variable UProperty Category BlueprintAssignable blueprintcallable, displayname FDynamicOnFinalPassRendered OnFinalPassRendered_BP Called when the final output of this element is rendered
Public variable FOnTransformPassRendered OnTransformPassRendered  
Public variable UProperty Category BlueprintAssignable blueprintcallable, displayname FDynamicOnTransformPassRendered OnTransformPassRendered_BP Called when a transform pass on this element is rendered
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly blueprintgetter, instanced TArray< TObjectPtr< UCompositingElementOutput > > Outputs  
Public variable UProperty Category BlueprintReadOnly TObjectPtr< UComposurePostProcessingPassProxy > PostProcessProxy  
Public variable UProperty Category, EditAnywhere instanced TObjectPtr< UCompositingElementTransform > PreviewTransform  
Public variable UProperty Category, EditAnywhere EInheritedSourceType PreviewTransformSource  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite TEnumAsByte< ETextureRenderTargetFormat > RenderFormat  
Protected variable UProperty Category, EditAnywhere blueprintgetter, blueprintsetter FIntPoint RenderResolution  
Public variable UProperty Category, EditAnywhere EInheritedSourceType ResolutionSource  
Public variable UProperty Category displayname, editinstanceonly TWeakObjectPtr< ACameraActor > TargetCameraActorPtr  
Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadOnly blueprintgetter, instanced TArray< TObjectPtr< UCompositingElementTransform > > TransformPasses  

Constructors

  Type Name Description
Public function  

ACompositingElement ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function UFunction BlueprintCallable, Category, Meta UCompositingElementInput *

AddNewInputPass ( FName PassName,
UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UCompositingElementInput > InputType
)

  
Protected function UFunction BlueprintCallable, Category, Meta UCompositingElementOutput *

AddNewOutputPass ( FName PassName,
UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UCompositingElementOutput > OutputType
)

  
Public function T *

AddNewPass ( FName PassName,
ECompPassConstructionType ConstructedBy
)

  
Public function UCompositingElementPass *  
Protected function UFunction BlueprintCallable, Category, Meta UCompositingElementTransform *

AddNewTransformPass ( FName PassName,
UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UCompositingElementTransform > TransformType
)

  
Public function bool  
Public function UFunction BlueprintCallable, Category, Meta UCompositingElementInput *

CreateNewInputPass ( FName PassName,
UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UCompositingElementInput > InputType
)

 Create a new input pass into the public list which directly shows in the editor.
Public function UFunction BlueprintCallable, Category, Meta UCompositingElementOutput *

CreateNewOutputPass ( FName PassName,
UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UCompositingElementOutput > OutputType
)

 Create a new Output pass into the public list which directly shows in the editor.
Public function UFunction BlueprintCallable, Category, Meta UCompositingElementTransform *

CreateNewTransformPass ( FName PassName,
UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UCompositingElementTransform > TransformType
)

 Create a new Transform pass into the public list which directly shows in the editor.
Public function UFunction BlueprintCallable, Category bool Delete a specific pass.
Public function bool  
Public function Virtual void

EnqueueRendering_Implementation ( bool bCameraCutThisFrame
)

  
Public function UFunction BlueprintCallable, Category, Meta UCompositingElementInput *

FindInputPass ( UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UCompositingElementInput > InputType,
UTexture*& PassResult,
FName OptionalPassName
)

  
Public function UFunction BlueprintCallable, Category UTexture *

FindNamedRenderResult ( FName PassName,
bool bSearchSubElements
)

  
Public function UFunction BlueprintCallable, Category, Meta UCompositingElementOutput *

FindOutputPass ( UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UCompositingElementOutput > OutputType,
FName OptionalPassName
)

  
Public function Const UFunction BlueprintPure, Category ACameraActor *  
Public function UFunction BlueprintCallable, Category, Meta UCompositingElementTransform *

FindTransformPass ( UPARAM(meta=(AllowAbstract="false")) TSubclassOf< UCompositingElementTransform > TransformType,
UTexture*& PassResult,
FName OptionalPassName
)

  
Public function Const UFunction BlueprintCallable, Category const TArray< ACompositingElement * > Get the first level of current element's child composure elements.
Public function Const UFunction BlueprintPure, Category FName Return the FName of the composure element object
Public function Const UFunction BlueprintPure, Category ACompositingElement * Get the parent composure element of current element.
Public function Const UFunction blueprintgetter TArray< UCompositingElementInput * >  
Public function Const UFunction BlueprintCallable, Category UTexture *  
Public function Const UFunction BlueprintPure, Category float Return the rendering opacity of current composure actor.
Public function Const UFunction blueprintgetter TArray< UCompositingElementOutput * >  
Public function Const UFunction blueprintgetter FIntPoint  
Public function Const UFunction blueprintgetter TArray< UCompositingElementTransform * >  
Public function Virtual Const bool  
Public function Const UFunction BlueprintPure, Category bool Determines whether current composure element is a child of another composure element or not.
Public function UFunction BlueprintCallable, Category void

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

  
Public function UFunction BlueprintCallable, Category bool  
Public function bool Remove a pass from inner pass.
Public function int32  
Public function UFunction Category, Meta blueprintnativeevent UTexture *

RenderCompElement ( bool bCameraCutThisFrame
)

  
Public function UFunction BlueprintCallable, Category UTexture *

RenderCompositingMaterial ( UPARAM(ref) FCompositingMaterial& CompMaterial,
float RenderScale,
FName ResultLookupName,
ETargetUsageFlags UsageTag
)

  
Public function UFunction BlueprintCallable, Category UTextureRenderTarget2D *

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

  
Public function UFunction BlueprintCallable, Category UTextureRenderTarget2D *

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

  
Public function UFunction BlueprintCallable, Category void

SetEditorColorPickerDisplayImage ( UTexture* PickerDisplayImage
)

 EDITOR ONLY - Specifies an intermediate image to display when picking (if left unset, we default to the final output image)
Public function UFunction BlueprintCallable, Category void 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.
Public function UFunction BlueprintCallable, Category void

SetElementName ( const FName NewName
)

 Rename composure actor's name
Public function UFunction BlueprintCallable, Category void

SetOpacity ( const float NewOpacity
)

 Set the rendering opacity of current composure actor.
Public function UFunction blueprintsetter void

SetRenderResolution ( FIntPoint NewResolution
)

  
Public function UFunction BlueprintCallable, Category void

SetTargetCamera ( ACameraActor* NewCameraActor
)

  

Overridden from AComposurePipelineBaseActor

  Type Name Description
Public function Virtual Const UFunction BlueprintPure, Category int32  
Public function Virtual void

SetAutoRun ( bool bNewAutoRunVal
)

  
Public function Virtual 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

  Type Name Description
Public function Virtual void Overridable native event for when play begins for this actor.
Public function Virtual void

OnConstruction ( const FTransform& Transform
)

 Called when an instance of this class is placed (in editor) or spawned.
Public function Virtual void Rerun construction scripts, destroying all autogenerated components; will attempt to preserve the root component location.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void

PostDuplicate ( bool bDuplicateForPIE
)

 Called after duplication & serialization and before PostLoad.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Called after applying a transaction to the object.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Overridden from ICompImageColorPickerInterface

  Type Name Description
Public function Virtual UTexture *  
Public function Virtual UTextureRenderTarget2D *  
Public function Virtual FCompFreezeFrameController *  

Overridden from ICompEditorImagePreviewInterface

  Type Name Description
Public function Virtual UTexture *  
Public function Virtual void  
Public function Virtual void  
Public function Virtual Const bool  

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  

Deprecated Variables

  Type Name Description
Public variable UProperty TLazyObjectPtr< ACameraActor > TargetCameraActor_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page