Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > FLightSceneProxy

Light Theme

Dark Theme

FLightSceneProxy

Encapsulates the data which is used to render a light by the rendering thread.

Windows

MacOS

Linux

Inheritance Hierarchy

FLightSceneProxy

FLocalLightSceneProxy

FRectLightSceneProxy

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/SceneManagement.h
Include	#include "SceneManagement.h"

Syntax

class FLightSceneProxy

Remarks

Encapsulates the data which is used to render a light by the rendering thread. The constructor is called from the game thread, and after that the rendering thread owns the object. FLightSceneProxy is in the engine module and is subclassed to implement various types of lights.

Variables

	Name	Description
const FLinearCo...	AtmosphereSunDiskColorScale
const uint8	AtmosphereSunLightIndex	The index of the atmospheric light.
const uint8: 1	bAffectDynamicIndirectLighting	Does the light have dynamic GI?
const uint8: 1	bAffectGlobalIllumination	Whether the light affects global illumination, when ray-traced global illumination is enabled.
const uint8: 1	bAffectReflection	Whether the light affects objects in reflections, when ray-traced reflection is enabled.
const uint8: 1	bAffectTranslucentLighting	Whether the light affects translucency or not.
const uint8: 1	bCastDynamicShadow	True if the light casts dynamic shadows.
const uint8: 1	bCastHairStrandsDeepShadow
uint8: 1	bCastModulatedShadows	Whether the light will cast modulated shadows when using the forward renderer (mobile).
const uint8: 1	bCastRaytracedShadow	Whether the light shadows are computed with shadow-mapping or ray-tracing (when available).
const uint8: 1	bCastShadowsFromCinematicObjectsOnly
const uint8: 1	bCastStaticShadow	True if the light casts static shadows.
const uint8: 1	bCastTranslucentShadows	Whether the light is allowed to cast dynamic shadows from translucency.
const uint8: 1	bCastVolumetricShadow
uint8: 1	bContactShadowLengthInWS	True: length of screen space ray trace for sharp contact shadows is in world space.
const uint8: 1	bForceCachedShadowsForMovablePrimitives
const uint8: 1	bHasReflectiveShadowMap
bool	bMobileMovablePointLightShouldBeRender	Cached ShouldBeRender for mobile, since if the ShouldBeRender is changed we have to update the movable point lights uniform buffer.
bool	bMobileMovablePointLightShouldCastShadow	Cached DynamicShadows show flag for mobile, since if the show flag is changed we have to update the movable point lights uniform buffer.
bool	bMobileMovablePointLightUniformBufferNeedsUpdate	If this is TRUE, the light's mobile movable point light uniform buffer needs to be updated before it can be used for mobile base pass rendering.
const uint8: 1	bMovable	True if the light's Mobility is set to Movable.
const uint8: 1	bStaticLighting	Return True if a light's parameters as well as its position is static during gameplay, and can thus use static lighting.
const uint8: 1	bStaticShadowing	Whether the light has static direct shadowing.
uint8: 1	bTiledDeferredLightingSupported	Whether the light supports rendering in tiled deferred pass
const uint8: 1	bTransmission	Whether light from this light transmits through surfaces with subsurface scattering profiles.
const uint8: 1	bUsedAsAtmosphereSunLight	Whether to consider light as a sunlight for atmospheric scattering and exponential height fog.
const uint8: 1	bUseRayTracedDistanceFieldShadows	Whether to use ray traced distance field area shadows.
uint8: 1	bUseWholeSceneCSMForMovableObjects	Whether to render csm shadows for movable objects only (mobile).
FLinearColor	Color	The light color.
FName	ComponentName	The name of the light component.
float	ContactShadowLength	Length of screen space ray trace for sharp contact shadows.
float	DeepShadowLayerDistribution	Deep shadow layer distribution.
uint32	FarShadowCascadeCount	Only for whole scene directional lights, 0: no FarShadowCascades, otherwise the count of cascades between WholeSceneDynamicShadowRadius and FarShadowDistance that are covered by distant shadow cascades.
float	FarShadowDistance	Only for whole scene directional lights, if FarShadowCascadeCount > 0 and FarShadowDistance >= WholeSceneDynamicShadowRadius, where far shadow cascade should end.
UTextureLightPr...	IESTexture	IES texture (light profiles from real world measured data) We are safe to store a U pointer as those objects get deleted deferred, storing an FTexture pointer would crash if we recreate the texture
float	IndirectLightingScale	Scale for indirect lighting from this light. When 0, indirect lighting is disabled.
FName	LevelName	The name of the level the light is in.
const ULightCom...	LightComponent	The light component.
float	LightFunctionDisabledBrightness
float	LightFunctionFadeDistance
const FMaterial...	LightFunctionMaterial
FVector	LightFunctionScale	Light function parameters.
FGuid	LightGuid	The light's persistent shadowing GUID.
uint8	LightingChannelMask
FLightSceneInfo...	LightSceneInfo	The light's scene info.
FMatrix	LightToWorld	A transform from light space into world space.
const uint8	LightType	The light type (ELightComponentType)
FVector4	MobileMovablePointLightShadowmapMinMax	Cached the spotlight shadow map min and max value for mobile, since if the value is changed we have to update the movable point lights uniform buffer.
TUniformBufferR...	MobileMovablePointLightUniformBuffer	The movable point light's uniform buffer for mobile.
FLinearColor	ModulatedShadowColor	Modulated shadow color.
FVector4	Position	The homogenous position of the light.
int32	PreviewShadowMapChannel	Transient shadowmap channel used to preview the results of stationary light shadowmap packing.
float	RayStartOffsetDepthScale
uint32	SamplesPerPixel	Samples per pixel for ray tracing
FSceneInterface...	SceneInterface	The scene the primitive is in.
float	ShadowAmount	Control the amount of shadow occlusion.
float	ShadowBias	User setting from light component, 0:no bias, 0.5:reasonable, larger object might appear to float
int32	ShadowMapChannel	Shadow map channel which is used to match up with the appropriate static shadowing during a deferred shading pass.
float	ShadowResolutionScale
float	ShadowSharpen	Sharpen shadow filtering
float	ShadowSlopeBias	User setting from light component, 0:no bias, 0.5:reasonable, larger object might appear to float
float	SpecularScale	Specular scale
const FStaticSh...	StaticShadowDepthMap
TStatId	StatId	Used for dynamic stats
float	VolumetricScatteringIntensity	Scales this light's intensity for volumetric scattering.
FMatrix	WorldToLight	A transform from world space into light space.

