UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FDefaultScreenSpaceDenoiser Class Reference
+ Inheritance diagram for FDefaultScreenSpaceDenoiser:

Public Member Functions

const TCHARGetDebugName () const override
 
virtual EShadowRequirements GetShadowRequirements (const FViewInfo &View, const FLightSceneInfo &LightSceneInfo, const FShadowRayTracingConfig &RayTracingConfig) const override
 
virtual void DenoiseShadowVisibilityMasks (FRDGBuilder &GraphBuilder, const FViewInfo &View, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const TStaticArray< FShadowVisibilityParameters, IScreenSpaceDenoiser::kMaxBatchSize > &InputParameters, const int32 InputParameterCount, TStaticArray< FShadowVisibilityOutputs, IScreenSpaceDenoiser::kMaxBatchSize > &Outputs) const
 
FPolychromaticPenumbraOutputs DenoisePolychromaticPenumbraHarmonics (FRDGBuilder &GraphBuilder, const FViewInfo &View, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const FPolychromaticPenumbraHarmonics &Inputs) const override
 
FReflectionsOutputs DenoiseReflections (FRDGBuilder &GraphBuilder, const FViewInfo &View, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const FReflectionsInputs &ReflectionInputs, const FReflectionsRayTracingConfig RayTracingConfig) const override
 
FReflectionsOutputs DenoiseWaterReflections (FRDGBuilder &GraphBuilder, const FViewInfo &View, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const FReflectionsInputs &ReflectionInputs, const FReflectionsRayTracingConfig RayTracingConfig) const override
 
FAmbientOcclusionOutputs DenoiseAmbientOcclusion (FRDGBuilder &GraphBuilder, const FViewInfo &View, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const FAmbientOcclusionInputs &ReflectionInputs, const FAmbientOcclusionRayTracingConfig RayTracingConfig) const override
 
FSSDSignalTextures DenoiseDiffuseIndirect (FRDGBuilder &GraphBuilder, const FViewInfo &View, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const FDiffuseIndirectInputs &Inputs, const FAmbientOcclusionRayTracingConfig Config) const override
 
FDiffuseIndirectOutputs DenoiseSkyLight (FRDGBuilder &GraphBuilder, const FViewInfo &View, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const FDiffuseIndirectInputs &Inputs, const FAmbientOcclusionRayTracingConfig Config) const override
 
FSSDSignalTextures DenoiseDiffuseIndirectHarmonic (FRDGBuilder &GraphBuilder, const FViewInfo &View, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const FDiffuseIndirectHarmonic &Inputs, const HybridIndirectLighting::FCommonParameters &CommonDiffuseParameters) const override
 
bool SupportsScreenSpaceDiffuseIndirectDenoiser (EShaderPlatform Platform) const override
 
FSSDSignalTextures DenoiseScreenSpaceDiffuseIndirect (FRDGBuilder &GraphBuilder, const FViewInfo &View, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const FDiffuseIndirectInputs &Inputs, const FAmbientOcclusionRayTracingConfig Config) const override
 
- Public Member Functions inherited from IScreenSpaceDenoiser
virtual ~IScreenSpaceDenoiser ()
 

Additional Inherited Members

- Public Types inherited from IScreenSpaceDenoiser
enum class  EMode { Disabled , DefaultDenoiser , ThirdPartyDenoiser }
 
enum class  EShadowRequirements { Bailout , PenumbraAndAvgOccluder , PenumbraAndClosestOccluder }
 
- Static Public Member Functions inherited from IScreenSpaceDenoiser
static RENDERER_API FHarmonicTextures CreateHarmonicTextures (FRDGBuilder &GraphBuilder, FIntPoint Extent, const TCHAR *DebugName)
 
static RENDERER_API FHarmonicUAVs CreateUAVs (FRDGBuilder &GraphBuilder, const FHarmonicTextures &Textures)
 
