![]() |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include "RendererPrivate.h"#include "ScenePrivate.h"#include "SceneUtils.h"#include "PipelineStateCache.h"#include "ShaderParameterStruct.h"#include "PixelShaderUtils.h"#include "ReflectionEnvironment.h"#include "DistanceFieldAmbientOcclusion.h"#include "ScreenSpaceDenoise.h"#include "LumenRadianceCache.h"#include "LumenTracingUtils.h"#include "LumenReflections.h"Classes | |
| class | FMarkRadianceProbesUsedByGBufferCS |
| class | FIrradianceFieldGatherCS |
Namespaces | |
| namespace | LumenIrradianceFieldGather |
Functions | |
| FAutoConsoleVariableRef | CVarLumenIrradianceFieldGather (TEXT("r.Lumen.IrradianceFieldGather"), GLumenIrradianceFieldGather, TEXT("Whether to use the Irradiance Field Final Gather, an experimental opaque final gather that interpolates from pre-calculated irradiance in probes for cheaper, but lower quality GI."), ECVF_Scalability|ECVF_RenderThreadSafe) |
| LumenRadianceCache::FRadianceCacheInputs | LumenIrradianceFieldGather::SetupRadianceCacheInputs () |
| IMPLEMENT_GLOBAL_SHADER (FMarkRadianceProbesUsedByGBufferCS, "/Engine/Private/Lumen/LumenIrradianceFieldGather.usf", "MarkRadianceProbesUsedByGBufferCS", SF_Compute) | |
| IMPLEMENT_GLOBAL_SHADER (FIrradianceFieldGatherCS, "/Engine/Private/Lumen/LumenIrradianceFieldGather.usf", "IrradianceFieldGatherCS", SF_Compute) | |
| DECLARE_GPU_STAT (LumenIrradianceFieldGather) | |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldGather | ( | TEXT("r.Lumen.IrradianceFieldGather") | , |
| GLumenIrradianceFieldGather | , | ||
| TEXT("Whether to use the Irradiance Field Final Gather, an experimental opaque final gather that interpolates from pre-calculated irradiance in probes for cheaper, but lower quality GI.") | , | ||
| ECVF_Scalability| | ECVF_RenderThreadSafe | ||
| ) |
| DECLARE_GPU_STAT | ( | LumenIrradianceFieldGather | ) |
| IMPLEMENT_GLOBAL_SHADER | ( | FIrradianceFieldGatherCS | , |
| "/Engine/Private/Lumen/LumenIrradianceFieldGather.usf" | , | ||
| "IrradianceFieldGatherCS" | , | ||
| SF_Compute | |||
| ) |
| IMPLEMENT_GLOBAL_SHADER | ( | FMarkRadianceProbesUsedByGBufferCS | , |
| "/Engine/Private/Lumen/LumenIrradianceFieldGather.usf" | , | ||
| "MarkRadianceProbesUsedByGBufferCS" | , | ||
| SF_Compute | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldClipmapDistributionBase(TEXT("r.Lumen.IrradianceFieldGather.ClipmapDistributionBase"), GLumenIrradianceFieldClipmapDistributionBase, TEXT("Base of the Pow() that controls the size of each successive clipmap relative to the first."), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.ClipmapDistributionBase") | , |
| GLumenIrradianceFieldClipmapDistributionBase | , | ||
| TEXT("Base of the Pow() that controls the size of each successive clipmap relative to the first.") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldClipmapWorldExtent(TEXT("r.Lumen.IrradianceFieldGather.ClipmapWorldExtent"), GLumenIrradianceFieldClipmapWorldExtent, TEXT("World space extent of the first clipmap"), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.ClipmapWorldExtent") | , |
| GLumenIrradianceFieldClipmapWorldExtent | , | ||
| TEXT("World space extent of the first clipmap") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldNumClipmaps(TEXT("r.Lumen.IrradianceFieldGather.NumClipmaps"), GLumenIrradianceFieldNumClipmaps, TEXT("Number of radiance cache clipmaps."), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.NumClipmaps") | , |
| GLumenIrradianceFieldNumClipmaps | , | ||
| TEXT("Number of radiance cache clipmaps.") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldNumMipmaps(TEXT("r.Lumen.IrradianceFieldGather.NumMipmaps"), GLumenIrradianceFieldNumMipmaps, TEXT("Number of radiance cache mipmaps."), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.NumMipmaps") | , |
| GLumenIrradianceFieldNumMipmaps | , | ||
| TEXT("Number of radiance cache mipmaps.") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldProbeAtlasResolutionInProbes(TEXT("r.Lumen.IrradianceFieldGather.ProbeAtlasResolutionInProbes"), GLumenIrradianceFieldProbeAtlasResolutionInProbes, TEXT("Number of probes along one dimension of the probe atlas cache texture. This controls the memory usage of the cache. Overflow currently results in incorrect rendering."), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.ProbeAtlasResolutionInProbes") | , |
| GLumenIrradianceFieldProbeAtlasResolutionInProbes | , | ||
| TEXT("Number of probes along one dimension of the probe atlas cache texture. This controls the memory usage of the cache. Overflow currently results in incorrect rendering.") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldProbeIrradianceResolution(TEXT("r.Lumen.IrradianceFieldGather.IrradianceProbeResolution"), GLumenIrradianceFieldProbeIrradianceResolution, TEXT("Resolution of the probe's 2d irradiance layout."), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.IrradianceProbeResolution") | , |
| GLumenIrradianceFieldProbeIrradianceResolution | , | ||
| TEXT("Resolution of the probe's 2d irradiance layout.") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldProbeOcclusionNormalBias(TEXT("r.Lumen.IrradianceFieldGather.ProbeOcclusionNormalBias"), GLumenIrradianceFieldProbeOcclusionNormalBias, TEXT("Bias along the normal to reduce self-occlusion artifacts from Probe Occlusion"), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.ProbeOcclusionNormalBias") | , |
| GLumenIrradianceFieldProbeOcclusionNormalBias | , | ||
| TEXT("Bias along the normal to reduce self-occlusion artifacts from Probe Occlusion") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldProbeOcclusionResolution(TEXT("r.Lumen.IrradianceFieldGather.OcclusionProbeResolution"), GLumenIrradianceFieldProbeOcclusionResolution, TEXT("Resolution of the probe's 2d occlusion layout."), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.OcclusionProbeResolution") | , |
| GLumenIrradianceFieldProbeOcclusionResolution | , | ||
| TEXT("Resolution of the probe's 2d occlusion layout.") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldProbeOcclusionViewBias(TEXT("r.Lumen.IrradianceFieldGather.ProbeOcclusionViewBias"), GLumenIrradianceFieldProbeOcclusionViewBias, TEXT("Bias along the view direction to reduce self-occlusion artifacts from Probe Occlusion"), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.ProbeOcclusionViewBias") | , |
| GLumenIrradianceFieldProbeOcclusionViewBias | , | ||
| TEXT("Bias along the view direction to reduce self-occlusion artifacts from Probe Occlusion") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldProbeResolution(TEXT("r.Lumen.IrradianceFieldGather.ProbeResolution"), GLumenIrradianceFieldProbeResolution, TEXT("Resolution of the probe's 2d radiance layout. The number of rays traced for the probe will be ProbeResolution ^ 2"), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.ProbeResolution") | , |
| GLumenIrradianceFieldProbeResolution | , | ||
| TEXT("Resolution of the probe's 2d radiance layout. The number of rays traced for the probe will be ProbeResolution ^ 2") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldResolution(TEXT("r.Lumen.IrradianceFieldGather.GridResolution"), GLumenIrradianceFieldGridResolution, TEXT("Resolution of the probe placement grid within each clipmap"), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.GridResolution") | , |
| GLumenIrradianceFieldGridResolution | , | ||
| TEXT("Resolution of the probe placement grid within each clipmap") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| FAutoConsoleVariableRef CVarLumenIrradianceFieldStats(TEXT("r.Lumen.IrradianceFieldGather.RadianceCache.Stats"), GLumenIrradianceFieldStats, TEXT("GPU print out Radiance Cache update stats."), ECVF_RenderThreadSafe) | ( | TEXT("r.Lumen.IrradianceFieldGather.RadianceCache.Stats") | , |
| GLumenIrradianceFieldStats | , | ||
| TEXT("GPU print out Radiance Cache update stats.") | , | ||
| ECVF_RenderThreadSafe | |||
| ) |
| float GLumenIrradianceFieldClipmapDistributionBase = 2.0f |
| float GLumenIrradianceFieldClipmapWorldExtent = 5000.0f |
| int32 GLumenIrradianceFieldGather = 0 |
| int32 GLumenIrradianceFieldGridResolution = 64 |
| int32 GLumenIrradianceFieldNumClipmaps = 4 |
| int32 GLumenIrradianceFieldNumMipmaps = 1 |
| int32 GLumenIrradianceFieldProbeAtlasResolutionInProbes = 128 |
| int32 GLumenIrradianceFieldProbeIrradianceResolution = 6 |
| float GLumenIrradianceFieldProbeOcclusionNormalBias = 20 |
| int32 GLumenIrradianceFieldProbeOcclusionResolution = 16 |
| float GLumenIrradianceFieldProbeOcclusionViewBias = 20 |
| int32 GLumenIrradianceFieldProbeResolution = 16 |
| int32 GLumenIrradianceFieldStats = 0 |