UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FRectLightSceneProxy Class Reference

#include <RectLightSceneProxy.h>

+ Inheritance diagram for FRectLightSceneProxy:

Public Member Functions

 FRectLightSceneProxy (const URectLightComponent *Component)
 
virtual ~FRectLightSceneProxy ()
 
virtual bool IsRectLight () const override
 
virtual bool HasSourceTexture () const override
 
virtual void GetLightShaderParameters (FLightRenderParameters &OutLightParameters, uint32 Flags=0) const override
 
virtual bool GetWholeSceneProjectedShadowInitializer (const FSceneViewFamily &ViewFamily, TArray< FWholeSceneProjectedShadowInitializer, TInlineAllocator< 6 > > &OutInitializers) const
 
- Public Member Functions inherited from FLocalLightSceneProxy
 FLocalLightSceneProxy (const ULocalLightComponent *Component)
 
void UpdateRadius_GameThread (float Radius)
 
virtual float GetMaxDrawDistance () const final override
 
virtual float GetFadeRange () const final override
 
virtual float GetRadius () const override
 
virtual bool AffectsBounds (const FBoxSphereBounds &Bounds) const override
 
virtual bool GetScissorRect (FIntRect &ScissorRect, const FSceneView &View, const FIntRect &ViewRect) const override
 
virtual bool SetScissorRect (FRHICommandList &RHICmdList, const FSceneView &View, const FIntRect &ViewRect, FIntRect *OutScissorRect=nullptr) const override
 
virtual FSphere GetBoundingSphere () const
 
virtual float GetEffectiveScreenRadius (const FViewMatrices &ShadowViewMatrices, const FIntPoint &CameraViewRectSize) const override
 
virtual float GetEffectiveScreenRadius (const FViewMatrices &ShadowViewMatrices) const override
 
virtual FVector GetPerObjectProjectedShadowProjectionPoint (const FBoxSphereBounds &SubjectBounds) const
 
virtual bool GetPerObjectProjectedShadowInitializer (const FBoxSphereBounds &SubjectBounds, class FPerObjectProjectedShadowInitializer &OutInitializer) const override
 
virtual bool IsLocalLight () const override
 
- Public Member Functions inherited from FLightSceneProxy
ENGINE_API FLightSceneProxy (const ULightComponent *InLightComponent)
 
virtual ENGINE_API ~FLightSceneProxy ()
 
ENGINE_API void SetLightFunctionMaterial_GameThread (const ULightComponent *Component)
 
ENGINE_API void SetTransmission_GameThread (const ULightComponent *Component)
 
virtual float GetOuterConeAngle () const
 
virtual float GetSourceRadius () const
 
virtual bool IsInverseSquared () const
 
virtual float GetLightSourceAngle () const
 
virtual float GetShadowSourceAngleFactor () const
 
virtual float GetTraceDistance () const
 
 UE_DEPRECATED (5.1, "The GetEffectiveScreenRadius() that uses the screen-percentage scaled view rect (above) is used now.") virtual float GetEffectiveScreenRadius(const FViewMatrices &ShadowViewMatrices) const
 
virtual FVector2D GetDirectionalLightDistanceFadeParameters (ERHIFeatureLevel::Type InFeatureLevel, bool bPrecomputedLightingIsValid, int32 MaxNearCascades) const
 
virtual int32 GetDirectionalLightForwardShadingPriority () const
 
virtual bool GetLightShaftOcclusionParameters (float &OutOcclusionMaskDarkness, float &OutOcclusionDepthRange) const
 
virtual FVector GetLightPositionForLightShafts (FVector ViewOrigin) const
 
virtual ENGINE_API bool ShouldCreatePerObjectShadowsForDynamicObjects () const
 
virtual ENGINE_API bool UseCSMForDynamicObjects () const
 
float GetVSMTexelDitherScale () const
 
float GetVSMResolutionLodBias () const
 
virtual uint32 GetNumViewDependentWholeSceneShadows (const FSceneView &View, bool bPrecomputedLightingIsValid) const
 
virtual bool GetViewDependentWholeSceneProjectedShadowInitializer (const FSceneView &View, int32 InCascadeIndex, bool bPrecomputedLightingIsValid, FWholeSceneProjectedShadowInitializer &OutInitializer) const
 
