FLightSceneProxy


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

Type	Name	Description
const FLinearColor	AtmosphereSunDiskColorScale
const uint8	AtmosphereSunLightIndex	The index of the atmospheric light.
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.
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	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	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.
uint8: 1	bStaticShadowing	Whether the light has static direct shadowing.
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	bUseVirtualShadowMaps	Whether to use virtual shadow maps.
uint8: 1	bUseWholeSceneCSMForMovableObjects	Whether to render csm shadows for movable objects only (mobile).
const TEnumAsByte< ECastRayTracedShadow::Type >	CastRaytracedShadow	Whether the light shadows are computed with shadow-mapping or ray-tracing (when available).
FLinearColor	Color	The light color.
FName	ComponentName	The name of the light component.
float	ContactShadowCastingIntensity	Intensity of the shadows cast by primitives with "cast contact shadow" enabled.
float	ContactShadowLength	Length of screen space ray trace for sharp contact shadows.
float	ContactShadowNonCastingIntensity	Intensity of the shadows cast by primitives with "cast contact shadow" disabled.
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.
uint32	IESAtlasId	IES texture atlas id.
UTextureLightProfile *	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 ULightComponent *	LightComponent	The light component.
float	LightFunctionDisabledBrightness
float	LightFunctionFadeDistance
const FMaterialRenderProxy *	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)
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 FStaticShadowDepthMap *	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.

	Type	Name	Description
		FLightSceneProxy ( const ULightComponent* InLightComponent )	Initialization constructor.

	Type	Name	Description
		~FLightSceneProxy ()

Type	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 ()
TEnumAsByte< ECastRayTracedShadow::Type >	CastsRaytracedShadow ()
bool	CastsShadowsFromCinematicObjectsOnly ()
bool	CastsStaticShadow ()
bool	CastsTranslucentShadows ()
bool	CastsVolumetricShadow ()
FLinearColor	GetAtmosphereSunDiskColorScale ()
uint8	GetAtmosphereSunLightIndex ()
FLinearColor	GetAtmosphereTransmittanceTowardSun ()
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 FLinearColor &	GetColor ()
FName	GetComponentFName ()
float	GetContactShadowCastingIntensity ()
float	GetContactShadowLength ()
float	GetContactShadowNonCastingIntensity ()
float	GetDeepShadowLayerDistribution ()
FVector	GetDirection ()
FVector2D	GetDirectionalLightDistanceFadeParameters ( ERHIFeatureLevel::Type InFeatureLevel, bool bPrecomputedLightingIsValid, int32 MaxNearCascades )
int32	GetDirectionalLightForwardShadingPriority ()
float	GetEffectiveScreenRadius ( const FViewMatrices& ShadowViewMatrices, const FIntPoint& CameraViewRectSize )	TODO: refactor this to move into the shadow scene renderer.
float	GetFadeRange ()
bool	GetForceCachedShadowsForMovablePrimitives ()
UTextureLightProfile *	GetIESTexture ()
FTexture *	GetIESTextureResource ()
float	GetIndirectLightingScale ()
FName	GetLevelName ()
const ULightComponent *	GetLightComponent ()	Note: 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 FMaterialRenderProxy *	GetLightFunctionMaterial ()
FVector	GetLightFunctionScale ()
FGuid	GetLightGuid ()
uint8	GetLightingChannelMask ()
FVector	GetLightPositionForLightShafts ( FVector ViewOrigin )
FLightSceneInfo *	GetLightSceneInfo ()
void	GetLightShaderParameters ( FLightRenderParameters& OutLightParameters, uint32 Flags )	Accesses parameters needed for rendering the light.
bool	GetLightShaftOcclusionParameters ( float& OutOcclusionMaskDarkness, float& OutOcclusionDepthRange )
float	GetLightSourceAngle ()
const FMatrix &	GetLightToWorld ()
uint8	GetLightType ()
float	GetMaxDrawDistance ()
const FLinearColor &	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	GetOuterSpaceIlluminance ()
FLinearColor	GetOuterSpaceLuminance ()
const FString &	GetOwnerNameOrLabel ()	Use to get the owning actor label (or component name as fallback, if the owner is null or ENABLE_DEBUG_LABELS is off) for diagnostic messages, debug or profiling.
bool	GetPerObjectProjectedShadowInitializer ( const FBoxSphereBounds& SubjectBounds, FPerObjectProjectedShadowInitializer& OutInitializer )	Sets up a projected shadow initializer for the given subject.
bool	GetPerPixelTransmittanceEnabled ()
FVector4	GetPosition ()
int32	GetPreviewShadowMapChannel ()
float	GetRadius ()
float	GetRayStartOffsetDepthScale ()
uint32	GetSamplesPerPixel ()
FSceneInterface *	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* OutCascadeSettings )
FSphere	GetShadowSplitBoundsDepthRange ( const FSceneView& View, FVector ViewOrigin, float SplitNear, float SplitFar, FShadowCascadeSettings* OutCascadeSettings )
float	GetSourceRadius ()
float	GetSpecularScale ()
const FStaticShadowDepthMap *	GetStaticShadowDepthMap ()
TStatId	GetStatId ()
FLinearColor	GetSunIlluminanceAccountingForSkyAtmospherePerPixelTransmittance ()
FLinearColor	GetSunIlluminanceOnGroundPostTransmittance ()
float	GetSunLightHalfApexAngleRadian ()
float	GetSunOnEarthHalfApexAngleRadian ()
float	GetTraceDistance ()
bool	GetUsePerPixelAtmosphereTransmittance ()
float	GetUserShadowBias ()	Accessors.
float	GetUserShadowSlopeBias ()
bool	GetViewDependentWholeSceneProjectedShadowInitializer ( const FSceneView& View, int32 InCascadeIndex, bool bPrecomputedLightingIsValid, FWholeSceneProjectedShadowInitializer& OutInitializer )	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< FWholeSceneProjectedShadowInitializer, TInlineAllocator< 6 > >& OutInitializers )	Sets up a projected shadow initializer for shadows from the entire scene.
const FMatrix &	GetWorldToLight ()
bool	HasSourceTexture ()
bool	HasStaticLighting ()
bool	HasStaticShadowing ()
bool	IsContactShadowLengthInWS ()
bool	IsInverseSquared ()
bool	IsLocalLight ()
bool	IsMovable ()
bool	IsRectLight ()
bool	IsUsedAsAtmosphereSunLight ()
void	SetAtmosphereRelatedProperties ( FLinearColor TransmittanceTowardSunIn, FLinearColor SunDiscOuterSpaceLuminanceIn )
void	SetColor ( const FLinearColor& InColor )	Updates the light's color.
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 ()
bool	UseVirtualShadowMaps ()

	Type	Name	Description
	float	GetEffectiveScreenRadius ( const FViewMatrices& ShadowViewMatrices )	The GetEffectiveScreenRadius() that uses the screen-percentage scaled view rect (above) is used now.

Navigation

Inheritance Hierarchy

References

Syntax

Remarks

Variables

Constructors

Destructors

Functions

Deprecated Functions