Constructors

	Name	Description
	FLightSceneProxy ( const ULightComponent* InLight... )	Initialization constructor.

Destructors

	Name	Description
	~FLightSceneProxy()

Functions

	Name	Description
bool	AffectGlobalIllumination()
bool	AffectReflection()
bool	AffectsBounds ( const FBoxSphereBounds& Bounds )	Tests whether the light affects the given bounding volume.
bool	AffectsTranslucentLighting()
void	ApplyWorldOffset ( FVector InOffset )	Shifts light position and all relevant data by an arbitrary delta. Called on world origin changes
bool	CastsDynamicShadow()
bool	CastsHairStrandsDeepShadow()
bool	CastsModulatedShadows()
bool	CastsRaytracedShadow()
bool	CastsShadowsFromCinematicObjectsOnly()
bool	CastsStaticShadow()
bool	CastsTranslucentShadows()
bool	CastsVolumetricShadow()
FLinearColor	GetAtmosphereSunDiskColorScale()
uint8	GetAtmosphereSunLightIndex()
FSphere	GetBoundingSphere()
bool	GetCastCloudShadows()
bool	GetCastShadowsOnAtmosphere()
bool	GetCastShadowsOnClouds()
FLinearColor	GetCloudScatteredLuminanceScale()
float	GetCloudShadowDepthBias()
float	GetCloudShadowExtent()
float	GetCloudShadowMapResolutionScale()
float	GetCloudShadowOnAtmosphereStrength()
float	GetCloudShadowOnSurfaceStrength()
float	GetCloudShadowRaySampleCountScale()
float	GetCloudShadowStrength()
const FLinea...	GetColor()
FName	GetComponentName()
float	GetContactShadowLength()
float	GetDeepShadowLayerDistribution()
FVector	GetDirection()
FVector2D	GetDirectionalLightDistanceFadeParameters ( ERHIFeatureLevel::Type InFeatureLev..., bool bPrecomputedLightingIsValid, int32 MaxNearCascades )
float	GetEffectiveScreenRadius ( const FViewMatrices& ShadowViewMat... )
float	GetFadeRange()
bool	GetForceCachedShadowsForMovablePrimitives()
UTextureLigh...	GetIESTexture()
FTexture ...	GetIESTextureResource()
float	GetIndirectLightingScale()
FName	GetLevelName()
const ULight...	GetLightComponent()	The Rendering thread must not dereference UObjects! The game thread owns UObject state and may be writing to them at any time.
float	GetLightFunctionDisabledBrightness()
float	GetLightFunctionFadeDistance()
const FMater...	GetLightFunctionMaterial()
FVector	GetLightFunctionScale()
FGuid	GetLightGuid()
uint8	GetLightingChannelMask()
FVector	GetLightPositionForLightShafts ( FVector ViewOrigin )
FLightSceneI...	GetLightSceneInfo()
void	GetLightShaderParameters ( FLightShaderParameters& PathTracin... )	Accesses parameters needed for rendering the light.
bool	GetLightShaftOcclusionParameters ( float& OutOcclusionMaskDarkness, float& OutOcclusionDepthRange )
float	GetLightSourceAngle()
const FMatri...	GetLightToWorld()
uint8	GetLightType()
float	GetMaxDrawDistance()
FRHIUniformB...	GetMobileMovablePointLightUniformBufferRHI()
const FLinea...	GetModulatedShadowColor()
uint32	GetNumViewDependentWholeSceneShadows ( const FSceneView& View, bool bPrecomputedLightingIsValid )	Returns the number of view dependent shadows this light will create, not counting distance field shadow cascades.
FVector	GetOrigin()
float	GetOuterConeAngle()
FLinearColor	GetOuterSpaceLuminance()
bool	GetPerObjectProjectedShadowInitializer ( const FBoxSphereBounds& SubjectBou..., FPerObjectProjectedShadowInitialize... )	Sets up a projected shadow initializer for the given subject.
FVector4	GetPosition()
int32	GetPreviewShadowMapChannel()
float	GetRadius()
float	GetRayStartOffsetDepthScale()
uint32	GetSamplesPerPixel()
FSceneInterf...	GetSceneInterface()
bool	GetScissorRect ( FIntRect& ScissorRect, const FSceneView& View, const FIntRect& ViewRect )
const float	GetShadowAmount()
int32	GetShadowMapChannel()
float	GetShadowResolutionScale()
float	GetShadowSharpen()
float	GetShadowSourceAngleFactor()
FSphere	GetShadowSplitBounds ( const FSceneView& View, int32 InCascadeIndex, bool bPrecomputedLightingIsValid, FShadowCascadeSettings* OutCas... )
FSphere	GetShadowSplitBoundsDepthRange ( const FSceneView& View, FVector ViewOrigin, float SplitNear, float SplitFar, FShadowCascadeSettings* OutCas... )
float	GetSourceRadius()
float	GetSpecularScale()
const FStati...	GetStaticShadowDepthMap()
TStatId	GetStatId()
float	GetSunLightHalfApexAngleRadian()
float	GetSunOnEarthHalfApexAngleRadian()
float	GetTraceDistance()
FLinearColor	GetTransmittanceFactor()
bool	GetUsePerPixelAtmosphereTransmittance()
float	GetUserShadowBias()	Accessors.
float	GetUserShadowSlopeBias()
bool	GetViewDependentRsmWholeSceneProjectedShadowInitializer ( const FSceneView& View, const FBox& LightPropagationVolume..., FWholeSceneProjectedShadowInitializ... )	Sets up a projected shadow initializer for a reflective shadow map that's dependent on the current view for shadows from the entire scene.
bool	GetViewDependentWholeSceneProjectedShadowInitializer ( const FSceneView& View, int32 InCascadeIndex, bool bPrecomputedLightingIsValid, FWholeSceneProjectedShadowInitializ... )	Sets up a projected shadow initializer that's dependent on the current view for shadows from the entire scene.
float	GetVolumetricScatteringIntensity()
bool	GetWholeSceneProjectedShadowInitializer ( const FSceneViewFamily& ViewFamily, TArray< class FWholeSceneProjectedS... )	Sets up a projected shadow initializer for shadows from the entire scene.
const FMatri...	GetWorldToLight()
bool	HasReflectiveShadowMap()
bool	HasSourceTexture()
bool	HasStaticLighting()
bool	HasStaticShadowing()
bool	IsContactShadowLengthInWS()
bool	IsInverseSquared()
bool	IsMovable()
bool	IsRectLight()
bool	IsTiledDeferredLightingSupported()
bool	IsUsedAsAtmosphereSunLight()
bool	NeedsLPVInjection()
void	SetAtmosphereRelatedProperties ( FLinearColor TransmittanceFactor, FLinearColor SunOuterSpaceLuminance, bool bApplyAtmosphereTransmittanceT... )
void	SetColor ( const FLinearColor& InColor )	Updates the light's color.
void	SetMobileMovablePointLightUniformBufferNeedsUpdate ( bool bInMobileMovablePointLightUnif... )
bool	SetScissorRect ( FRHICommandList& RHICmdList, const FSceneView& View, const FIntRect& ViewRect, FIntRect* OutScissorRect )
void	SetTransform ( const FMatrix& InLightToWorld, const FVector4& InPosition )	Updates the light proxy's cached transforms.
bool	ShouldCreatePerObjectShadowsForDynamicObjects()	Whether this light should create per object shadows for dynamic objects.
bool	ShouldCreateRayTracedCascade ( ERHIFeatureLevel::Type Type, bool bPrecomputedLightingIsValid, int32 MaxNearCascades )
bool	Transmission()
bool	UseCSMForDynamicObjects()	Whether this light should create CSM for dynamic objects only (forward renderer)
bool	UseRayTracedDistanceFieldShadows()

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss