UCompositeLayerSceneCapture

Layer that renders selected primitives through a scene capture (or inlined custom render pass) and merges the result.

API > API/Plugins > API/Plugins/Composite

Layer that renders selected primitives through a scene capture (or inlined custom render pass) and merges the result. By default, registered primitives are hidden from the main render so they are rendered exclusively into this capture.

   
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

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="Composite"
  • 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="Composite"
  • Meta=(AllowPrivateAccess=true)
bVisibleInSceneCaptureOnly bool Visibility setting applied to registered actors. Layers/CompositeLayerSceneCapture.h
  • EditAnywhere
  • BlueprintGetter=IsVisibleInSceneCaptureOnly
  • BlueprintSetter=SetVisibleInSceneCaptureOnly
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
CachedVisibilityInSceneCapture TMap< TWeakObjectPtr< UPrimitiveComponent >, bool >   Layers/CompositeLayerSceneCapture.h
  • Meta=(DeprecatedProperty, DeprecationMessage="CachedVisibilityInSceneCapture is now deprecated.")
RenderTargetResolution FIntPoint Render target resolution for the scene capture. Layers/CompositeLayerSceneCapture.h
  • EditAnywhere
  • BlueprintGetter=GetRenderTargetResolution
  • BlueprintSetter=SetRenderTargetResolution
  • Interp
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
SpawnableBindings FCompositeSpawnableBindings Parallel spawnable binding data for the Actors array. 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

FIntPoint GetRenderTargetResolution()

 Get the render target resolution for the scene capture. 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 SetRenderTargetResolution ( FIntPoint InRenderTargetResolution
)

 Set the render target resolution for the scene capture. Layers/CompositeLayerSceneCapture.h
  • BlueprintSetter

void SetVisibleInSceneCaptureOnly ( bool bInVisible
)

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

Public Virtual

Overridden from UCompositeLayerBase

Name Remarks Include Path Unreal Specifiers

virtual void OnEndOfFrameUpdate ( UWorld* InWorld
)

 End-of-frame update callback. Layers/CompositeLayerSceneCapture.h  

virtual void OnRemoved ( ACompositeActor* LastOwner
)

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

Overridden from UCompositePassBase

Name Remarks Include Path Unreal Specifiers

virtual bool GetIsActive ()

 Returns true if the pass should participate in rendering this frame. Layers/CompositeLayerSceneCapture.h  

virtual FCompositeCorePassProxy * GetProxy ( const UE::CompositeCore::FPassInputDecl& InputDecl,
FCompositeTraversalContext& InContext,
FSceneRenderingBulkObjectAllocator& InFrameAllocator
) const

 Override to return a render-thread proxy for this layer. 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 PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   Layers/CompositeLayerSceneCapture.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   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