UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Lumen.h File Reference
#include "EngineDefines.h"
#include "HAL/LowLevelMemTracker.h"
#include "Math/Vector.h"
#include "RHIShaderPlatform.h"

Go to the source code of this file.

Namespaces

namespace  Lumen
 

Enumerations

enum class  Lumen::ETracingPermutation { Lumen::Cards , Lumen::VoxelsAfterCards , Lumen::Voxels , Lumen::MAX }
 
enum class  Lumen::ESurfaceCacheSampling { Lumen::AlwaysResidentPagesWithoutFeedback , Lumen::AlwaysResidentPages , Lumen::HighResPages }
 

Functions

bool ShouldRenderLumenDiffuseGI (const FScene *Scene, const FSceneView &View, bool bSkipTracingDataCheck=false, bool bSkipProjectCheck=false)
 
bool ShouldRenderLumenReflections (const FSceneView &View, bool bSkipTracingDataCheck=false, bool bSkipProjectCheck=false, bool bIncludeStandalone=true)
 
bool ShouldRenderLumenReflectionsWater (const FViewInfo &View, bool bSkipTracingDataCheck=false, bool bSkipProjectCheck=false)
 
bool ShouldRenderLumenDirectLighting (const FScene *Scene, const FSceneView &View)
 
bool ShouldRenderAOWithLumenGI ()
 
bool ShouldUseStereoLumenOptimizations ()
 
double BoxSurfaceArea (FVector Extent)
 
void Lumen::DebugResetSurfaceCache ()
 
float Lumen::GetMaxTraceDistance (const FViewInfo &View)
 
bool Lumen::IsLumenFeatureAllowedForView (const FScene *Scene, const FSceneView &View, bool bSkipTracingDataCheck=false, bool bSkipProjectCheck=false)
 
bool Lumen::ShouldVisualizeScene (const FEngineShowFlags &ShowFlags)
 
bool Lumen::ShouldVisualizeHardwareRayTracing (const FSceneViewFamily &ViewFamily)
 
bool Lumen::ShouldHandleSkyLight (const FScene *Scene, const FSceneViewFamily &ViewFamily)
 
bool Lumen::ShouldUpdateLumenSceneViewOrigin ()
 
FVector Lumen::GetLumenSceneViewOrigin (const FViewInfo &View, int32 ClipmapIndex)
 
int32 Lumen::GetGlobalDFResolution ()
 
float Lumen::GetGlobalDFClipmapExtent (int32 ClipmapIndex)
 
int32 Lumen::GetNumGlobalDFClipmaps (const FSceneView &View)
 
bool Lumen::UseAsyncCompute (const FViewFamilyInfo &ViewFamily)
 
bool Lumen::UseWaveOps (EShaderPlatform ShaderPlatform)
 
bool Lumen::UseThreadGroupSize32 ()
 
EPixelFormat Lumen::GetLightingDataFormat ()
 
FVector3f Lumen::GetLightingQuantizationError ()
 
float Lumen::GetCachedLightingPreExposure ()
 
bool Lumen::IsSurfaceCacheFrozen ()
 
bool Lumen::IsSurfaceCacheUpdateFrameFrozen ()
 
bool Lumen::IsSoftwareRayTracingSupported ()
 
bool Lumen::UseMeshSDFTracing (const FEngineShowFlags &EngineShowFlags)
 
bool Lumen::UseGlobalSDFTracing (const FEngineShowFlags &EngineShowFlags)
 
bool Lumen::UseGlobalSDFSimpleCoverageBasedExpand ()
 
bool Lumen::UseGlobalSDFObjectGrid (const FSceneViewFamily &ViewFamily)
 
bool Lumen::UseHeightfieldTracing (const FSceneViewFamily &ViewFamily, const FLumenSceneData &LumenSceneData)
 
bool Lumen::UseHeightfieldTracingForVoxelLighting (const FLumenSceneData &LumenSceneData)
 
int32 Lumen::GetHeightfieldMaxTracingSteps ()
 
bool Lumen::IsUsingGlobalSDF (const FSceneViewFamily &ViewFamily)
 
bool Lumen::IsUsingDistanceFieldRepresentationBit (const FViewInfo &View)
 
bool Lumen::AnyLumenHardwareRayTracingPassEnabled (const FScene *Scene, const FViewInfo &View)
 
bool Lumen::AnyLumenHardwareInlineRayTracingPassEnabled (const FScene *Scene, const FViewInfo &View)
 
bool Lumen::UseHardwareRayTracing (const FSceneViewFamily &ViewFamily)
 
bool Lumen::UseHardwareRayTracedSceneLighting (const FSceneViewFamily &ViewFamily)
 
