UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
LumenScreenProbeGather.h File Reference
#include "CoreTypes.h"
#include "BlueNoise.h"
#include "LumenTracingUtils.h"
#include "ShaderParameterMacros.h"

Go to the source code of this file.

Namespaces

namespace  Lumen
 
namespace  LumenRadianceCache
 
namespace  LumenScreenProbeGather
 
namespace  LumenScreenProbeGatherRadianceCache
 

Enumerations

enum class  EScreenProbeIrradianceFormat : uint8 { SH3 , Octahedral , MAX }
 
enum class  EScreenProbeIndirectArgs {
  GroupPerProbe , ThreadPerProbe , TraceCompaction , ThreadPerTrace ,
  ThreadPerGather , ThreadPerGatherWithBorder , Max
}
 
enum class  EScreenProbeIntegrateTileClassification { SimpleDiffuse , SupportImportanceSampleBRDF , SupportAll , Num }
 

Functions

int32 LumenScreenProbeGather::GetTracingOctahedronResolution (const FViewInfo &View)
 
int32 LumenScreenProbeGather::IsProbeTracingResolutionSupportedForImportanceSampling (int32 TracingResolution)
 
bool LumenScreenProbeGather::UseImportanceSampling (const FViewInfo &View)
 
bool LumenScreenProbeGather::UseProbeSpatialFilter ()
 
bool LumenScreenProbeGather::UseProbeTemporalFilter ()
 
bool LumenScreenProbeGather::UseRadianceCache ()
 
bool LumenScreenProbeGather::UseRadianceCacheSkyVisibility ()
 
bool LumenScreenProbeGather::UseRejectBasedOnNormal ()
 
EScreenProbeIrradianceFormat LumenScreenProbeGather::GetScreenProbeIrradianceFormat (const FEngineShowFlags &ShowFlags)
 
bool LumenScreenProbeGather::UseScreenProbeExtraAO ()
 
bool LumenScreenProbeGather::UseHitLighting (const FViewInfo &View, EDiffuseIndirectMethod DiffuseIndirectMethod)
 
uint32 LumenScreenProbeGather::GetStateFrameIndex (const FSceneViewState *ViewState)
 
uint32 LumenScreenProbeGather::GetRequestedIntegrateDownsampleFactor ()
 
void LumenScreenProbeGather::SetupTileClassifyParameters (const FViewInfo &View, LumenScreenProbeGather::FTileClassifyParameters &OutParameters)
 
bool LumenScreenProbeGather::IsUsingDownsampledDepthAndNormal (const FViewInfo &View)
 
FCompactedTraceParameters LumenScreenProbeGather::CompactTraces (FRDGBuilder &GraphBuilder, const FViewInfo &View, const FScreenProbeParameters &ScreenProbeParameters, bool bCullByDistanceFromCamera, float CompactionTracingEndDistanceFromCamera, float CompactionMaxTraceDistance, bool bCompactForSkyApply, ERDGPassFlags ComputePassFlags=ERDGPassFlags::Compute)
 
void GenerateBRDF_PDF (FRDGBuilder &GraphBuilder, const FViewInfo &View, const FSceneTextures &SceneTextures, FRDGTextureRef &BRDFProbabilityDensityFunction, FRDGBufferSRVRef &BRDFProbabilityDensityFunctionSH, FScreenProbeParameters &ScreenProbeParameters, ERDGPassFlags ComputePassFlags)
 
void GenerateImportanceSamplingRays (FRDGBuilder &GraphBuilder, const FViewInfo &View, const FSceneTextures &SceneTextures, const LumenRadianceCache::FRadianceCacheInterpolationParameters &RadianceCacheParameters, FRDGTextureRef BRDFProbabilityDensityFunction, FRDGBufferSRVRef BRDFProbabilityDensityFunctionSH, FScreenProbeParameters &ScreenProbeParameters, ERDGPassFlags ComputePassFlags)
 
void TraceScreenProbes (FRDGBuilder &GraphBuilder, const FScene *Scene, const FViewInfo &View, const FLumenSceneFrameTemporaries &FrameTemporaries, bool bTraceMeshObjects, const FSceneTextures &SceneTextures, FRDGTextureRef LightingChannelsTexture, const LumenRadianceCache::FRadianceCacheInterpolationParameters &RadianceCacheParameters, FScreenProbeParameters &ScreenProbeParameters, FLumenMeshSDFGridParameters &MeshSDFGridParameters, ERDGPassFlags ComputePassFlags)
 
