UCompositeLayerShadowReflection

Layer that catches shadows and reflections received by registered primitives, producing a matte that is merged onto the plate.

API > API/Plugins > API/Plugins/Composite

Layer that catches shadows and reflections received by registered primitives, producing a matte that is merged onto the plate. Implemented with two scene captures (one with the primitives, one without); the ratio of their results yields a multiplicative matte.

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

Syntax

UCLASS (MinimalAPI, BlueprintType, Blueprintable, EditInlineNew, CollapseCategories,  
       Meta=(DisplayName="Shadow Reflection Catcher"))  
class UCompositeLayerShadowReflection : public UCompositeLayerBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCompositeLayerShadowReflection ( const FObjectInitializer& ObjectInitializer
)

 Constructor. Layers/CompositeLayerShadowReflection.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UCompositeLayerShadowReflection()

 Destructor. Layers/CompositeLayerShadowReflection.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bLuminanceOnly bool When true, the matte is computed from a single (grayscale) luminance ratio applied uniformly to all channels, instead of independent per-channel ratios. Layers/CompositeLayerShadowReflection.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"

Protected

Name Type Remarks Include Path Unreal Specifiers
Actors TArray< TSoftObjectPtr< AActor > > List of reflection & shadow caster actors. Layers/CompositeLayerShadowReflection.h
  • EditAnywhere
  • BlueprintGetter=GetActors
  • BlueprintSetter=SetActors
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
CachedSceneCaptures TStaticArray< TWeakObjectPtr< UCompositeShadowReflectionCatcherComponent >, 2 > Cached pointer to the scene captures with CG and without CG. Layers/CompositeLayerShadowReflection.h  
CachedVisibilityInSceneCapture TMap< TWeakObjectPtr< UPrimitiveComponent >, FCompositeShadowReflectionPrimitiveState >   Layers/CompositeLayerShadowReflection.h
  • Meta=(DeprecatedProperty, DeprecationMessage="CachedVisibilityInSceneCapture is now deprecated.")
RenderTargetResolution FIntPoint Render target resolution for the scene captures. Layers/CompositeLayerShadowReflection.h
  • EditAnywhere
  • BlueprintGetter=GetRenderTargetResolution
  • BlueprintSetter=SetRenderTargetResolution
  • Interp
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
SpawnableBindings FCompositeSpawnableBindings Parallel spawnable binding data for the Actors array. Layers/CompositeLayerShadowReflection.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TArray< TSoftObjectPtr< AActor > > GetActors()

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

FIntPoint GetRenderTargetResolution()

 Get the render target resolution for the scene captures. Layers/CompositeLayerShadowReflection.h
  • BlueprintGetter

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

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

void SetRenderTargetResolution ( FIntPoint InRenderTargetResolution
)

 Set the render target resolution for the scene captures. Layers/CompositeLayerShadowReflection.h
  • BlueprintSetter

Public Virtual

Overridden from UCompositeLayerBase

Name Remarks Include Path Unreal Specifiers

virtual void OnEndOfFrameUpdate ( UWorld* InWorld
)

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

virtual void OnRemoved ( ACompositeActor* LastOwner
)

 Called when the layer is removed or composite actor is destroyed. Layers/CompositeLayerShadowReflection.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/CompositeLayerShadowReflection.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/CompositeLayerShadowReflection.h  

virtual void SetIsEnabled ( bool bInEnabled
)

 Set the enabled state. Layers/CompositeLayerShadowReflection.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Layers/CompositeLayerShadowReflection.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Layers/CompositeLayerShadowReflection.h  

virtual void PostEditUndo()

   Layers/CompositeLayerShadowReflection.h  

virtual void PostLoad()

   Layers/CompositeLayerShadowReflection.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   Layers/CompositeLayerShadowReflection.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Layers/CompositeLayerShadowReflection.h  

virtual void PreEditUndo()

   Layers/CompositeLayerShadowReflection.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
AutoConfigureActors_DEPRECATED ECompositeHiddenInSceneCaptureConfiguration   Layers/CompositeLayerShadowReflection.h
  • Meta=(DeprecatedProperty, DeprecationMessage="AutoConfigureActors is now deprecated.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page