static RENDERER_API FDiffuseIndirectHarmonicUAVs CreateUAVs (FRDGBuilder &GraphBuilder, const FDiffuseIndirectHarmonic &Textures)
 
static RENDERER_API FSSDSignalTextures DenoiseIndirectProbeHierarchy (FRDGBuilder &GraphBuilder, const FViewInfo &View, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const FSSDSignalTextures &InputSignal, FRDGTextureRef CompressedDepthTexture, FRDGTextureRef CompressedShadingModelTexture)
 
static RENDERER_API const IScreenSpaceDenoiserGetDefaultDenoiser ()
 
static RENDERER_API EMode GetDenoiserMode (const TAutoConsoleVariable< int32 > &CVar)
 
static RENDERER_API FDiffuseIndirectOutputs DenoiseSkyLight (FRDGBuilder &GraphBuilder, TConstArrayView< FViewInfo > Views, FPreviousViewInfo *PreviousViewInfos, const FSceneTextureParameters &SceneTextures, const FDiffuseIndirectInputs &Inputs, const FAmbientOcclusionRayTracingConfig Config)
 
- Static Public Attributes inherited from IScreenSpaceDenoiser
static const int32 kMaxBatchSize = 4
 
static constexpr int32 kMultiPolychromaticPenumbraHarmonics = 4
 
static constexpr int32 kHarmonicBordersCount = kMultiPolychromaticPenumbraHarmonics + 1
 
static constexpr int32 kSphericalHarmonicTextureCount = 2
 

Detailed Description

The implementation of the default denoiser of the renderer.

Member Function Documentation

◆ DenoiseAmbientOcclusion()

FAmbientOcclusionOutputs FDefaultScreenSpaceDenoiser::DenoiseAmbientOcclusion ( FRDGBuilder GraphBuilder,
const FViewInfo View,
FPreviousViewInfo PreviousViewInfos,
const FSceneTextureParameters SceneTextures,
const FAmbientOcclusionInputs ReflectionInputs,
const FAmbientOcclusionRayTracingConfig  RayTracingConfig 
) const
inlineoverridevirtual

Entry point to denoise reflections.

Implements IScreenSpaceDenoiser.

◆ DenoiseDiffuseIndirect()

FSSDSignalTextures FDefaultScreenSpaceDenoiser::DenoiseDiffuseIndirect ( FRDGBuilder GraphBuilder,
const FViewInfo View,
FPreviousViewInfo PreviousViewInfos,
const FSceneTextureParameters SceneTextures,
const FDiffuseIndirectInputs Inputs,
const FAmbientOcclusionRayTracingConfig  Config 
) const
inlineoverridevirtual

Entry point to denoise diffuse indirect and AO.

Implements IScreenSpaceDenoiser.

◆ DenoiseDiffuseIndirectHarmonic()

FSSDSignalTextures FDefaultScreenSpaceDenoiser::DenoiseDiffuseIndirectHarmonic ( FRDGBuilder GraphBuilder,
const FViewInfo View,
FPreviousViewInfo PreviousViewInfos,
const FSceneTextureParameters SceneTextures,
const FDiffuseIndirectHarmonic Inputs,
const HybridIndirectLighting::FCommonParameters &  CommonDiffuseParameters 
) const
inlineoverridevirtual

Entry point to denoise spherical harmonic for diffuse indirect.

Implements IScreenSpaceDenoiser.

◆ DenoisePolychromaticPenumbraHarmonics()

FPolychromaticPenumbraOutputs FDefaultScreenSpaceDenoiser::DenoisePolychromaticPenumbraHarmonics ( FRDGBuilder GraphBuilder,
const FViewInfo View,
FPreviousViewInfo PreviousViewInfos,
const FSceneTextureParameters SceneTextures,
const FPolychromaticPenumbraHarmonics Inputs 
) const
inlineoverridevirtual

Entry point to denoise polychromatic penumbra of multiple light.

Implements IScreenSpaceDenoiser.

◆ DenoiseReflections()

