UCompositeLayerBase

Base class for a composite layer: a named unit that merges an input into the composite stack and runs sub-passes on it.

API > API/Plugins > API/Plugins/Composite

Base class for a composite layer: a named unit that merges an input into the composite stack and runs sub-passes on it. Subclasses spawn a per-frame render proxy via GetProxy() and own a list of UCompositePassBase to apply after merging.

   
Name UCompositeLayerBase
Type class
Header File /Engine/Plugins/Compositing/Composite/Source/Composite/Public/Layers/CompositeLayerBase.h
Include Path #include "Layers/CompositeLayerBase.h"

Syntax

UCLASS (MinimalAPI, Abstract, EditInlineNew)  
class UCompositeLayerBase : public UCompositePassBase

Inheritance Hierarchy

Derived Classes

UCompositeLayerBase derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCompositeLayerBase ( const FObjectInitializer& ObjectInitializer
)

 Constructor. Layers/CompositeLayerBase.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UCompositeLayerBase()

 Destructor. Layers/CompositeLayerBase.h  

Constants

Name Type Remarks Include Path
FixedNumLayerInputs int32 Fixed number of inputs used by layer merge passes. Layers/CompositeLayerBase.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsSolo bool Whether or not the pass is solo. Layers/CompositeLayerBase.h  
meta   Sub-passes applied to this layer's input before it is merged into the composite stack. Layers/CompositeLayerBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Instanced
  • Category="Composite"
  • Meta=(DisallowedClasses="/Script/Composite.CompositeLayerBase, /Script/Composite.CompositePassDistortion")
Operation ECompositeCoreMergeOp Merge operation applied on Input0 with Input1. Layers/CompositeLayerBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(DisplayPriority="3")

Protected

Name Type Remarks Include Path Unreal Specifiers
OnWorldPreSendAllEndOfFrameUpdatesHandle FDelegateHandle Post-viewport update callback. Layers/CompositeLayerBase.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddChildPasses ( UE::CompositeCore::FPassInputDecl& InBasePassInput,
FCompositeTraversalContext& InContext,
FSceneRenderingBulkObjectAllocator& InFrameAllocator,
TArrayView< const TObjectPtr< UCompositePassBase > > InPasses
) const

 Convenience function to register post-processing child passes. Layers/CompositeLayerBase.h  

UE::CompositeCore::FPassInputDecl GetDefaultSecondInput ( const FCompositeTraversalContext& InContext
) const

 Convenience function that returns the default secondary input depending on the traversal context. Layers/CompositeLayerBase.h  

ECompositeCoreMergeOp GetMergeOperation ( const FCompositeTraversalContext& InContext
) const

 Convenience function that returns the merge operation depending on the traversal context. Layers/CompositeLayerBase.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void OnEndOfFrameUpdate ( UWorld* InWorld
)

 End-of-frame update callback to inherit. Called when enabled by RegisterEndOfFrameUpdate. Layers/CompositeLayerBase.h  

virtual void OnRemoved ( ACompositeActor* LastOwner
)

 Called when the layer is removed or composite actor is destroyed. Layers/CompositeLayerBase.h  

virtual void OnRenderingStateChange ( ECompositeStateChangeType ChangeType
)

 Called when composite actor rendering state changes. Layers/CompositeLayerBase.h  

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 layer. Layers/CompositeLayerBase.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Layers/CompositeLayerBase.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Layers/CompositeLayerBase.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Layers/CompositeLayerBase.h  

virtual void PostLoad()

   Layers/CompositeLayerBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

void RegisterEndOfFrameUpdate ( bool bInEnabled
)

 Activate the end-of-frame update callback. Layers/CompositeLayerBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static void UpdateSceneCaptureComponents ( USceneCaptureComponent2D& SceneCaptureComponent,
TArrayView< TSoftObjectPtr< AActor > > InActors
)

 Convenience function to update scene capture primitive components, depending on the scene capture primitive render mode. Layers/CompositeLayerBase.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Name_DEPRECATED FString Deprecated layer display name, use UCompositePassBase::DisplayName. Layers/CompositeLayerBase.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use DisplayName instead.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page