FidelityFX Denoiser

FidelityFX Denoiser runtime library.

Defines

FFX_DENOISER_VERSION_MAJOR

#define FFX_DENOISER_VERSION_MAJOR (1)

FidelityFX Denoiser major version.

Source: sdk/include/FidelityFX/host/ffx_denoiser.h (line 36, column 9)

FFX_DENOISER_VERSION_MINOR

#define FFX_DENOISER_VERSION_MINOR (3)

FidelityFX Denoiser minor version.

Source: sdk/include/FidelityFX/host/ffx_denoiser.h (line 41, column 9)

FFX_DENOISER_VERSION_PATCH

#define FFX_DENOISER_VERSION_PATCH (0)

FidelityFX Denoiser patch version.

Source: sdk/include/FidelityFX/host/ffx_denoiser.h (line 46, column 9)

FFX_DENOISER_CONTEXT_COUNT

#define FFX_DENOISER_CONTEXT_COUNT 1

FidelityFX denoiser context count.

Defines the number of internal effect contexts required by the denoiser

Source: sdk/include/FidelityFX/host/ffx_denoiser.h (line 53, column 9)

Functions

ffxDenoiserContextCreate

FFX_API FfxErrorCode ffxDenoiserContextCreate(FfxDenoiserContext *pContext, const FfxDenoiserContextDescription *pContextDescription)

Create a FidelityFX Denoiser context from the parameters programmed to the FfxDenoiserContextDescription structure.

The context structure is the main object used to interact with the Denoiser API, and is responsible for the management of the internal resources used by the Denoiser algorithm. When this API is called, multiple calls will be made via the pointers contained in the backendInterface structure. This backend will attempt to retrieve the device capabilities, and create the internal resources, and pipelines required by Denoiser to function. Depending on the precise configuration used when creating the FfxDenoiserContext a different set of resources and pipelines might be requested via the callback functions.

The FfxDenoiserContext should be destroyed when use of it is completed, typically when an application is unloaded or shadow denoising is disabled by a user. To destroy the Denoiser context you should call ffxDenoiserContextDestroy.

Parameters:

Name	Type	Default
`pContext`	`FfxDenoiserContext *`	“
`pContextDescription`	`const FfxDenoiserContextDescription *`	“

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_denoiser.h (line 212, column 22)

ffxDenoiserContextDispatchShadows

FFX_API FfxErrorCode ffxDenoiserContextDispatchShadows(FfxDenoiserContext *context, const FfxDenoiserShadowsDispatchDescription *dispatchDescription)

Dispatches work to the FidelityFX Denoiser context.

Parameters:

context (FfxDenoiserContext *) – [out] A pointer to a FfxDenoiserContext structure to populate.
dispatchDescription (const FfxDenoiserShadowsDispatchDescription *) – [in] A pointer to a FfxDenoiserShadowsDispatchDescription structure.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_denoiser.h (line 227, column 22)

ffxDenoiserContextDispatchReflections

FFX_API FfxErrorCode ffxDenoiserContextDispatchReflections(FfxDenoiserContext *context, const FfxDenoiserReflectionsDispatchDescription *dispatchDescription)

Dispatches work to the FidelityFX Denoiser context.

Parameters:

context (FfxDenoiserContext *) – [out] A pointer to a FfxDenoiserContext structure to populate.
dispatchDescription (const FfxDenoiserReflectionsDispatchDescription *) – [in] A pointer to a FfxDenoiserReflectionsDispatchDescription structure.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_denoiser.h (line 242, column 22)

ffxDenoiserContextDestroy

FFX_API FfxErrorCode ffxDenoiserContextDestroy(FfxDenoiserContext *context)

Destroy the FidelityFX Denoiser context.

Parameters:

context (FfxDenoiserContext *) – [out] A pointer to a FfxDenoiserContext structure to destroy.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_denoiser.h (line 254, column 22)

ffxDenoiserGetEffectVersion

FFX_API FfxVersionNumber ffxDenoiserGetEffectVersion()

Queries the effect version number.

Returns: The SDK version the effect was built with.

Returns: FFX_API FfxVersionNumber

Source: sdk/include/FidelityFX/host/ffx_denoiser.h (line 262, column 26)

Enumerations

FfxDenoiserInitializationFlagBits

enum FfxDenoiserInitializationFlagBits

An enumeration of bit flags used when creating a FfxDenoiserContext. See FfxDenoiserContextDescription.

Values:

FFX_DENOISER_SHADOWS

FFX_DENOISER_SHADOWS = (1 <<0)

A bit indicating that the denoiser is used for denoising shadows.

FFX_DENOISER_REFLECTIONS

FFX_DENOISER_REFLECTIONS = (1 <<1)

A bit indicating that the denoiser is used for denoising reflections.

FFX_DENOISER_ENABLE_DEPTH_INVERTED

FFX_DENOISER_ENABLE_DEPTH_INVERTED = (1 <<2)

A bit indicating that the input depth buffer data provided is inverted [1..0].

Source: sdk/include/FidelityFX/host/ffx_denoiser.h (line 85, column 1)

Dependencies

This module depends on: