1. Epic GamesDeveloper
  3. UCompositeLayerPlate

UCompositeLayerPlate

Convenience layer for media texture integration, with additional processing options.

API > API/Plugins > API/Plugins/Composite

Convenience layer for media texture integration, with additional processing options.

With composite meshes and default plugin materials, the media texture is projected into the scene & rendered separately as a custom render pass. The result is dilated and combined with other layers such as the main render (where the same composite meshes are rendered as holdouts).

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

Syntax

UCLASS (MinimalAPI, BlueprintType, Blueprintable, EditInlineNew, CollapseCategories,  
       Meta=(DisplayName="Plate"))  
class UCompositeLayerPlate :  
    public UCompositeLayerBase ,  
    public FTickableGameObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCompositeLayerPlate ( const FObjectInitializer& ObjectInitializer
)

 Constructor. Layers/CompositeLayerPlate.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UCompositeLayerPlate()

 Destructor. Layers/CompositeLayerPlate.h  

Constants

Name Type Remarks Include Path
CompositeTextureName const FLazyName Composite (media) texture material parameter name. Layers/CompositeLayerPlate.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
LayerPasses TArray< TObjectPtr< UCompositePassBase > > Passes applied during final compositing in post-processing. Layers/CompositeLayerPlate.h
  • EditAnywhere
  • BlueprintReadWrite
  • Instanced
  • Category=""
  • Meta=(DisallowedClasses="/Script/Composite.CompositePassDistortion")
MediaPasses TArray< TObjectPtr< UCompositePassBase > > Media texture pre-processing passes, applied before rendering. Layers/CompositeLayerPlate.h
  • EditAnywhere
  • BlueprintReadWrite
  • Instanced
  • Category=""
  • Meta=(DisallowedClasses="/Script/Composite.CompositePassMaterial, /Script/Composite.CompositePassDistortion, /Script/Composite.CompositePassFXAA, /Script/Composite.CompositePassSMAA")
ScenePasses TArray< TObjectPtr< UCompositePassBase > > Passes applied after media passes, onto composite meshes only. Layers/CompositeLayerPlate.h
  • BlueprintReadWrite
  • Instanced
  • Category=""
  • Meta=(AllowedClasses="/Script/Composite.CompositePassDistortion")
Texture TObjectPtr< UTexture > Media texture for compositing layer. Layers/CompositeLayerPlate.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=""
  • Meta=(AllowedClasses="/Script/Engine.Texture2D, /Script/MediaAssets.MediaTexture")

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedValidMediaPasses int32 Cached number of valid media passes. Layers/CompositeLayerPlate.h  
CachedValidScenePasses int32 Cached number of valid scene passes. Layers/CompositeLayerPlate.h  
CompositeMeshes TArray< TSoftObjectPtr< AActor > > Actors whose primitive mesh components will be marked as primitive alpha holdout, and rendered separately with the projected (media) texture. Layers/CompositeLayerPlate.h
  • EditAnywhere
  • BlueprintGetter=GetCompositeMeshes
  • BlueprintSetter=SetCompositeMeshes
  • Category=""
  • Meta=(AllowPrivateAccess=true)
MediaRenderTarget TObjectPtr< UTextureRenderTarget2D > Processed media texture render target. Layers/CompositeLayerPlate.h
  • Transient
  • NonTransactional
PlateMode ECompositePlateMode The plate sampling & rendering mode: direct texture sampling or separate composite mesh render. Layers/CompositeLayerPlate.h
  • EditAnywhere
  • BlueprintGetter=GetPlateMode
  • BlueprintSetter=SetPlateMode
  • Category=""
  • AdvancedDisplay
  • Meta=(AllowPrivateAccess=true, DisplayName="Mode")
PreEditCompositeMeshes TArray< TSoftObjectPtr< AActor > > Pre-edit list of registered composite meshes. Layers/CompositeLayerPlate.h  
SceneRenderTarget TObjectPtr< UTextureRenderTarget2D > Processed media texture with additional passes only for scene composite meshes. Layers/CompositeLayerPlate.h
  • Transient
  • NonTransactional

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TArray< TSoftObjectPtr< AActor > > GetCompositeMeshes()

 Get composite meshes. Layers/CompositeLayerPlate.h
  • BlueprintGetter

UTexture * GetCompositeTexture()

 Returns the media texture, optionally pre-processed with layer & scene-only passes into a render target. Layers/CompositeLayerPlate.h
  • BlueprintCallable
  • Category="Composite"

ECompositePlateMode GetPlateMode()

 Get the plate sampling & rendering mode Layers/CompositeLayerPlate.h
  • BlueprintGetter

TArray< UPrimitiveComponent * > GetPrimitives()

 Get array of all composite mesh primitives. Layers/CompositeLayerPlate.h  

void SetCompositeMeshes ( TArray< TSoftObjectPtr< AActor > > InCompositeMeshes
)

 Set composite meshes. Layers/CompositeLayerPlate.h
  • BlueprintSetter

void SetPlateMode ( ECompositePlateMode InPlateMode
)

 Set the plate sampling & rendering mode Layers/CompositeLayerPlate.h
  • BlueprintSetter

Overridden from UCompositeLayerBase

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/CompositeLayerPlate.h  

virtual void OnRemoved ( const UWorld* World
)

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

virtual void OnRenderingStateChange ( bool bApply
)

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

virtual void SetEnabled ( bool bInEnabled
)

 Set the enabled state. Layers/CompositeLayerPlate.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Layers/CompositeLayerPlate.h  

virtual bool CanEditChange ( const FProperty* InProperty
) const

   Layers/CompositeLayerPlate.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Layers/CompositeLayerPlate.h  

virtual void PostLoad()

   Layers/CompositeLayerPlate.h  

virtual void PostTransacted ( const FTransactionObjectEvent& InTransactionEvent
)

   Layers/CompositeLayerPlate.h  

virtual void PreEditChange ( FProperty* PropertyThatWillChange
)

   Layers/CompositeLayerPlate.h  

Overridden from FTickableGameObject

Name Remarks Include Path Unreal Specifiers

virtual UWorld * GetTickableGameObjectWorld()

   Layers/CompositeLayerPlate.h  

virtual bool IsTickableInEditor()

   Layers/CompositeLayerPlate.h  

virtual bool IsTickableWhenPaused()

   Layers/CompositeLayerPlate.h  

Overridden from FTickableObjectBase

Name Remarks Include Path Unreal Specifiers

virtual TStatId GetStatId()

   Layers/CompositeLayerPlate.h  

virtual ETickableTickType GetTickableTickType()

   Layers/CompositeLayerPlate.h  

virtual bool IsTickable()

   Layers/CompositeLayerPlate.h  

virtual void Tick ( float DeltaTime
)

   Layers/CompositeLayerPlate.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page