1. Epic GamesDeveloper
  3. UCompositeLayerBase

UCompositeLayerBase

Base class for defining a pass object, and its associated render proxy.

API > API/Plugins > API/Plugins/Composite

Base class for defining a pass object, and its associated render proxy.

   
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 UObject

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  

Structs

Name Remarks
FTraversalContext Context used during layer to proxy assembly.

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  
Name FString Pass layer name. Layers/CompositeLayerBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=""
  • Meta=(DisplayPriority="1")
Operation ECompositeCoreMergeOp Merge operation applied on Input0 with Input1. Layers/CompositeLayerBase.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=""
  • Meta=(DisplayPriority="3")

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool GetProxy ( FTraversalContext& InContext,
FSceneRenderingBulkObjectAllocator& InFrameAllocator,
FCompositeCorePassProxy*& OutProxy
) const

 Getter function to override, returning pass layer proxies to be passed to the render thread. Layers/CompositeLayerBase.h  

virtual bool IsEnabled()

 Get the enabled state. Layers/CompositeLayerBase.h
  • BlueprintGetter

virtual void OnRemoved ( const UWorld* World
)

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

virtual void OnRenderingStateChange ( bool bApply
)

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

virtual void SetEnabled ( bool bInEnabled
)

 Set the enabled state. Layers/CompositeLayerBase.h
  • BlueprintSetter

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Layers/CompositeLayerBase.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Layers/CompositeLayerBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddChildPasses ( UE::CompositeCore::FPassInputDecl& InBasePassInput,
FTraversalContext& 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 FTraversalContext& InContext
) const

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

ECompositeCoreMergeOp GetMergeOperation ( const FTraversalContext& InContext
) const

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

const FIntPoint GetRenderResolution()

 Convenience function that returns the composite actor's render resolution. Layers/CompositeLayerBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page