virtual FSphere GetShadowSplitBounds (const FSceneView &View, int32 InCascadeIndex, bool bPrecomputedLightingIsValid, FShadowCascadeSettings *OutCascadeSettings) const
 
virtual FSphere GetShadowSplitBoundsDepthRange (const FSceneView &View, FVector ViewOrigin, float SplitNear, float SplitFar, FShadowCascadeSettings *OutCascadeSettings) const
 
virtual bool ShouldCreateRayTracedCascade (ERHIFeatureLevel::Type Type, bool bPrecomputedLightingIsValid, int32 MaxNearCascades) const
 
float GetUserShadowBias () const
 
float GetUserShadowSlopeBias () const
 
const ULightComponentGetLightComponent () const
 
FSceneInterfaceGetSceneInterface () const
 
FLightSceneInfoGetLightSceneInfo () const
 
const FMatrixGetWorldToLight () const
 
const FMatrixGetLightToWorld () const
 
FVector GetDirection () const
 
FVector GetOrigin () const
 
FVector4 GetPosition () const
 
const FLinearColorGetColor () const
 
float GetIndirectLightingScale () const
 
float GetVolumetricScatteringIntensity () const
 
float GetRayEndBias () const
 
float GetShadowResolutionScale () const
 
FGuid GetLightGuid () const
 
float GetShadowSharpen () const
 
float GetContactShadowLength () const
 
bool IsContactShadowLengthInWS () const
 
float GetContactShadowCastingIntensity () const
 
float GetContactShadowNonCastingIntensity () const
 
float GetSpecularScale () const
 
float GetDiffuseScale () const
 
FVector GetLightFunctionScale () const
 
float GetLightFunctionFadeDistance () const
 
float GetLightFunctionDisabledBrightness () const
 
UTextureLightProfileGetIESTexture () const
 
ENGINE_API FTextureGetIESTextureResource () const
 
const FMaterialRenderProxyGetLightFunctionMaterial () const
 
bool IsMovable () const
 
bool HasStaticLighting () const
 
bool HasStaticShadowing () const
 
bool CastsDynamicShadow () const
 
bool CastsStaticShadow () const
 
bool AllowMegaLights () const
 
TEnumAsByte< EMegaLightsShadowMethod::TypeGetMegaLightsShadowMethod () const
 
bool CastsTranslucentShadows () const
 
bool CastsVolumetricShadow () const
 
bool CastsHairStrandsDeepShadow () const
 
TEnumAsByte< ECastRayTracedShadow::TypeCastsRaytracedShadow () const
 
bool AffectReflection () const
 
bool AffectGlobalIllumination () const
 
bool CastsShadowsFromCinematicObjectsOnly () const
 
bool CastsModulatedShadows () const
 
const FLinearColorGetModulatedShadowColor () const
 
const float GetShadowAmount () const
 
bool AffectsTranslucentLighting () const
 
bool Transmission () const
 
bool UseRayTracedDistanceFieldShadows () const
 
bool UseVirtualShadowMaps () const
 
float GetRayStartOffsetDepthScale () const
 
uint8 GetLightType () const
 
uint8 GetLightingChannelMask () const
 
uint8 GetViewLightingChannelMask () const
 
FName GetComponentFName () const
 
bool IsSelected () const
 
void SetSelected (bool bNewSelected)
 
FString GetOwnerNameOrLabel () const
 
FName GetLevelName () const
 
TStatId GetStatId () const
 
int32 GetShadowMapChannel () const
 
int32 GetPreviewShadowMapChannel () const
 
const class FStaticShadowDepthMapGetStaticShadowDepthMap () const
 
bool GetForceCachedShadowsForMovablePrimitives () const
 
uint32 GetSamplesPerPixel () const
 
float GetDeepShadowLayerDistribution () const
 
virtual ENGINE_API void ApplyWorldOffset (FVector InOffset)
 
bool IsUsedAsAtmosphereSunLight () const
 
uint8 GetAtmosphereSunLightIndex () const
 
FLinearColor GetAtmosphereSunDiskColorScale () const
 
virtual void SetAtmosphereRelatedProperties (FLinearColor TransmittanceTowardSunIn, FLinearColor SunDiscOuterSpaceLuminanceIn)
 
virtual FLinearColor GetOuterSpaceLuminance () const
 
virtual FLinearColor GetOuterSpaceIlluminance () const
 
virtual FLinearColor GetAtmosphereTransmittanceTowardSun () const
 
virtual FLinearColor GetSunIlluminanceOnGroundPostTransmittance () const
 
virtual FLinearColor GetSunIlluminanceAccountingForSkyAtmospherePerPixelTransmittance () const
 
virtual bool GetPerPixelTransmittanceEnabled () const
 
virtual float GetSunLightHalfApexAngleRadian () const
 
virtual bool GetCastShadowsOnClouds () const
 
virtual bool GetCastShadowsOnAtmosphere () const
 
virtual bool GetCastCloudShadows () const
 
virtual float GetCloudShadowExtent () const
 
virtual float GetCloudShadowMapResolutionScale () const
 
virtual float GetCloudShadowRaySampleCountScale () const
 
virtual float GetCloudShadowStrength () const
 
virtual float GetCloudShadowOnAtmosphereStrength () const
 
virtual float GetCloudShadowOnSurfaceStrength () const
 
virtual float GetCloudShadowDepthBias () const
 
virtual FLinearColor GetCloudScatteredLuminanceScale () const
 
virtual bool GetUsePerPixelAtmosphereTransmittance () const
 
void SetLightFunctionAtlasIndices (uint8 LightIndex)
 
bool HasValidLightFunctionAtlasSlot () const
 
uint8 GetLightFunctionAtlasLightIndex () const
 
- Public Member Functions inherited from FLightSceneProxyFixLayout
virtual ~FLightSceneProxyFixLayout ()=default
 

Public Attributes

float SourceWidth
 
float SourceHeight
 
float BarnDoorAngle
 
float BarnDoorLength
 
UTextureSourceTexture
 
uint32 RectAtlasId
 
float LightFunctionConeAngleTangent
 
FVector4f SourceTextureScaleOffset
 
- Public Attributes inherited from FLocalLightSceneProxy
float Radius
 
float InvRadius
 

Additional Inherited Members

- Static Public Member Functions inherited from FLightSceneProxy
static float GetSunOnEarthHalfApexAngleRadian ()
 
- Protected Member Functions inherited from FLocalLightSceneProxy
void UpdateRadius (float ComponentRadius)
 
- Protected Member Functions inherited from FLightSceneProxy
ENGINE_API void SetTransform (const FMatrix &InLightToWorld, const FVector4 &InPosition)
 
ENGINE_API void SetColor (const FLinearColor &InColor)
 
- Protected Attributes inherited from FLocalLightSceneProxy
float MaxDrawDistance
 
float FadeRange
 
float InverseExposureBlend
 
- Protected Attributes inherited from FLightSceneProxy
const ULightComponentLightComponent
 
FSceneInterfaceSceneInterface
 
class FLightSceneInfoLightSceneInfo
 
FVector4 Position
 
FLinearColor Color
 
FMatrix WorldToLight
 
FMatrix LightToWorld
 
float IndirectLightingScale
 
float VolumetricScatteringIntensity
 
float RayEndBias
 
float ShadowResolutionScale
 
float ShadowBias
 
float ShadowSlopeBias
 
float ShadowSharpen
 
float ContactShadowLength
 
float ContactShadowCastingIntensity
 
float ContactShadowNonCastingIntensity
 
float SpecularScale
 
float DiffuseScale
 
FGuid LightGuid
 
int32 ShadowMapChannel
 
int32 PreviewShadowMapChannel
 
float RayStartOffsetDepthScale
 
const class FStaticShadowDepthMapStaticShadowDepthMap
 
FVector LightFunctionScale
 
float LightFunctionFadeDistance
 
float LightFunctionDisabledBrightness
 
const FMaterialRenderProxyLightFunctionMaterial
 
UTextureLightProfileIESTexture
 
uint8 bContactShadowLengthInWS: 1
 
const uint8 bMovable: 1
 
const uint8 bStaticLighting: 1
 
uint8 bStaticShadowing: 1
 
uint8 bCastDynamicShadow: 1
 
const uint8 bCastStaticShadow: 1
 
const uint8 bCastTranslucentShadows: 1
 
uint8 bTransmission: 1
 
const uint8 bCastVolumetricShadow: 1
 
const uint8 bCastHairStrandsDeepShadow: 1
 
const uint8 bCastShadowsFromCinematicObjectsOnly: 1
 
const uint8 bForceCachedShadowsForMovablePrimitives: 1
 
const TEnumAsByte< ECastRayTracedShadow::TypeCastRaytracedShadow
 
const uint8 bAffectReflection: 1
 
const uint8 bAffectGlobalIllumination: 1
 
const uint8 bAffectTranslucentLighting: 1
 
const uint8 bUsedAsAtmosphereSunLight: 1
 
const uint8 bUseRayTracedDistanceFieldShadows: 1
 
uint8 bUseVirtualShadowMaps: 1
 
uint8 bCastModulatedShadows: 1
 
uint8 bUseWholeSceneCSMForMovableObjects: 1
 
uint8 bSelected: 1
 
const uint8 bAllowMegaLights: 1
 
const TEnumAsByte< EMegaLightsShadowMethod::TypeMegaLightsShadowMethod
 
uint8 LightFunctionAtlasLightIndex
 
const uint8 AtmosphereSunLightIndex
 
FLinearColor AtmosphereSunDiskColorScale
 
const uint8 LightType
 
uint8 LightingChannelMask
 
uint8 ViewLightingChannelMask
 
TStatId StatId
 
FName ComponentName
 
FName LevelName
 
float VSMTexelDitherScale
 
float VSMResolutionLodBias
 
float FarShadowDistance
 
uint32 FarShadowCascadeCount
 
FLinearColor ModulatedShadowColor
 
float ShadowAmount
 
uint32 SamplesPerPixel
 
float DeepShadowLayerDistribution
 
uint32 IESAtlasId
 

Constructor & Destructor Documentation

◆ FRectLightSceneProxy()

FRectLightSceneProxy::FRectLightSceneProxy ( const URectLightComponent Component)

◆ ~FRectLightSceneProxy()

FRectLightSceneProxy::~FRectLightSceneProxy ( )
virtual

Member Function Documentation

◆ GetLightShaderParameters()

void FRectLightSceneProxy::GetLightShaderParameters ( FLightRenderParameters LightParameters,
uint32  Flags = 0 
) const
overridevirtual

Accesses parameters needed for rendering the light.

Reimplemented from FLightSceneProxy.

◆ GetWholeSceneProjectedShadowInitializer()

bool FRectLightSceneProxy::GetWholeSceneProjectedShadowInitializer ( const FSceneViewFamily ViewFamily,
TArray< FWholeSceneProjectedShadowInitializer, TInlineAllocator< 6 > > &  OutInitializers 
) const
virtual

Sets up a projected shadow initializer for shadows from the entire scene.

Returns
True if the whole-scene projected shadow should be used.

Reimplemented from FLightSceneProxy.

◆ HasSourceTexture()

bool FRectLightSceneProxy::HasSourceTexture ( ) const
overridevirtual

Reimplemented from FLightSceneProxy.

◆ IsRectLight()

bool FRectLightSceneProxy::IsRectLight ( ) const
overridevirtual

Reimplemented from FLightSceneProxy.

Member Data Documentation

◆ BarnDoorAngle

float FRectLightSceneProxy::BarnDoorAngle

◆ BarnDoorLength

float FRectLightSceneProxy::BarnDoorLength

◆ LightFunctionConeAngleTangent

float FRectLightSceneProxy::LightFunctionConeAngleTangent

◆ RectAtlasId

uint32 FRectLightSceneProxy::RectAtlasId

◆ SourceHeight

float FRectLightSceneProxy::SourceHeight

◆ SourceTexture

UTexture* FRectLightSceneProxy::SourceTexture

◆ SourceTextureScaleOffset

FVector4f FRectLightSceneProxy::SourceTextureScaleOffset

◆ SourceWidth

float FRectLightSceneProxy::SourceWidth

The documentation for this class was generated from the following files: