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

Enumerations

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

Functions

uint32 GetStateFrameIndex (const FSceneViewState *ViewState)
 
bool UseShortRangeAmbientOcclusion (const FEngineShowFlags &ShowFlags)
 
uint32 GetRequestedIntegrateDownsampleFactor ()
 
uint32 GetIntegrateDownsampleFactor (const FViewInfo &View)
 
bool IsUsingDownsampledDepthAndNormal (const FViewInfo &View)
 
int32 GetTracingOctahedronResolution (const FViewInfo &View)
 
int32 GetGatherOctahedronResolution (int32 TracingOctahedronResolution)
 
int32 GetScreenDownsampleFactor (const FViewInfo &View, const FSceneTextures &SceneTextures)
 
bool UseProbeSpatialFilter ()
 
bool UseProbeTemporalFilter ()
 
int32 GetDiffuseIntegralMethod ()
 
EScreenProbeIrradianceFormat GetScreenProbeIrradianceFormat (const FEngineShowFlags &ShowFlags)
 
bool UseScreenProbeExtraAO ()
 
float GetScreenProbeFullResolutionJitterWidth (const FViewInfo &View)
 
bool UseWaveOps (EShaderPlatform ShaderPlatform)
 
FIntPoint GetNumSamplesPerUniformProbe2D (uint32 NumSamplesPerUniformProbe)
 
int32 IsProbeTracingResolutionSupportedForImportanceSampling (int32 TracingResolution)
 
bool UseImportanceSampling (const FViewInfo &View)
 
bool UseRadianceCache ()
 
bool UseRadianceCacheSkyVisibility ()
 
bool UseRejectBasedOnNormal ()
 
bool UseHitLighting (const FViewInfo &View, EDiffuseIndirectMethod DiffuseIndirectMethod)
 
void SetupTileClassifyParameters (const FViewInfo &View, LumenScreenProbeGather::FTileClassifyParameters &OutParameters)
 
FCompactedTraceParameters CompactTraces (FRDGBuilder &GraphBuilder, const FViewInfo &View, const FScreenProbeParameters &ScreenProbeParameters, bool bCullByDistanceFromCamera, float CompactionTracingEndDistanceFromCamera, float CompactionMaxTraceDistance, bool bCompactForSkyApply, ERDGPassFlags ComputePassFlags=ERDGPassFlags::Compute)
 
bool UseFarField (const FSceneViewFamily &ViewFamily)
 

Variables

const FIntPoint AdaptiveSamplesPerPassXY (2, 2)
 
constexpr uint32 IrradianceProbeRes = 6
 
constexpr uint32 IrradianceProbeWithBorderRes = (IrradianceProbeRes + 2)
 

Enumeration Type Documentation

◆ ERayTracingPass

Enumerator
Default 
FarField 
HitLighting 
MAX 

Function Documentation

◆ CompactTraces()

FCompactedTraceParameters LumenScreenProbeGather::CompactTraces ( FRDGBuilder GraphBuilder,
const FViewInfo View,
const FScreenProbeParameters ScreenProbeParameters,
bool  bCullByDistanceFromCamera,
float  CompactionTracingEndDistanceFromCamera,
float  CompactionMaxTraceDistance,
bool  bCompactForSkyApply,
ERDGPassFlags  ComputePassFlags = ERDGPassFlags::Compute 
)

◆ GetDiffuseIntegralMethod()

int32 LumenScreenProbeGather::GetDiffuseIntegralMethod ( )

◆ GetGatherOctahedronResolution()

int32 LumenScreenProbeGather::GetGatherOctahedronResolution ( int32  TracingOctahedronResolution)

◆ GetIntegrateDownsampleFactor()

uint32 LumenScreenProbeGather::GetIntegrateDownsampleFactor ( const FViewInfo View)

◆ GetNumSamplesPerUniformProbe2D()

FIntPoint LumenScreenProbeGather::GetNumSamplesPerUniformProbe2D ( uint32  NumSamplesPerUniformProbe)

◆ GetRequestedIntegrateDownsampleFactor()

uint32 LumenScreenProbeGather::GetRequestedIntegrateDownsampleFactor ( )

◆ GetScreenDownsampleFactor()

int32 LumenScreenProbeGather::GetScreenDownsampleFactor ( const FViewInfo View,
const FSceneTextures SceneTextures 
)

◆ GetScreenProbeFullResolutionJitterWidth()

float LumenScreenProbeGather::GetScreenProbeFullResolutionJitterWidth ( const FViewInfo View)

◆ GetScreenProbeIrradianceFormat()

EScreenProbeIrradianceFormat LumenScreenProbeGather::GetScreenProbeIrradianceFormat ( const FEngineShowFlags ShowFlags)

◆ GetStateFrameIndex()

uint32 LumenScreenProbeGather::GetStateFrameIndex ( const FSceneViewState ViewState)

◆ GetTracingOctahedronResolution()

int32 LumenScreenProbeGather::GetTracingOctahedronResolution ( const FViewInfo View)

◆ IsProbeTracingResolutionSupportedForImportanceSampling()

int32 LumenScreenProbeGather::IsProbeTracingResolutionSupportedForImportanceSampling ( int32  TracingResolution)
extern

◆ IsUsingDownsampledDepthAndNormal()

bool LumenScreenProbeGather::IsUsingDownsampledDepthAndNormal ( const FViewInfo View)

◆ SetupTileClassifyParameters()

void LumenScreenProbeGather::SetupTileClassifyParameters ( const FViewInfo View,
LumenScreenProbeGather::FTileClassifyParameters &  OutParameters 
)

◆ UseFarField()

bool LumenScreenProbeGather::UseFarField ( const FSceneViewFamily ViewFamily)

◆ UseHitLighting()

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

◆ UseImportanceSampling()

bool LumenScreenProbeGather::UseImportanceSampling ( const FViewInfo View)
extern

◆ UseProbeSpatialFilter()

bool LumenScreenProbeGather::UseProbeSpatialFilter ( )

◆ UseProbeTemporalFilter()

bool LumenScreenProbeGather::UseProbeTemporalFilter ( )

◆ UseRadianceCache()

bool LumenScreenProbeGather::UseRadianceCache ( )
extern

◆ UseRadianceCacheSkyVisibility()

bool LumenScreenProbeGather::UseRadianceCacheSkyVisibility ( )

◆ UseRejectBasedOnNormal()

bool LumenScreenProbeGather::UseRejectBasedOnNormal ( )

◆ UseScreenProbeExtraAO()

bool LumenScreenProbeGather::UseScreenProbeExtraAO ( )

◆ UseShortRangeAmbientOcclusion()

bool LumenScreenProbeGather::UseShortRangeAmbientOcclusion ( const FEngineShowFlags ShowFlags)

◆ UseWaveOps()

bool LumenScreenProbeGather::UseWaveOps ( EShaderPlatform  ShaderPlatform)

Variable Documentation

◆ AdaptiveSamplesPerPassXY

const FIntPoint LumenScreenProbeGather::AdaptiveSamplesPerPassXY(2, 2) ( ,
 
)

◆ IrradianceProbeRes

constexpr uint32 LumenScreenProbeGather::IrradianceProbeRes = 6
constexpr

◆ IrradianceProbeWithBorderRes

constexpr uint32 LumenScreenProbeGather::IrradianceProbeWithBorderRes = (IrradianceProbeRes + 2)
constexpr