UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
LumenReflections Namespace Reference

Enumerations

enum class  ERayTracingPass { Default , FarField , HitLighting , MAX }
 
enum  ETraceCompactionMode { Default , FarField , HitLighting , MAX }
 

Functions

int32 GetMaxFramesAccumulated ()
 
void ModifyCompilationEnvironment (const FGlobalShaderPermutationParameters &Parameters, FShaderCompilerEnvironment &OutEnvironment)
 
float GetDenoiserOneOverTonemapRange ()
 
void SetupCompositeParameters (const FViewInfo &View, EReflectionsMethod ReflectionsMethod, LumenReflections::FCompositeParameters &OutParameters)
 
bool UseAsyncCompute (const FViewFamilyInfo &ViewFamily, EDiffuseIndirectMethod DiffuseIndirectMethod, EReflectionsMethod ReflectionsMethod)
 
bool UseFarField (const FSceneViewFamily &ViewFamily)
 
bool UseHitLighting (const FViewInfo &View, EDiffuseIndirectMethod DiffuseIndirectMethod)
 
bool UseTranslucentRayTracing (const FViewInfo &View)
 
bool IsHitLightingForceEnabled (const FViewInfo &View, EDiffuseIndirectMethod DiffuseIndirectMethod)
 
bool UseSurfaceCacheFeedback ()
 
bool UseScreenTraces (const FViewInfo &View)
 
bool UseDistantScreenTraces (const FViewInfo &View, bool bUseFarField, bool bUseRadianceCache)
 
float GetDistantScreenTraceStepOffsetBias ()
 
bool UseRadianceCache ()
 
bool UseRadianceCacheSkyVisibility ()
 
bool UseRadianceCacheStochasticInterpolation ()
 
float GetSampleSceneColorDepthTreshold ()
 
float GetSampleSceneColorNormalTreshold ()
 
float GetFarFieldSampleSceneColorDepthTreshold ()
 
float GetFarFieldSampleSceneColorNormalTreshold ()
 
uint32 GetMaxReflectionBounces (const FViewInfo &View)
 
uint32 GetMaxRefractionBounces (const FViewInfo &View)
 
FCompactedReflectionTraceParameters CompactTraces (FRDGBuilder &GraphBuilder, const FViewInfo &View, const FLumenCardTracingParameters &TracingParameters, const FLumenReflectionTracingParameters &ReflectionTracingParameters, const FLumenReflectionTileParameters &ReflectionTileParameters, bool bCullByDistanceFromCamera, float CompactionTracingEndDistanceFromCamera, float CompactionMaxTraceDistance, ERDGPassFlags ComputePassFlags, ETraceCompactionMode TraceCompactionMode=ETraceCompactionMode::Default, bool bSortByMaterial=false)
 

Enumeration Type Documentation

◆ ERayTracingPass

Enumerator
Default 
FarField 
HitLighting 
MAX 

◆ ETraceCompactionMode

Enumerator
Default 
FarField 
HitLighting 
MAX 

Function Documentation

◆ CompactTraces()

FCompactedReflectionTraceParameters LumenReflections::CompactTraces ( FRDGBuilder GraphBuilder,
const FViewInfo View,
const FLumenCardTracingParameters TracingParameters,
const FLumenReflectionTracingParameters ReflectionTracingParameters,
const FLumenReflectionTileParameters ReflectionTileParameters,
bool  bCullByDistanceFromCamera,
float  CompactionTracingEndDistanceFromCamera,
float  CompactionMaxTraceDistance,
ERDGPassFlags  ComputePassFlags,
ETraceCompactionMode  TraceCompactionMode = ETraceCompactionMode::Default,
bool  bSortByMaterial = false 
)

◆ GetDenoiserOneOverTonemapRange()

float LumenReflections::GetDenoiserOneOverTonemapRange ( )

◆ GetDistantScreenTraceStepOffsetBias()

float LumenReflections::GetDistantScreenTraceStepOffsetBias ( )

◆ GetFarFieldSampleSceneColorDepthTreshold()

float LumenReflections::GetFarFieldSampleSceneColorDepthTreshold ( )

◆ GetFarFieldSampleSceneColorNormalTreshold()

float LumenReflections::GetFarFieldSampleSceneColorNormalTreshold ( )

◆ GetMaxFramesAccumulated()

int32 LumenReflections::GetMaxFramesAccumulated ( )

◆ GetMaxReflectionBounces()

uint32 LumenReflections::GetMaxReflectionBounces ( const FViewInfo View)

◆ GetMaxRefractionBounces()

uint32 LumenReflections::GetMaxRefractionBounces ( const FViewInfo View)

◆ GetSampleSceneColorDepthTreshold()

float LumenReflections::GetSampleSceneColorDepthTreshold ( )

◆ GetSampleSceneColorNormalTreshold()

float LumenReflections::GetSampleSceneColorNormalTreshold ( )

◆ IsHitLightingForceEnabled()

bool LumenReflections::IsHitLightingForceEnabled ( const FViewInfo View,
EDiffuseIndirectMethod  DiffuseIndirectMethod 
)

◆ ModifyCompilationEnvironment()

void LumenReflections::ModifyCompilationEnvironment ( const FGlobalShaderPermutationParameters Parameters,
FShaderCompilerEnvironment OutEnvironment 
)

◆ SetupCompositeParameters()

void LumenReflections::SetupCompositeParameters ( const FViewInfo View,
EReflectionsMethod  ReflectionsMethod,
LumenReflections::FCompositeParameters &  OutParameters 
)

◆ UseAsyncCompute()

bool LumenReflections::UseAsyncCompute ( const FViewFamilyInfo ViewFamily,
EDiffuseIndirectMethod  DiffuseIndirectMethod,
EReflectionsMethod  ReflectionsMethod 
)

◆ UseDistantScreenTraces()

bool LumenReflections::UseDistantScreenTraces ( const FViewInfo View,
bool  bUseFarField,
bool  bUseRadianceCache 
)

◆ UseFarField()

bool LumenReflections::UseFarField ( const FSceneViewFamily ViewFamily)

◆ UseHitLighting()

bool LumenReflections::UseHitLighting ( const FViewInfo View,
EDiffuseIndirectMethod  DiffuseIndirectMethod 
)

◆ UseRadianceCache()

bool LumenReflections::UseRadianceCache ( )

◆ UseRadianceCacheSkyVisibility()

bool LumenReflections::UseRadianceCacheSkyVisibility ( )

◆ UseRadianceCacheStochasticInterpolation()

bool LumenReflections::UseRadianceCacheStochasticInterpolation ( )

◆ UseScreenTraces()

bool LumenReflections::UseScreenTraces ( const FViewInfo View)

◆ UseSurfaceCacheFeedback()

bool LumenReflections::UseSurfaceCacheFeedback ( )

◆ UseTranslucentRayTracing()

bool LumenReflections::UseTranslucentRayTracing ( const FViewInfo View)