FidelityFX Blur

FidelityFX Blur runtime library.

Defines

FFX_BLUR_VERSION_MAJOR

#define FFX_BLUR_VERSION_MAJOR (1)

FidelityFX Blur major version.

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 45, column 9)

FFX_BLUR_VERSION_MINOR

#define FFX_BLUR_VERSION_MINOR (1)

FidelityFX Blur minor version.

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 50, column 9)

FFX_BLUR_VERSION_PATCH

#define FFX_BLUR_VERSION_PATCH (0)

FidelityFX Blur patch version.

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 55, column 9)

FFX_BLUR_CONTEXT_COUNT

#define FFX_BLUR_CONTEXT_COUNT 1

FidelityFX Blur context count.

Defines the number of internal effect contexts required by Blur

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 62, column 9)

FFX_BLUR_CONTEXT_SIZE

#define FFX_BLUR_CONTEXT_SIZE (1024)

The size of the context specified in uint32_t units.

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 67, column 9)

FFX_BLUR_KERNEL_SIZE_ALL

#define FFX_BLUR_KERNEL_SIZE_ALL ((1 <<FFX_BLUR_KERNEL_SIZE_COUNT) - 1)

Use this macro for FfxBlurContextDescription::kernelSizes to enable all kernel sizes.

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 85, column 9)

FFX_BLUR_KERNEL_PERMUTATIONS_ALL

#define FFX_BLUR_KERNEL_PERMUTATIONS_ALL ((1 <<FFX_BLUR_KERNEL_PERMUTATION_COUNT) - 1)

Use this macro for FfxBlurContextDescription::sigmaPermutations to enable all sigma permutations.

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 98, column 9)

Functions

ffxBlurContextCreate

FFX_API FfxErrorCode ffxBlurContextCreate(FfxBlurContext *pContext, const FfxBlurContextDescription *pContextDescription)

Create and initialize the FfxBlurContext.

Parameters:

pContext (FfxBlurContext *) – [out] The FfxBlurContext to create and initialize.
pContextDescription (const FfxBlurContextDescription *) – [in] The initialization configuration parameters.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 160, column 22)

ffxBlurContextDestroy

FFX_API FfxErrorCode ffxBlurContextDestroy(FfxBlurContext *pContext)

Destroy and free resources associated with the FfxBlurContext.

Parameters:

pContext (FfxBlurContext *) – [inout] The FfxBlurContext to destroy.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 167, column 22)

ffxBlurContextDispatch

FFX_API FfxErrorCode ffxBlurContextDispatch(FfxBlurContext *pContext, const FfxBlurDispatchDescription *pDispatchDescription)

Create and initialize the FfxBlurContext.

Parameters:

pContext (FfxBlurContext *) – [in] The FfxBlurContext to use for the dispatch.
pDispatchDescription (const FfxBlurDispatchDescription *) – [in] The dispatch configuration parameters (see FfxBlurDispatchDescription).

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 188, column 22)

ffxBlurGetEffectVersion

FFX_API FfxVersionNumber ffxBlurGetEffectVersion()

Queries the effect version number.

Returns: The SDK version the effect was built with.

Returns: FFX_API FfxVersionNumber

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 196, column 26)

Enumerations

FfxBlurPass

enum FfxBlurPass

Enum to specify which blur pass (currently only one).

Values:

FFX_BLUR_PASS_BLUR

FFX_BLUR_PASS_BLUR = 0

A pass which which blurs the input.

FFX_BLUR_PASS_COUNT

The number of passes in the Blur effect.

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 76, column 1)

FfxBlurKernelSize

enum FfxBlurKernelSize

Enum to specify the size of the blur kernel. Use logical OR to enable multiple kernels when setting the FfxBlurContextDescription::kernelSizes parameter prior to calling ffxBlurContextCreate.

Values:

FFX_BLUR_KERNEL_SIZE_3x3

FFX_BLUR_KERNEL_SIZE_3x3 = (1 <<0)

FFX_BLUR_KERNEL_SIZE_5x5

FFX_BLUR_KERNEL_SIZE_5x5 = (1 <<1)

FFX_BLUR_KERNEL_SIZE_7x7

FFX_BLUR_KERNEL_SIZE_7x7 = (1 <<2)

FFX_BLUR_KERNEL_SIZE_9x9

FFX_BLUR_KERNEL_SIZE_9x9 = (1 <<3)

FFX_BLUR_KERNEL_SIZE_11x11

FFX_BLUR_KERNEL_SIZE_11x11 = (1 <<4)

FFX_BLUR_KERNEL_SIZE_13x13

FFX_BLUR_KERNEL_SIZE_13x13 = (1 <<5)

FFX_BLUR_KERNEL_SIZE_15x15

FFX_BLUR_KERNEL_SIZE_15x15 = (1 <<6)

FFX_BLUR_KERNEL_SIZE_17x17

FFX_BLUR_KERNEL_SIZE_17x17 = (1 <<7)

FFX_BLUR_KERNEL_SIZE_19x19

FFX_BLUR_KERNEL_SIZE_19x19 = (1 <<8)

FFX_BLUR_KERNEL_SIZE_21x21

FFX_BLUR_KERNEL_SIZE_21x21 = (1 <<9)

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 105, column 1)

FfxBlurFloatPrecision

enum FfxBlurFloatPrecision

Enum to specify whether to initialize the FP32 or FP16 bit permutation of the blur shader(s). Use this when setting the FfxBlurContextDescription::floatPrecision parameter prior to calling ffxBlurContextCreate.

Values:

FFX_BLUR_FLOAT_PRECISION_32BIT

FFX_BLUR_FLOAT_PRECISION_32BIT = 0

FFX_BLUR_FLOAT_PRECISION_16BIT

FFX_BLUR_FLOAT_PRECISION_16BIT = 1

FFX_BLUR_FLOAT_PRECISION_COUNT

FFX_BLUR_FLOAT_PRECISION_COUNT = 2

Source: sdk/include/FidelityFX/host/ffx_blur.h (line 125, column 1)

Dependencies: FfxBlurContext, FfxBlurContextDescription, FfxBlurDispatchDescription