void RenderHardwareRayTracingScreenProbe (FRDGBuilder &GraphBuilder, const FScene *Scene, const FSceneTextureParameters &SceneTextures, FScreenProbeParameters &CommonDiffuseParameters, const FViewInfo &View, const FLumenCardTracingParameters &TracingParameters, FLumenIndirectTracingParameters &DiffuseTracingParameters, const LumenRadianceCache::FRadianceCacheInterpolationParameters &RadianceCacheParameters, ERDGPassFlags ComputePassFlags)
 
void RenderHardwareRayTracingShortRangeAO (FRDGBuilder &GraphBuilder, const FScene *Scene, const FSceneTextures &SceneTextures, const FSceneTextureParameters &SceneTextureParameters, const FLumenSceneFrameTemporaries &FrameTemporaries, const FLumenScreenSpaceBentNormalParameters &BentNormalParameters, const FBlueNoise &BlueNoise, float MaxScreenTraceFraction, const FViewInfo &View, FRDGTextureRef ShortRangeAO, uint32 NumPixelRays)
 
void FilterScreenProbes (FRDGBuilder &GraphBuilder, const FViewInfo &View, const FSceneTextures &SceneTextures, const FScreenProbeParameters &ScreenProbeParameters, FScreenProbeGatherParameters &GatherParameters, ERDGPassFlags ComputePassFlags)
 
FLumenScreenSpaceBentNormalParameters ComputeScreenSpaceShortRangeAO (FRDGBuilder &GraphBuilder, const FScene *Scene, const FViewInfo &View, const FLumenSceneFrameTemporaries &FrameTemporaries, const FSceneTextures &SceneTextures, FRDGTextureRef LightingChannelsTexture, const FBlueNoise &BlueNoise, FVector2f MaxScreenTraceFraction, float ScreenTraceNoFallbackThicknessScale, ERDGPassFlags ComputePassFlags)
 
LumenRadianceCache::FRadianceCacheInputs LumenScreenProbeGatherRadianceCache::SetupRadianceCacheInputs (const FViewInfo &View)
 
bool CanMaterialRenderInLumenTranslucencyRadianceCacheMarkPass (const FScene &Scene, const FSceneViewFamily &ViewFamily, const FPrimitiveSceneProxy &PrimitiveSceneProxy, const FMaterial &Material)
 
bool CanMaterialRenderInLumenFrontLayerTranslucencyGBufferPass (const FScene &Scene, const FSceneViewFamily &ViewFamily, const FPrimitiveSceneProxy &PrimitiveSceneProxy, const FMaterial &Material)
 
void LumenTranslucencyReflectionsMarkUsedProbes (FRDGBuilder &GraphBuilder, const FSceneRenderer &SceneRenderer, FViewInfo &View, const FSceneTextures &SceneTextures, const LumenRadianceCache::FRadianceCacheMarkParameters *RadianceCacheMarkParameters)
 

Variables

int32 GLumenScreenProbeGatherNumMips
 
constexpr uint32 LumenScreenProbeGather::IrradianceProbeRes = 6
 
constexpr uint32 LumenScreenProbeGather::IrradianceProbeWithBorderRes = (IrradianceProbeRes + 2)
 

Enumeration Type Documentation

◆ EScreenProbeIndirectArgs

Enumerator
GroupPerProbe 
ThreadPerProbe 
TraceCompaction 
ThreadPerTrace 
ThreadPerGather 
ThreadPerGatherWithBorder 
Max 

◆ EScreenProbeIntegrateTileClassification

Enumerator
SimpleDiffuse 
SupportImportanceSampleBRDF 
SupportAll 
Num 

◆ EScreenProbeIrradianceFormat

Enumerator
SH3 
Octahedral 
MAX 

Function Documentation

◆ CanMaterialRenderInLumenFrontLayerTranslucencyGBufferPass()

bool CanMaterialRenderInLumenFrontLayerTranslucencyGBufferPass ( const FScene Scene,
const FSceneViewFamily ViewFamily,
const FPrimitiveSceneProxy PrimitiveSceneProxy,
const FMaterial Material 
)
extern

◆ CanMaterialRenderInLumenTranslucencyRadianceCacheMarkPass()

bool CanMaterialRenderInLumenTranslucencyRadianceCacheMarkPass ( const FScene Scene,
const FSceneViewFamily ViewFamily,
const FPrimitiveSceneProxy PrimitiveSceneProxy,
const FMaterial Material 
)
extern

