1. Epic GamesDeveloper
  3. ACompositeActor

ACompositeActor

Actor used to control properties of the composite pipeline.

API > API/Plugins > API/Plugins/Composite

Actor used to control properties of the composite pipeline.

   
Name ACompositeActor
Type class
Header File /Engine/Plugins/Compositing/Composite/Source/Composite/Public/CompositeActor.h
Include Path #include "CompositeActor.h"

Syntax

UCLASS (MinimalAPI)  
class ACompositeActor : public AActor

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

ACompositeActor ( const FObjectInitializer& ObjectInitializer
)

 Constructor. CompositeActor.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~ACompositeActor()

 Destructor. CompositeActor.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AllowedViewModes ECompositeAllowedViewModes Constrain composite rendering to specific view modes. CompositeActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
  • AdvancedDisplay
bEnableScreenSpaceReflections bool Also provide the post-processing composite graph to SSR input. CompositeActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
  • AdvancedDisplay
bOverridesViewUserFlags bool Override default view user flags. CompositeActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
  • AdvancedDisplay
MainRenderOutput ECompositeMainRenderOutputMode Main render color space & encoding output mode. CompositeActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
  • AdvancedDisplay
OnPostJoinMultiUserSession FOnCompositeActorPostJoinMultiUserSession Delegate called after joining a multi-user session. CompositeActor.h
  • BlueprintAssignable
  • BlueprintCallable
  • BlueprintReadWrite
  • Category="Composite"
RenderResolution FIntPoint Composite render (output) resolution. CompositeActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
ViewUserFlags int32 Custom user flags value used to alter materials in the composite render pass. CompositeActor.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • AdvancedDisplay
  • Meta=(EditCondition="bOverridesViewUserFlags")

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsActive bool Whether or not the composite behavior is active locally - used primarily for multi-user. CompositeActor.h
  • NonTransactional
  • EditInstanceOnly
  • BlueprintGetter=IsActive
  • BlueprintSetter=SetActive
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
bIsEnabled bool Whether or not the composite behavior is enabled. CompositeActor.h
  • EditAnywhere
  • BlueprintGetter=IsEnabled
  • BlueprintSetter=SetEnabled
  • Interp
  • Category="Composite"
  • Meta=(DisplayName="Enabled", AllowPrivateAccess=true, DisplayPriority="0")
bIsModifyingAProperty bool Flag used to determine in which cases we should ignore PostRegister / Unregister calls. CompositeActor.h  
Camera FComponentReference The primary camera used for the composite. CompositeActor.h
  • EditInstanceOnly
  • BlueprintGetter=GetCamera
  • BlueprintSetter=SetCamera
  • Category="Composite"
  • Meta=(AllowPrivateAccess, UseComponentPicker, AllowAnyActor, AllowedClasses="/Script/Engine.CameraComponent, /Script/CinematicCamera.CineCameraComponent")
CompositeLayers TArray< TObjectPtr< UCompositeLayerBase > > Array of composite layers for merging or processing images. CompositeActor.h
  • EditAnywhere
  • BlueprintGetter=GetCompositeLayers
  • BlueprintSetter=SetCompositeLayers
  • Instanced
  • Category="Composite"
  • Meta=(DisplayName="Layers")
PreEditCompositeLayers TArray< UCompositeLayerBase * > Used to update components after we remove layers. CompositeActor.h  
SceneCapturesPerLayer TMap< TWeakObjectPtr< const UCompositeLayerBase >, FSceneCaptureComponentArray > Layer-managed scene capture components. CompositeActor.h  
ViewProjectionComponent TObjectPtr< class UCompositeViewProjectionComponent > Component responsible for continuously updating a material parameter collection with the composite camera view projection matrix. CompositeActor.h
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers

void DestroySceneCaptures ( const UCompositeLayerBase* InLayer
)

 Convenience function used by layers to remove and scene capture components. CompositeActor.h  
     
     

RetType * FindOrCreateSceneCapture ( const UCompositeLayerBase* InLayer,
int32 InIndex,
FName InBaseName
)

 Convenience function used by layers to request a scene capture component. CompositeActor.h  

FComponentReference & GetCamera()

 Camera component getter. CompositeActor.h
  • BlueprintGetter
Get the composite layers. CompositeActor.h
  • BlueprintGetter
Get the composite layers. CompositeActor.h  

bool IsActive()

 Get the (locally) active state. CompositeActor.h
  • BlueprintGetter

bool IsEnabled()

 Get the enabled state. CompositeActor.h
  • BlueprintGetter

bool IsRendering()

 Returns true if the composite is actively rendering. CompositeActor.h  

void PostJoinConcertSession()

 Called after we join a multi-user session. CompositeActor.h  

void SetActive ( bool bInActive
)

 Set the (locally) active state. CompositeActor.h
  • BlueprintSetter

void SetCamera ( const FComponentReference& InComponentReference
)

 Camera component setter. CompositeActor.h
  • BlueprintSetter

void SetCompositeLayers ( TArray< UCompositeLayerBase* > InLayers
)

 Set the composite layers. CompositeActor.h
  • BlueprintSetter

void SetEnabled ( bool bInEnabled
)

 Set the enabled state. CompositeActor.h
  • BlueprintSetter

Overridden from AActor

Name Remarks Include Path Unreal Specifiers

virtual void Destroyed()

   CompositeActor.h  

virtual void PostRegisterAllComponents()

   CompositeActor.h  

virtual void PostUnregisterAllComponents()

   CompositeActor.h  

virtual void PreDuplicateFromRoot ( FObjectDuplicationParameters& DupParams
)

   CompositeActor.h  

virtual void SetIsTemporarilyHiddenInEditor ( bool bIsHidden
)

   CompositeActor.h  

virtual bool ShouldTickIfViewportsOnly()

   CompositeActor.h  

virtual void Tick ( float DeltaSeconds
)

   CompositeActor.h  

virtual void UnregisterAllComponents ( bool bForReregister
)

   CompositeActor.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedChainEvent
)

   CompositeActor.h  

virtual void PostEditUndo()

   CompositeActor.h  

virtual void PostLoad()

   CompositeActor.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   CompositeActor.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   CompositeActor.h  

virtual void PreEditUndo()

   CompositeActor.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page