FReflectionsOutputs FDefaultScreenSpaceDenoiser::DenoiseReflections ( FRDGBuilder GraphBuilder,
const FViewInfo View,
FPreviousViewInfo PreviousViewInfos,
const FSceneTextureParameters SceneTextures,
const FReflectionsInputs ReflectionInputs,
const FReflectionsRayTracingConfig  RayTracingConfig 
) const
inlineoverridevirtual

Entry point to denoise reflections.

Implements IScreenSpaceDenoiser.

◆ DenoiseScreenSpaceDiffuseIndirect()

FSSDSignalTextures FDefaultScreenSpaceDenoiser::DenoiseScreenSpaceDiffuseIndirect ( FRDGBuilder GraphBuilder,
const FViewInfo View,
FPreviousViewInfo PreviousViewInfos,
const FSceneTextureParameters SceneTextures,
const FDiffuseIndirectInputs Inputs,
const FAmbientOcclusionRayTracingConfig  Config 
) const
inlineoverridevirtual

Implements IScreenSpaceDenoiser.

◆ DenoiseShadowVisibilityMasks()

virtual void FDefaultScreenSpaceDenoiser::DenoiseShadowVisibilityMasks ( FRDGBuilder GraphBuilder,
const FViewInfo View,
FPreviousViewInfo PreviousViewInfos,
const FSceneTextureParameters SceneTextures,
const TStaticArray< FShadowVisibilityParameters, IScreenSpaceDenoiser::kMaxBatchSize > &  InputParameters,
const int32  InputParameterCount,
TStaticArray< FShadowVisibilityOutputs, IScreenSpaceDenoiser::kMaxBatchSize > &  Outputs 
) const
inlinevirtual

Entry point to denoise the visibility mask of multiple shadows at the same time.

Implements IScreenSpaceDenoiser.

◆ DenoiseSkyLight()

FDiffuseIndirectOutputs FDefaultScreenSpaceDenoiser::DenoiseSkyLight ( FRDGBuilder GraphBuilder,
const FViewInfo View,
FPreviousViewInfo PreviousViewInfos,
const FSceneTextureParameters SceneTextures,
const FDiffuseIndirectInputs Inputs,
const FAmbientOcclusionRayTracingConfig  Config 
) const
inlineoverridevirtual

Entry point to denoise SkyLight diffuse indirect.

Implements IScreenSpaceDenoiser.

◆ DenoiseWaterReflections()

FReflectionsOutputs FDefaultScreenSpaceDenoiser::DenoiseWaterReflections ( FRDGBuilder GraphBuilder,
const FViewInfo View,
FPreviousViewInfo PreviousViewInfos,
const FSceneTextureParameters SceneTextures,
const FReflectionsInputs ReflectionInputs,
const FReflectionsRayTracingConfig  RayTracingConfig 
) const
inlineoverridevirtual

Entry point to denoise water reflections.

Implements IScreenSpaceDenoiser.

◆ GetDebugName()

const TCHAR * FDefaultScreenSpaceDenoiser::GetDebugName ( ) const
inlineoverridevirtual

Debug name of the denoiser for draw event.

Implements IScreenSpaceDenoiser.

◆ GetShadowRequirements()

virtual EShadowRequirements FDefaultScreenSpaceDenoiser::GetShadowRequirements ( const FViewInfo View,
const FLightSceneInfo LightSceneInfo,
const FShadowRayTracingConfig RayTracingConfig 
) const
inlineoverridevirtual

Returns the ray tracing configuration that should be done for denoiser.

Implements IScreenSpaceDenoiser.

◆ SupportsScreenSpaceDiffuseIndirectDenoiser()

bool FDefaultScreenSpaceDenoiser::SupportsScreenSpaceDiffuseIndirectDenoiser ( EShaderPlatform  Platform) const
inlineoverridevirtual

Entry point to denoise SSGI.

Implements IScreenSpaceDenoiser.


The documentation for this class was generated from the following file: