UCompositeLayerSingleLightShadow

Layer that catches shadows cast by registered actors from a single specified light.

API > API/Plugins > API/Plugins/Composite

Layer that catches shadows cast by registered actors from a single specified light.

Uses classic shadow-map percentage-closer filtering (5x5 by default, no cascades). Implemented with custom render passes for minimal performance cost.

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

Syntax

UCLASS (MinimalAPI, BlueprintType, Blueprintable, EditInlineNew, CollapseCategories,  
       Meta=(DisplayName="Single Light Shadow"))  
class UCompositeLayerSingleLightShadow : public UCompositeLayerBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCompositeLayerSingleLightShadow ( const FObjectInitializer& ObjectInitializer
)

 Constructor. Layers/CompositeLayerSingleLightShadow.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UCompositeLayerSingleLightShadow()

 Destructor. Layers/CompositeLayerSingleLightShadow.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAutomaticBounds bool When enable, the shadow map render transform and orthographic width are automatically derived from the selected meshes and light angle. Layers/CompositeLayerSingleLightShadow.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
Light TObjectPtr< ALight > The reference light, whose direction or exact transform will by used to render a shadow map. Layers/CompositeLayerSingleLightShadow.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
  • Meta=(AllowedClasses="/Script/Engine.DirectionalLight")
OrthographicWidth float The desired width (in world units) of the shadow map view (ignored if light is not directional). Layers/CompositeLayerSingleLightShadow.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(EditCondition="!bAutomaticBounds", EditConditionHides)
ShadowMapResolution int32 Resolution of the shadow map texture. Lower resolutions will cause more blurry shadows. Layers/CompositeLayerSingleLightShadow.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Composite"
  • Meta=(ClampMin="128", UIMin="128", UIMax="4096")
ShadowStrength float Basic shadow strength multiplier, from 0 to 1. Layers/CompositeLayerSingleLightShadow.h
  • EditAnywhere
  • BlueprintReadWrite
  • Interp
  • Category="Composite"
  • Meta=(ClampMin="0.0", ClampMax="1.0", UIMin="0.0", UIMax="1.0")

Protected

Name Type Remarks Include Path Unreal Specifiers
CachedSceneDepthCapture TWeakObjectPtr< UCompositeSceneCapture2DComponent > Cached pointer to the scene depth capture. Layers/CompositeLayerSingleLightShadow.h  
CachedShadowMapCapture TWeakObjectPtr< UCompositeSceneCapture2DComponent > Cached pointer to the composite-managed shadow map scene capture. Layers/CompositeLayerSingleLightShadow.h  
RenderTargetResolution FIntPoint Render target resolution for the scene depth capture. Layers/CompositeLayerSingleLightShadow.h
  • EditAnywhere
  • BlueprintGetter=GetRenderTargetResolution
  • BlueprintSetter=SetRenderTargetResolution
  • Interp
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
ShadowCastingActors TArray< TSoftObjectPtr< AActor > > List of shadow casting actors (required). Layers/CompositeLayerSingleLightShadow.h
  • EditAnywhere
  • BlueprintGetter=GetShadowCastingActors
  • BlueprintSetter=SetShadowCastingActors
  • Category="Composite"
  • Meta=(AllowPrivateAccess=true)
SpawnableBindings FCompositeSpawnableBindings Parallel spawnable binding data for the ShadowCastingActors array. Layers/CompositeLayerSingleLightShadow.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FIntPoint GetRenderTargetResolution()

 Get the render target resolution for the scene depth capture. Layers/CompositeLayerSingleLightShadow.h
  • BlueprintGetter

const TArray< TSoftObjectPtr< AActor > > GetShadowCastingActors()

 Get shadow caster actors. Layers/CompositeLayerSingleLightShadow.h
  • BlueprintGetter

void SetRenderTargetResolution ( FIntPoint InRenderTargetResolution
)

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

void SetShadowCastingActors ( TArray< TSoftObjectPtr< AActor > > InShadowCaster
)

 Set shadow caster actors. Layers/CompositeLayerSingleLightShadow.h
  • BlueprintSetter

Public Virtual

Overridden from UCompositeLayerBase

Name Remarks Include Path Unreal Specifiers

virtual void OnEndOfFrameUpdate ( UWorld* InWorld
)

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

virtual void OnRemoved ( ACompositeActor* LastOwner
)

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   Layers/CompositeLayerSingleLightShadow.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Layers/CompositeLayerSingleLightShadow.h  

virtual void PostEditUndo()

   Layers/CompositeLayerSingleLightShadow.h  

virtual void PostTransacted ( const FTransactionObjectEvent& TransactionEvent
)

   Layers/CompositeLayerSingleLightShadow.h  

virtual void PreEditChange ( FProperty* PropertyAboutToChange
)

   Layers/CompositeLayerSingleLightShadow.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
ShadowBias_DEPRECATED float   Layers/CompositeLayerSingleLightShadow.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Shadow Bias 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