FidelityFX Classifier

FidelityFX Classifier runtime library.

Defines

FFX_CLASSIFIER_VERSION_MAJOR

#define FFX_CLASSIFIER_VERSION_MAJOR (1)

FidelityFX Classifier major version.

Source: sdk/include/FidelityFX/host/ffx_classifier.h (line 40, column 9)

FFX_CLASSIFIER_VERSION_MINOR

#define FFX_CLASSIFIER_VERSION_MINOR (3)

FidelityFX Classifier minor version.

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

FFX_CLASSIFIER_VERSION_PATCH

#define FFX_CLASSIFIER_VERSION_PATCH (0)

FidelityFX Classifier patch version.

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

FFX_CLASSIFIER_CONTEXT_COUNT

#define FFX_CLASSIFIER_CONTEXT_COUNT 1

FidelityFX Classifier context count.

Defines the number of internal effect contexts required by Classifier

Source: sdk/include/FidelityFX/host/ffx_classifier.h (line 57, column 9)

FFX_CLASSIFIER_CONTEXT_SIZE

#define FFX_CLASSIFIER_CONTEXT_SIZE (18500)

The size of the context specified in 32bit values.

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

Functions

ffxClassifierContextCreate

FFX_API FfxErrorCode ffxClassifierContextCreate(FfxClassifierContext *pContext, const FfxClassifierContextDescription *pContextDescription)

Create a FidelityFX Classifier context from the parameters programmed to the FfxClassifierContextDescription structure.

The context structure is the main object used to interact with the Classifier API, and is responsible for the management of the internal resources used by the Classifier. 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 the Classifier to function. Depending on the precise configuration used when creating the FfxClassifierContext a different set of resources and pipelines might be requested via the callback functions.

The FfxClassifierContext should be destroyed when use of it is completed, typically when an application is unloaded or the Classifier is disabled by a user. To destroy the Classifier context you should call FfxClassifierContextDestroy.

Parameters:

pContext (FfxClassifierContext *) – [out] A pointer to a FfxClassifierContext structure to populate.
pContextDescription (const FfxClassifierContextDescription *) – [in] A pointer to a FfxClassifierContextDescription structure.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_classifier.h (line 234, column 22)

ffxClassifierContextShadowDispatch

FFX_API FfxErrorCode ffxClassifierContextShadowDispatch(FfxClassifierContext *pContext, const FfxClassifierShadowDispatchDescription *pDispatchDescription)

Dispatches work to the FidelityFX Classifier context for shadows.

Parameters:

pContext (FfxClassifierContext *) – [in] A pointer to a FfxClassifierContext structure.
pDispatchDescription (const FfxClassifierShadowDispatchDescription *) – [in] A pointer to a FfxClassifierShadowDispatchDescription structure.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_classifier.h (line 249, column 22)

ffxClassifierContextReflectionDispatch

FFX_API FfxErrorCode ffxClassifierContextReflectionDispatch(FfxClassifierContext *pContext, const FfxClassifierReflectionDispatchDescription *pDispatchDescription)

Dispatches work to the FidelityFX Classifier context for reflections.

Parameters:

pContext (FfxClassifierContext *) – [in] A pointer to a FfxClassifierContext structure.
pDispatchDescription (const FfxClassifierReflectionDispatchDescription *) – [in] A pointer to a FfxClassifierReflectionDispatchDescription structure.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_classifier.h (line 264, column 22)

ffxClassifierContextDestroy

FFX_API FfxErrorCode ffxClassifierContextDestroy(FfxClassifierContext *pContext)

Destroy the FidelityFX Classifier context.

Parameters:

pContext (FfxClassifierContext *) – [out] A pointer to a FfxClassifierContext structure to destroy.

Returns: FFX_API FfxErrorCode

Source: sdk/include/FidelityFX/host/ffx_classifier.h (line 276, column 22)

ffxClassifierGetEffectVersion

FFX_API FfxVersionNumber ffxClassifierGetEffectVersion()

Queries the effect version number.

Returns: The SDK version the effect was built with.

Returns: FFX_API FfxVersionNumber

Source: sdk/include/FidelityFX/host/ffx_classifier.h (line 284, column 26)

Enumerations

FfxClassifierInitializationFlagBits

enum FfxClassifierInitializationFlagBits

An enumeration of bit flags used when creating a FfxClassifierContext. See FfxClassifierContextDescription. Currently, no flags exist.

Values:

FFX_CLASSIFIER_SHADOW

FFX_CLASSIFIER_SHADOW = (1 <<0)

A bit indicating the intent is to classify shadows.

FFX_CLASSIFIER_CLASSIFY_BY_NORMALS

FFX_CLASSIFIER_CLASSIFY_BY_NORMALS = (1 <<1)

A bit indicating the intent is to classify by normals.

FFX_CLASSIFIER_CLASSIFY_BY_CASCADES

FFX_CLASSIFIER_CLASSIFY_BY_CASCADES = (1 <<2)

A bit indicating the intent is to classify by cascades.

FFX_CLASSIFIER_ENABLE_DEPTH_INVERTED

FFX_CLASSIFIER_ENABLE_DEPTH_INVERTED = (1 <<3)

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

FFX_CLASSIFIER_REFLECTION

FFX_CLASSIFIER_REFLECTION = (1 <<4)

A bit indicating the intent is to classify reflections.

Source: sdk/include/FidelityFX/host/ffx_classifier.h (line 83, column 1)

Dependencies

This module depends on: