UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
TVolumeLightingSample< SHOrder > Class Template Reference

#include <PrecomputedLightVolume.h>

Public Member Functions

 TVolumeLightingSample ()
 
 TVolumeLightingSample (const TVolumeLightingSample< 2 > &Other)
 
 TVolumeLightingSample (const TVolumeLightingSample< 3 > &Other)
 
void SetPackedSkyBentNormal (FVector InSkyBentNormal)
 
FVector GetSkyBentNormalUnpacked () const
 
 TVolumeLightingSample (const TVolumeLightingSample< 2 > &Other)
 
 TVolumeLightingSample (const TVolumeLightingSample< 2 > &Other)
 
 TVolumeLightingSample (const TVolumeLightingSample< 3 > &Other)
 
 TVolumeLightingSample (const TVolumeLightingSample< 3 > &Other)
 

Public Attributes

FVector3f Position
 
float Radius
 
TSHVectorRGB< SHOrderLighting
 
FColor PackedSkyBentNormal
 
float DirectionalLightShadowing
 

Friends

FArchiveoperator<< (FArchive &Ar, TVolumeLightingSample< SHOrder > &Sample)
 

Detailed Description

template<int32 SHOrder>
class TVolumeLightingSample< SHOrder >

Incident radiance stored for a point.

Constructor & Destructor Documentation

◆ TVolumeLightingSample() [1/7]

◆ TVolumeLightingSample() [2/7]

◆ TVolumeLightingSample() [3/7]

◆ TVolumeLightingSample() [4/7]

◆ TVolumeLightingSample() [5/7]

◆ TVolumeLightingSample() [6/7]

◆ TVolumeLightingSample() [7/7]

Member Function Documentation

◆ GetSkyBentNormalUnpacked()

template<int32 SHOrder>
FVector TVolumeLightingSample< SHOrder >::GetSkyBentNormalUnpacked ( ) const
inline

◆ SetPackedSkyBentNormal()

template<int32 SHOrder>
void TVolumeLightingSample< SHOrder >::SetPackedSkyBentNormal ( FVector  InSkyBentNormal)
inline

Friends And Related Symbol Documentation

◆ operator<<

template<int32 SHOrder>
FArchive & operator<< ( FArchive Ar,
TVolumeLightingSample< SHOrder > &  Sample 
)
friend

Member Data Documentation

◆ DirectionalLightShadowing

template<int32 SHOrder>
float TVolumeLightingSample< SHOrder >::DirectionalLightShadowing

Shadow factor for the stationary directional light.

◆ Lighting

template<int32 SHOrder>
TSHVectorRGB<SHOrder> TVolumeLightingSample< SHOrder >::Lighting

Incident lighting at the sample position. For high quality lightmaps, only diffuse GI and static lights is represented here. For low quality lightmaps, diffuse GI and static and stationary light direct lighting is contained in the sample, with the exception of the stationary directional light.

◆ PackedSkyBentNormal

template<int32 SHOrder>
FColor TVolumeLightingSample< SHOrder >::PackedSkyBentNormal

BentNormal occlusion of the sky, packed into an FColor. This is only valid in the high quality lightmap data.

◆ Position

template<int32 SHOrder>
FVector3f TVolumeLightingSample< SHOrder >::Position

World space position of the sample.

◆ Radius

template<int32 SHOrder>
float TVolumeLightingSample< SHOrder >::Radius

World space radius that determines how far the sample can be interpolated.


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