bool Lumen::UseHardwareRayTracedDirectLighting (const FSceneViewFamily &ViewFamily)
 
bool Lumen::UseHardwareRayTracedReflections (const FSceneViewFamily &ViewFamily)
 
bool Lumen::UseReSTIRGather (const FSceneViewFamily &ViewFamily, EShaderPlatform ShaderPlatform)
 
bool Lumen::UseHardwareRayTracedScreenProbeGather (const FSceneViewFamily &ViewFamily)
 
bool Lumen::UseHardwareRayTracedShortRangeAO (const FSceneViewFamily &ViewFamily)
 
bool Lumen::UseHardwareRayTracedRadianceCache (const FSceneViewFamily &ViewFamily)
 
bool Lumen::UseHardwareRayTracedRadiosity (const FSceneViewFamily &ViewFamily)
 
bool Lumen::UseHardwareRayTracedVisualize (const FSceneViewFamily &ViewFamily)
 
bool Lumen::IsUsingRayTracingLightingGrid (const FSceneViewFamily &ViewFamily, const FViewInfo &View, EDiffuseIndirectMethod DiffuseIndirectMethod)
 
bool Lumen::ShouldRenderRadiosityHardwareRayTracing (const FSceneViewFamily &ViewFamily)
 
bool Lumen::ShouldPrecachePSOs (EShaderPlatform Platform)
 
bool Lumen::UseHardwareInlineRayTracing (const FSceneViewFamily &ViewFamily)
 
float Lumen::GetHardwareRayTracingPullbackBias ()
 
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)
 
uint32 Lumen::GetMeshCardDistanceBin (float Distance)
 
float Lumen::GetHeightfieldReceiverBias ()
 
void Lumen::Shutdown ()
 
bool Lumen::WriteWarnings (const FScene *Scene, const FEngineShowFlags &ShowFlags, const TArray< FViewInfo > &Views, FScreenMessageWriter *Writer)
 
bool Lumen::SupportsMultipleClosureEvaluation (EShaderPlatform ShaderPlatform)
 
bool Lumen::SupportsMultipleClosureEvaluation (const FViewInfo &View)
 
 LLM_DECLARE_TAG (Lumen)
 

Variables

constexpr uint32 Lumen::PhysicalPageSize = 128
 
constexpr uint32 Lumen::VirtualPageSize = PhysicalPageSize - 1
 
constexpr uint32 Lumen::MinCardResolution = 8
 
constexpr uint32 Lumen::MinResLevel = 3
 
constexpr uint32 Lumen::MaxResLevel = 11
 
constexpr uint32 Lumen::SubAllocationResLevel = 7
 
constexpr uint32 Lumen::NumResLevels = MaxResLevel - MinResLevel + 1
 
constexpr uint32 Lumen::CardTileSize = 8
 
constexpr uint32 Lumen::CardTileShadowDownsampleFactorDwords = 8
 
constexpr uint32 Lumen::NumDistanceBuckets = 16
 
constexpr float Lumen::MaxTraceDistance = 0.5f * UE_OLD_WORLD_MAX
 
int32 GLumenFastCameraMode
 

Function Documentation

◆ BoxSurfaceArea()

double BoxSurfaceArea ( FVector  Extent)
inline

◆ LLM_DECLARE_TAG()

LLM_DECLARE_TAG ( Lumen  )

◆ ShouldRenderAOWithLumenGI()

bool ShouldRenderAOWithLumenGI ( )
extern

◆ ShouldRenderLumenDiffuseGI()

bool ShouldRenderLumenDiffuseGI ( const FScene Scene,
const FSceneView View,
bool  bSkipTracingDataCheck = false,
bool  bSkipProjectCheck = false 
)
extern

◆ ShouldRenderLumenDirectLighting()

bool ShouldRenderLumenDirectLighting ( const FScene Scene,
const FSceneView View 
)
extern

◆ ShouldRenderLumenReflections()

bool ShouldRenderLumenReflections ( const FSceneView View,
bool  bSkipTracingDataCheck = false,
bool  bSkipProjectCheck = false,
bool  bIncludeStandalone = true 
)
extern

◆ ShouldRenderLumenReflectionsWater()

bool ShouldRenderLumenReflectionsWater ( const FViewInfo View,
bool  bSkipTracingDataCheck = false,
bool  bSkipProjectCheck = false 
)
extern

◆ ShouldUseStereoLumenOptimizations()

bool ShouldUseStereoLumenOptimizations ( )
extern

Variable Documentation

◆ GLumenFastCameraMode

int32 GLumenFastCameraMode
extern