◆ ComputeScreenSpaceShortRangeAO()

FLumenScreenSpaceBentNormalParameters ComputeScreenSpaceShortRangeAO ( FRDGBuilder GraphBuilder,
const FScene Scene,
const FViewInfo View,
const FLumenSceneFrameTemporaries FrameTemporaries,
const FSceneTextures SceneTextures,
FRDGTextureRef  LightingChannelsTexture,
const FBlueNoise BlueNoise,
FVector2f  MaxScreenTraceFraction,
float  ScreenTraceNoFallbackThicknessScale,
ERDGPassFlags  ComputePassFlags 
)
extern

◆ FilterScreenProbes()

void FilterScreenProbes ( FRDGBuilder GraphBuilder,
const FViewInfo View,
const FSceneTextures SceneTextures,
const FScreenProbeParameters ScreenProbeParameters,
FScreenProbeGatherParameters GatherParameters,
ERDGPassFlags  ComputePassFlags 
)
extern

◆ GenerateBRDF_PDF()

void GenerateBRDF_PDF ( FRDGBuilder GraphBuilder,
const FViewInfo View,
const FSceneTextures SceneTextures,
FRDGTextureRef BRDFProbabilityDensityFunction,
FRDGBufferSRVRef BRDFProbabilityDensityFunctionSH,
FScreenProbeParameters ScreenProbeParameters,
ERDGPassFlags  ComputePassFlags 
)
extern

◆ GenerateImportanceSamplingRays()

void GenerateImportanceSamplingRays ( FRDGBuilder GraphBuilder,
const FViewInfo View,
const FSceneTextures SceneTextures,
const LumenRadianceCache::FRadianceCacheInterpolationParameters RadianceCacheParameters,
FRDGTextureRef  BRDFProbabilityDensityFunction,
FRDGBufferSRVRef  BRDFProbabilityDensityFunctionSH,
FScreenProbeParameters ScreenProbeParameters,
ERDGPassFlags  ComputePassFlags 
)
extern

◆ LumenTranslucencyReflectionsMarkUsedProbes()

void LumenTranslucencyReflectionsMarkUsedProbes ( FRDGBuilder GraphBuilder,
const FSceneRenderer SceneRenderer,
FViewInfo View,
const FSceneTextures SceneTextures,
const LumenRadianceCache::FRadianceCacheMarkParameters RadianceCacheMarkParameters 
)
extern

◆ RenderHardwareRayTracingScreenProbe()

void RenderHardwareRayTracingScreenProbe ( FRDGBuilder GraphBuilder,
const FScene Scene,
const FSceneTextureParameters SceneTextures,
FScreenProbeParameters CommonDiffuseParameters,
const FViewInfo View,
const FLumenCardTracingParameters TracingParameters,
FLumenIndirectTracingParameters DiffuseTracingParameters,
const LumenRadianceCache::FRadianceCacheInterpolationParameters RadianceCacheParameters,
ERDGPassFlags  ComputePassFlags 
)

◆ RenderHardwareRayTracingShortRangeAO()

void RenderHardwareRayTracingShortRangeAO ( FRDGBuilder GraphBuilder,
const FScene Scene,
const FSceneTextures SceneTextures,
const FSceneTextureParameters SceneTextureParameters,
const FLumenSceneFrameTemporaries FrameTemporaries,
const FLumenScreenSpaceBentNormalParameters BentNormalParameters,
const FBlueNoise BlueNoise,
float  MaxScreenTraceFraction,
const FViewInfo View,
FRDGTextureRef  ShortRangeAO,
uint32  NumPixelRays 
)
extern

◆ TraceScreenProbes()

void TraceScreenProbes ( FRDGBuilder GraphBuilder,
const FScene Scene,
const FViewInfo View,
const FLumenSceneFrameTemporaries FrameTemporaries,
bool  bTraceMeshObjects,
const FSceneTextures SceneTextures,
FRDGTextureRef  LightingChannelsTexture,
const LumenRadianceCache::FRadianceCacheInterpolationParameters RadianceCacheParameters,
FScreenProbeParameters ScreenProbeParameters,
FLumenMeshSDFGridParameters MeshSDFGridParameters,
ERDGPassFlags  ComputePassFlags 
)
extern

Variable Documentation

◆ GLumenScreenProbeGatherNumMips

int32 GLumenScreenProbeGatherNumMips
extern