1. Epic GamesDeveloper
  3. UCompositeLayerSceneCapture

UCompositeLayerSceneCapture

Layer for scene capture (or custom render pass) render integration.

API > API/Plugins > API/Plugins/Composite

Layer for scene capture (or custom render pass) render integration.

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

Syntax

UCLASS (MinimalAPI, BlueprintType, Blueprintable, EditInlineNew, CollapseCategories,  
       Meta=(DisplayName="Scene Capture"))  
class UCompositeLayerSceneCapture : public UCompositeLayerBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCompositeLayerSceneCapture ( const FObjectInitializer& ObjectInitializer
)

 Constructor. Layers/CompositeLayerSceneCapture.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UCompositeLayerSceneCapture()

 Destructor. Layers/CompositeLayerSceneCapture.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
LayerPasses TArray< TObjectPtr< UCompositePassBase > > Sub-passes applied during post-processing. Layers/CompositeLayerSceneCapture.h
  • EditAnywhere
  • BlueprintReadWrite
  • Instanced
  • Category=""
  • Meta=(DisallowedClasses="/Script/Composite.CompositePassDistortion", DisplayAfter="bCustomRenderPass")

Protected

Name Type Remarks Include Path Unreal Specifiers
Actors TArray< TSoftObjectPtr< AActor > > List of actors to be rendered from the scene capture. Layers/CompositeLayerSceneCapture.h
  • EditAnywhere
  • BlueprintGetter=GetActors
  • BlueprintSetter=SetActors
  • Category=""
  • Meta=(AllowPrivateAccess=true)
bCustomRenderPass bool Convenience toggle to render the scene capture as a fast/minimal Custom Render Pass, inlined in the main render & without support for lighting. Layers/CompositeLayerSceneCapture.h
  • EditAnywhere
  • BlueprintGetter=IsCustomRenderPass
  • BlueprintSetter=SetCustomRenderPass
  • Category=""
  • Meta=(AllowPrivateAccess=true)
bVisibleInSceneCaptureOnly bool Visibility setting applied to registered actors. Layers/CompositeLayerSceneCapture.h
  • EditAnywhere
  • BlueprintGetter=IsVisibleInSceneCaptureOnly
  • BlueprintSetter=SetVisibleInSceneCaptureOnly
  • Category=""
  • Meta=(AllowPrivateAccess=true)
CachedVisibilityInSceneCapture TMap< TWeakObjectPtr< UPrimitiveComponent >, bool > Cached visibility in scene capture state to restore initial values. Layers/CompositeLayerSceneCapture.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TArray< TSoftObjectPtr< AActor > > GetActors()

 Get reflection & shadow caster actors. Layers/CompositeLayerSceneCapture.h
  • BlueprintGetter

bool IsCustomRenderPass()

 Get whether the scene capture is rendered as a custom render pass. Layers/CompositeLayerSceneCapture.h
  • BlueprintGetter

bool IsVisibleInSceneCaptureOnly()

 Get whether registered meshes are marked as visible in scene capture only. Layers/CompositeLayerSceneCapture.h
  • BlueprintGetter

void SetActors ( TArray< TSoftObjectPtr< AActor > > InActors
)

 Set reflection & shadow caster actors. Layers/CompositeLayerSceneCapture.h
  • BlueprintSetter

void SetCustomRenderPass ( bool bInIsFastRenderPass
)

 Set whether the scene capture is rendered as a custom render pass. Layers/CompositeLayerSceneCapture.h
  • BlueprintSetter

void SetVisibleInSceneCaptureOnly ( bool bInVisible
)

 Set whether registered meshes are marked as visible in scene capture only. Layers/CompositeLayerSceneCapture.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/CompositeLayerSceneCapture.h  

virtual void OnRemoved ( const UWorld* World
)

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Layers/CompositeLayerSceneCapture.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Layers/CompositeLayerSceneCapture.h  

virtual void PostEditUndo()

   Layers/CompositeLayerSceneCapture.h  

virtual void PreEditUndo()

   Layers/CompositeLayerSceneCapture.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page