UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
LumenScene.cpp File Reference

Classes

class  FLumenCardPageGPUData
 

Namespaces

namespace  Lumen
 

Macros

#define LOG_LUMEN_PRIMITIVE_ADDS   0
 

Functions

bool Lumen::UseFarField (const FSceneViewFamily &ViewFamily)
 
bool Lumen::UseFarFieldOcclusionOnly ()
 
float Lumen::GetFarFieldMaxTraceDistance ()
 
float Lumen::GetNearFieldMaxTraceDistanceDitherScale (bool bUseFarField)
 
float Lumen::GetNearFieldSceneRadius (const FViewInfo &View, bool bUseFarField)
 
bool Lumen::SetLandscapeHeightSamplingParameters (const FVector &LumenSceneViewOrigin, const FScene *Scene, FLumenLandscapeHeightSamplingParameters &OutParameters)
 
bool TrackPrimitiveInstanceForLumenScene (const FMatrix &LocalToWorld, const FBox &LocalBoundingBox, bool bEmissiveLightSource)
 
void UpdateLumenScenePrimitives (FRHIGPUMask GPUMask, FScene *Scene)
 

Variables

int32 GLumenSceneGlobalDFResolution = 252
 
FAutoConsoleVariableRef CVarLumenSceneGlobalDFResolution (TEXT("r.LumenScene.GlobalSDF.Resolution"), GLumenSceneGlobalDFResolution, TEXT("Global Distance Field resolution when Lumen is enabled."), ECVF_RenderThreadSafe)
 
float GLumenSceneGlobalDFClipmapExtent = 2500.0f
 
FAutoConsoleVariableRef CVarLumenSceneGlobalDFClipmapExtent (TEXT("r.LumenScene.GlobalSDF.ClipmapExtent"), GLumenSceneGlobalDFClipmapExtent, TEXT("Global Distance Field first clipmap extent when Lumen is enabled."), ECVF_RenderThreadSafe)
 
TAutoConsoleVariable< int32CVarLumenSceneUpdateViewOrigin (TEXT("r.LumenScene.UpdateViewOrigin"), 1, TEXT("Whether to update view origin for voxel lighting and global distance field. Useful for debugging."), ECVF_RenderThreadSafe)
 

Macro Definition Documentation

◆ LOG_LUMEN_PRIMITIVE_ADDS

#define LOG_LUMEN_PRIMITIVE_ADDS   0

Function Documentation

◆ TrackPrimitiveInstanceForLumenScene()

bool TrackPrimitiveInstanceForLumenScene ( const FMatrix LocalToWorld,
const FBox LocalBoundingBox,
bool  bEmissiveLightSource 
)

◆ UpdateLumenScenePrimitives()

void UpdateLumenScenePrimitives ( FRHIGPUMask  GPUMask,
FScene Scene 
)

Variable Documentation

◆ CVarLumenSceneGlobalDFClipmapExtent

FAutoConsoleVariableRef CVarLumenSceneGlobalDFClipmapExtent(TEXT("r.LumenScene.GlobalSDF.ClipmapExtent"), GLumenSceneGlobalDFClipmapExtent, TEXT("Global Distance Field first clipmap extent when Lumen is enabled."), ECVF_RenderThreadSafe) ( TEXT("r.LumenScene.GlobalSDF.ClipmapExtent")  ,
GLumenSceneGlobalDFClipmapExtent  ,
TEXT("Global Distance Field first clipmap extent when Lumen is enabled." ,
ECVF_RenderThreadSafe   
)

◆ CVarLumenSceneGlobalDFResolution

FAutoConsoleVariableRef CVarLumenSceneGlobalDFResolution(TEXT("r.LumenScene.GlobalSDF.Resolution"), GLumenSceneGlobalDFResolution, TEXT("Global Distance Field resolution when Lumen is enabled."), ECVF_RenderThreadSafe) ( TEXT("r.LumenScene.GlobalSDF.Resolution")  ,
GLumenSceneGlobalDFResolution  ,
TEXT("Global Distance Field resolution when Lumen is enabled." ,
ECVF_RenderThreadSafe   
)

◆ CVarLumenSceneUpdateViewOrigin

TAutoConsoleVariable< int32 > CVarLumenSceneUpdateViewOrigin(TEXT("r.LumenScene.UpdateViewOrigin"), 1, TEXT("Whether to update view origin for voxel lighting and global distance field. Useful for debugging."), ECVF_RenderThreadSafe) ( TEXT("r.LumenScene.UpdateViewOrigin")  ,
,
TEXT("Whether to update view origin for voxel lighting and global distance field. Useful for debugging." ,
ECVF_RenderThreadSafe   
)

◆ GLumenSceneGlobalDFClipmapExtent

float GLumenSceneGlobalDFClipmapExtent = 2500.0f

◆ GLumenSceneGlobalDFResolution

int32 GLumenSceneGlobalDFResolution = 252