AMD FidelityFX SDK

https://gpuopen.com/manuals/
Admin
The AMD FidelityFX SDK is a collection of heavily optimized, open-source technologies (shader and...
Tokens:325,468
Snippets:2,548
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### DispatchExampleShader(cauldron::CommandList *pCmdList)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_brixelizer_sample/brixelizer_rendermodule/brixelizer_r_m

Dispatches the example shader.

```APIDOC
## DispatchExampleShader(cauldron::CommandList *pCmdList)

### Description
Dispatches the example shader.

### Signature
```cpp
void DispatchExampleShader(cauldron::CommandList *pCmdList)
```

### Parameters
- **pCmdList** (`cauldron::CommandList *`) - Required - Pointer to the command list.

### Source
`samples/brixelizergi/brixelizergirendermodule.h` (line 270, column 10)
```

--------------------------------

### Content block configuration example

Source: https://gpuopen.com/manuals/fidelityfx_sdk/getting-started/running-samples

Example of the Content block in a sample configuration file, specifying particle spawners, scenes, camera, and image-based lighting settings.

```json
"Content": {
  "ParticleSpawners": [
    {
    "Name": "FSRSpawner",
    "AtlasPath": "media/particles/atlas.dds",
    "Position": [ 0.0, 0.0, 0.0 ],
    "Sort": true,
    "Emitters": [
      {
        "Name": "Smoke",
        "SpawnOffset": [ 0.0, 0.0, 1.4 ],
        "SpawnOffsetVariance": [ 0.1, 0.0, 0.1 ],
        "SpawnVelocity": [ 0.0, 0.2, 0.0 ],
        "SpawnVelocityVariance": 1.0,
        "ParticlesPerSecond": 10,
        "Lifespan": 50.0,
        "SpawnSize": 0.4,
        "KillSize": 1.0,
        "Mass": 0.0003,
        "AtlasIndex": 0,
        "Flags": {
          "Reactive": true,
          "Streaks": false
        }
      },
      ]
    }
  ],
  "Scenes": [
    "../media/Chess/scene.gltf"
  ],
  "Camera": "Camera_1",
  "DiffuseIBL": "../media/IBL/mud_road_puresky_Diffuse.dds",
  "SpecularIBL": "../media/IBL/mud_road_puresky_Specular.dds",
  "SkyMap": "../media/IBL/mud_road_puresky_Specular.dds",
  "SceneExposure": 1.355
}
```

--------------------------------

### RenderResources configuration example

Source: https://gpuopen.com/manuals/fidelityfx_sdk/getting-started/running-samples

Example of defining render resources and aliases. Resources are created at framework initialization. 'RenderResolution': true creates at render resolution instead of display resolution. Aliases add names for querying from DynamicResourcePool.

```json
"RenderResources": {
  "MotionVectorTarget": {
    "Format": "RG16_FLOAT",
    "RenderResolution": true
  },


  "GBufferMotionVectorRT": "MotionVectorTarget"
}
```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/classes/animated_textures_render_module

Rendermodule initialization function. This is where all setup code needs to happen.

```APIDOC
## Init(const json &initData)

### Description
Rendermodule initialization function. This is where all setup code needs to happen.

### Method
Init

### Signature
```cpp
virtual void Init(const json &initData) override
```

### Parameters
- `initData` (const json&) - Required - Initialization data.

### Attributes
- `virtual`

### Source
`framework/rendermodules/animatedtextures/animatedtexturesrendermodule.h` (line 47, column 18)
```

--------------------------------

### Miscellaneous options configuration example

Source: https://gpuopen.com/manuals/fidelityfx_sdk/getting-started/running-samples

Example of miscellaneous options that are not affiliated with a group, including FontSize, AGSEnabled, StablePowerState, InvertedDepth, MotionVectorGeneration, OverrideSceneSamplers, and BuildRayTracingAccelerationStructure.

```json
"FontSize": 13,
"AGSEnabled": false,
"StablePowerState": false,
"InvertedDepth": true,
"MotionVectorGeneration": "",
"OverrideSceneSamplers": true,
"BuildRayTracingAccelerationStructure": false,
```

--------------------------------

### Example call to ffxContextCreate

Source: https://gpuopen.com/manuals/fidelityfx_sdk/getting-started/ffx-api

Shows how to create an upscale context using the C API. The createUpscale description is chained to a backend description via pNext. The context is initialized to null and errors are handled via the return code.

```cpp
struct ffxCreateBackendDX12Desc createBackend = /*...*/;


struct ffxCreateContextDescUpscale createUpscale = { 0 };
createUpscale.header.type = FFX_API_CREATE_CONTEXT_DESC_TYPE_UPSCALE;


// fill struct ...


createUpscale.header.pNext = &createBackend.header;


ffxContext upscaleContext = NULL;
ffxReturnCode_t retCode = ffxContextCreate(&upscaleContext, &createUpscale.header, NULL);
// handle errors
```

--------------------------------

### ffxCasSetup

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/gpu/fidelityfx_gpu_references/fidelityfx_cas/ffx_g_p_u_cas

Call to setup required constant values (works on CPU or GPU). Populates two constant buffer values based on sharpness and input/output sizes.

```APIDOC
## ffxCasSetup

### Description
Call to setup required constant values (works on CPU or GPU).

### Function Signature
```
FFX_STATIC void ffxCasSetup(FFX_PARAMETER_INOUT FfxUInt32x4 const0, FFX_PARAMETER_INOUT FfxUInt32x4 const1, FFX_PARAMETER_IN FfxFloat32 sharpness, FFX_PARAMETER_IN FfxFloat32 inputSizeInPixelsX, FFX_PARAMETER_IN FfxFloat32 inputSizeInPixelsY, FFX_PARAMETER_IN FfxFloat32 outputSizeInPixelsX, FFX_PARAMETER_IN FfxFloat32 outputSizeInPixelsY)
```

### Parameters
- **const0** (`FFX_PARAMETER_INOUT FfxUInt32x4`) - [out] The first 4 32-bit values of the constant buffer which is populated by this function.
- **const1** (`FFX_PARAMETER_INOUT FfxUInt32x4`) - [out] The second 4 32-bit values of the constant buffer which is populated by this function.
- **sharpness** (`FFX_PARAMETER_IN FfxFloat32`) - [in] Set to 0 for the default (lower ringing), 1 for maximum (higest ringing).
- **inputSizeInPixelsX** (`FFX_PARAMETER_IN FfxFloat32`) - [in] The size of the input resolution in the X dimension.
- **inputSizeInPixelsY** (`FFX_PARAMETER_IN FfxFloat32`) - [in] The size of the input resolution in the Y dimension.
- **outputSizeInPixelsX** (`FFX_PARAMETER_IN FfxFloat32`) - [in] The size of the output resolution in the X dimension.
- **outputSizeInPixelsY** (`FFX_PARAMETER_IN FfxFloat32`) - [in] The size of the output resolution in the Y dimension.

### Returns
`FFX_STATIC void`

### Source
`sdk/include/FidelityFX/gpu/cas/ffx_cas.h` (line 66, column 17)
```

--------------------------------

### EnableModule(bool enabled)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_brixelizer_sample/brixelizer_rendermodule/brixelizer_r_m

Initialize FFX API Context, Brixelizer context, create resources and setup UI section.

```APIDOC
## EnableModule(bool enabled)

### Description
Initialize FFX API Context, Brixelizer context, create resources and setup UI section.

### Signature
```cpp
virtual void EnableModule(bool enabled) override
```

### Parameters
- **enabled** (`bool`) - Required - Whether to enable the module.

### Attributes
- `virtual`

### Source
`samples/brixelizergi/brixelizergirendermodule.h` (line 84, column 10)
```

--------------------------------

### Generate Visual Studio solution with BuildSamplesSolution batch file

Source: https://gpuopen.com/manuals/fidelityfx_sdk/getting-started/building-samples

Run this batch file from the SDK installation path to generate a Visual Studio solution. It will ask whether to build the SDK as a DLL (answer 'n' for static library) and which samples to include (use '1' for all). The solution is created in the 'build' directory.

```batch
> <installation path>\BuildSamplesSolution[DX12/VK].bat
```

--------------------------------

### C++ wrapper equivalent for context creation

Source: https://gpuopen.com/manuals/fidelityfx_sdk/getting-started/ffx-api

Equivalent of the previous C example using the C++ wrapper. The chain of createUpscale and createBackend is linked automatically. Note that the third argument comes second to support a variadic description argument.

```cpp
// equivalent of above, chain of createUpscale and createBackend will be linked automatically.
ffxReturnCode_t retCode = ffx::ContextCreate(upscaleContext, nullptr, createUpscale, createBackend);
```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_luma_preserving_mapper_sample/lpmrendermodule/lpm_r_m

Initializes the FFX API context, sets up input/output resources, and sets up the UI section for LPM.

```APIDOC
## Init(const json &initData)

### Description
Initialize FFX API Context, setup input/output resources and setup UI section for LPM.

### Signature
```cpp
void Init(const json &initData) override
```

### Parameters
- **initData** (const json &) - Required - Initialization data.

### Source
`samples/lpm/lpmrendermodule.h` (line 76, column 10)
```

--------------------------------

### RenderModuleOverrides configuration example

Source: https://gpuopen.com/manuals/fidelityfx_sdk/getting-started/running-samples

Example of the RenderModuleOverrides object used to override data for render module initialization. Shows overriding SkyDomeRenderModule's procedural generation setting.

```json
"RenderModuleOverrides": {
  "SkyDomeRenderModule": {
    "Procedural": true
  }
}
```

--------------------------------

### RenderModuleOptions configuration example

Source: https://gpuopen.com/manuals/fidelityfx_sdk/getting-started/running-samples

Example of the RenderModuleOptions special object used in render module configuration files to override initialization data. Shows disabling ZPrepass and VariableShading.

```json
"RenderModuleOptions": {
  "ZPrepass": false,
  "VariableShading":  false
}
```

--------------------------------

### ADLXHelper_QueryVersion

Source: https://gpuopen.com/manuals/adlx/adlx-sdk-references/adlx-helpers/adlx-helper-functions

Gets the version of ADLX.

```APIDOC
## ADLXHelper_QueryVersion

### Description
Gets the version of ADLX.

### Method
Function

### Signature
ADLXHelper_QueryVersion

### Requirements
- Header: include "ADLXHelper/Windows/C/ADLXHelper.h"
- Minimum version: 1.0

```

--------------------------------

### InitFfxBackend()

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_vrs_sample/vrsrendermodule/vrs_r_m

Initializes the FidelityFX backend.

```APIDOC
## InitFfxBackend()

### Description
Initializes the FidelityFX backend.

### Method
InitFfxBackend

### Signature
```cpp
void InitFfxBackend()
```

### Source
`samples/vrs/vrsrendermodule.h` (line 106, column 10)
```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/classes/s_p_d_render_module

Initializes the FFX API Context, loads the downsampling resource, and sets up the UI section for SPD.

```APIDOC
## Init(const json &initData)

### Description
Initialize FFX API Context, load the downsampling resource, and setup UI section for SPD.

### Method
Init

### Signature
```cpp
virtual void Init(const json &initData) override
```

### Parameters
- **initData** (const json &) - Required - Initialization data.

### Attributes
- `virtual`

### Source
`samples/spd/spdrendermodule.h` (line 86, column 10)
```

--------------------------------

### ADLXHelper_QueryFullVersion

Source: https://gpuopen.com/manuals/adlx/adlx-sdk-references/adlx-helpers/adlx-helper-functions

Gets the full version of ADLX.

```APIDOC
## ADLXHelper_QueryFullVersion

### Description
Gets the full version of ADLX.

### Method
Function

### Signature
ADLXHelper_QueryFullVersion

### Requirements
- Header: include "ADLXHelper/Windows/C/ADLXHelper.h"
- Minimum version: 1.0

```

--------------------------------

### ADLXHelper_GetSystemServices

Source: https://gpuopen.com/manuals/adlx/adlx-sdk-references/adlx-helpers/adlx-helper-functions

Gets the ADLX system interface.

```APIDOC
## ADLXHelper_GetSystemServices

### Description
Gets the ADLX system interface.

### Method
Function

### Signature
ADLXHelper_GetSystemServices

### Requirements
- Header: include "ADLXHelper/Windows/C/ADLXHelper.h"
- Minimum version: 1.0

```

--------------------------------

### InitFfxContext()

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_luma_preserving_mapper_sample/lpmrendermodule/lpm_r_m

Initializes the FFX context.

```APIDOC
## InitFfxContext()

### Description
Initializes the FFX context.

### Signature
```cpp
void InitFfxContext()
```

### Source
`samples/lpm/lpmrendermodule.h` (line 91, column 10)
```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_cacao_sample/cacaorendermodule/cacao_r_m

Initializes the FFX API Context, sets up CACAO settings to default, and sets up the UI section for CACAO.

```APIDOC
## Init(const json &initData)

### Description
Initialize the FFX API Context, setup CACAO settings to default, and setup the UI section for CACAO.

### Method
Member function

### Signature
```cpp
virtual void Init(const json &initData) override
```

### Parameters
- `initData` (const json&) - Required - The initialization data.

### Attributes
- `virtual`

### Source
`samples/cacao/cacaorendermodule.h` (line 331, column 10)
```

--------------------------------

### ffxBrixelizerRawGetContextSize

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_brixelizer/ffx_brixelizer

Gets the size in bytes needed for an FfxBrixelizerRawContext struct.

```APIDOC
## ffxBrixelizerRawGetContextSize

### Description
Gets the size in bytes needed for an FfxBrixelizerRawContext struct. Note that this function is provided for consistency, and the size of the FfxBrixelizerRawContext is a known compile time value which can be obtained using sizeof(FfxBrixelizerRawContext).

### Function Signature
`inline size_t ffxBrixelizerRawGetContextSize()`

### Parameters
None.

### Returns
`size_t` - The size in bytes of an FfxBrixelizerRawContext struct.

### Attributes
`inline`

### Source
`sdk/include/FidelityFX/host/ffx_brixelizer_raw.h` (line 306, column 15)
```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_vrs_sample/vrsrendermodule/vrs_r_m

Initializes the VRS render module. Checks hardware VRS support, builds user interface, creates GPU resources, sets up callback functions, and initializes the ffx_vrs backend.

```APIDOC
## Init(const json &initData)

### Description
This function checks hardware VRS support, builds user interface, creates GPU resources, sets up callback functions and initializes ffx_vrs backend.

### Method
Init

### Signature
```cpp
virtual void Init(const json &initData) override
```

### Parameters
- `initData` (const json &) - Required - Initialization data.

### Attributes
- `virtual`

### Source
`samples/vrs/vrsrendermodule.h` (line 81, column 10)
```

--------------------------------

### ffxFsr1ContextGetGpuMemoryUsage

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_fsr1/ffx_fsr1

Gets GPU memory usage of the FidelityFX Super Resolution context.

```APIDOC
## ffxFsr1ContextGetGpuMemoryUsage

### Description
Gets GPU memory usage of the FidelityFX Super Resolution context.

### Signature
```
FFX_API FfxErrorCode ffxFsr1ContextGetGpuMemoryUsage(FfxFsr1Context *pContext, FfxEffectMemoryUsage *pVramUsage)
```

### Parameters
- **pContext** (`FfxFsr1Context *`) - [in] A pointer to a FfxFsr1Context structure.
- **pVramUsage** (`FfxEffectMemoryUsage *`) - [out] A pointer to a FfxEffectMemoryUsage structure.

### Returns
`FFX_API FfxErrorCode`

### Source
`sdk/include/FidelityFX/host/ffx_fsr1.h` (line 211, column 22)
```

--------------------------------

### SetupDebugVisualization(FfxBrixelizerUpdateDescription &updateDesc, FfxBrixelizerDebugVisualizationDescription &debugVisDesc)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_brixelizer_sample/brixelizer_rendermodule/brixelizer_r_m

Sets up debug visualization for the Brixelizer.

```APIDOC
## SetupDebugVisualization(FfxBrixelizerUpdateDescription &updateDesc, FfxBrixelizerDebugVisualizationDescription &debugVisDesc)

### Description
Sets up debug visualization for the Brixelizer.

### Signature
```cpp
void SetupDebugVisualization(FfxBrixelizerUpdateDescription &updateDesc, FfxBrixelizerDebugVisualizationDescription &debugVisDesc)
```

### Parameters
- **updateDesc** (`FfxBrixelizerUpdateDescription &`) - Required - Update description.
- **debugVisDesc** (`FfxBrixelizerDebugVisualizationDescription &`) - Required - Debug visualization description.

### Source
`samples/brixelizergi/brixelizergirendermodule.h` (line 269, column 10)
```

--------------------------------

### ffxFsr3UpscalerContextGetGpuMemoryUsage

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_fsr3/ffx_fsr3_upscaler

Gets the GPU memory usage of the FidelityFX Super Resolution context.

```APIDOC
## ffxFsr3UpscalerContextGetGpuMemoryUsage

### Description
Get GPU memory usage of the FidelityFX Super Resolution context.

### Function Signature
`FFX_API FfxErrorCode ffxFsr3UpscalerContextGetGpuMemoryUsage(FfxFsr3UpscalerContext *pContext, FfxEffectMemoryUsage *pVramUsage)`

### Parameters
- **pContext** (`FfxFsr3UpscalerContext *`) - [in] A pointer to a FfxFsr3UpscalerContext structure.
- **pVramUsage** (`FfxEffectMemoryUsage *`) - [out] A pointer to a FfxEffectMemoryUsage structure.

### Returns
`FFX_API FfxErrorCode`

### Source
`sdk/include/FidelityFX/host/ffx_fsr3upscaler.h` (line 333, column 22)
```

--------------------------------

### ffxFsr2ContextGetGpuMemoryUsage

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_fsr2/ffx_fsr2

Gets the GPU memory usage of the FidelityFX Super Resolution context.

```APIDOC
## ffxFsr2ContextGetGpuMemoryUsage

### Description
Gets the GPU memory usage of the FidelityFX Super Resolution context.

### Method
Function

### Signature
`FFX_API FfxErrorCode ffxFsr2ContextGetGpuMemoryUsage(FfxFsr2Context *pContext, FfxEffectMemoryUsage *pVramUsage)`

### Parameters
- **pContext** (`FfxFsr2Context *`) - [in] A pointer to a FfxFsr2Context structure.
- **pVramUsage** (`FfxEffectMemoryUsage *`) - [out] A pointer to a FfxEffectMemoryUsage structure.

### Returns
`FFX_API FfxErrorCode`

### Source
`sdk/include/FidelityFX/host/ffx_fsr2.h` (line 297, column 22)
```

--------------------------------

### ffxBrixelizerGetRawContext

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_brixelizer/ffx_brixelizer

Gets a pointer to the underlying Brixelizer raw context from a Brixelizer context.

```APIDOC
## ffxBrixelizerGetRawContext

### Description
Gets a pointer to the underlying Brixelizer raw context from a Brixelizer context.

### Function Signature
`FFX_API FfxErrorCode ffxBrixelizerGetRawContext(FfxBrixelizerContext *context, FfxBrixelizerRawContext **outContext)`

### Parameters
- **context** (`FfxBrixelizerContext *`) - [inout] An FfxBrixelizerContext containing the Brixelizer context.
- **outContext** (`FfxBrixelizerRawContext **`) - [out] A FfxBrixelizerRawContext representing the underlying Brixelizer raw context.

### Returns
`FFX_API FfxErrorCode` - Returns `FFX_ERROR_INVALID_POINTER` if the pointer given was invalid, or `FFX_OK` if the operation completed successfully.

### Source
`sdk/include/FidelityFX/host/ffx_brixelizer.h` (line 335, column 22)
```

--------------------------------

### GetCPUDescription

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/cauldron/miscellaneous/corecounts/cauldron_core_counts

Gets an std::wstring representation of the CPU name. Returns None.

```APIDOC
## GetCPUDescription

### Description
Gets an std::wstring representation of the CPU name.

### Method
Function

### Signature
```cpp
void GetCPUDescription(std::wstring &cpuName)
```

### Parameters
- **cpuName** (`std::wstring &`) - [out] The std::wstring description of the onboard CPU.

### Returns
None.

### Source
`framework/cauldron/framework/inc/misc/corecounts.h` (line 49, column 10)
```

--------------------------------

### ffxBrixelizerRawContextGetCascadeCounters

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_brixelizer/ffx_brixelizer

Gets the cascade counters from a Brixelizer context. Requires the FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CASCADE_READBACK_BUFFERS flag at context creation.

```APIDOC
## ffxBrixelizerRawContextGetCascadeCounters

### Description
Gets the cascade counters from a Brixelizer context. Note to use this function the flag FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CASCADE_READBACK_BUFFERS must be passed at context creation.

### Function Signature
```c
FFX_API FfxErrorCode ffxBrixelizerRawContextGetCascadeCounters(FfxBrixelizerRawContext *context, uint32_t cascadeIndex, FfxBrixelizerScratchCounters *counters)
```

### Parameters
- **context** (`FfxBrixelizerRawContext *`) - [out] The FfxBrixelizerRawContext to read the cascade counters of.
- **cascadeIndex** (`uint32_t`) - [in] The index of the cascade to read the cascade counters of.
- **counters** (`FfxBrixelizerScratchCounters *`) - [out] A FfxBrixelizerScratchCounters struct to read the cascade counters to.

### Returns
- **FfxErrorCode** - The result of the operation.

### Source
`sdk/include/FidelityFX/host/ffx_brixelizer_raw.h` (line 566, column 22)
```

--------------------------------

### ffxBrixelizerRawContextGetDebugCounters

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_brixelizer/ffx_brixelizer

Gets the debug counters from a Brixelizer context. Requires the FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CONTEXT_READBACK_BUFFERS flag at context creation.

```APIDOC
## ffxBrixelizerRawContextGetDebugCounters

### Description
Gets the debug counters from a Brixelizer context. Note to use this function the flag FFX_BRIXELIZER_CONTEXT_FLAG_DEBUG_CONTEXT_READBACK_BUFFERS must be passed at context creation.

### Function Signature
```c
FFX_API FfxErrorCode ffxBrixelizerRawContextGetDebugCounters(FfxBrixelizerRawContext *context, FfxBrixelizerDebugCounters *debugCounters)
```

### Parameters
- **context** (`FfxBrixelizerRawContext *`) - [out] The FfxBrixelizerRawContext to read the debug counters of.
- **debugCounters** (`FfxBrixelizerDebugCounters *`) - [out] A FfxBrixelizerDebugCounters struct to read the debug counters to.

### Returns
- **FfxErrorCode** - The result of the operation.

### Source
`sdk/include/FidelityFX/host/ffx_brixelizer_raw.h` (line 550, column 22)
```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_lens_sample/lensrendermodule/lens_r_m

Initializes the FFX API Context, sets up the intermediate color texture, and sets up the UI section for Lens.

```APIDOC
## Init(const json &initData)

### Description
Initialize FFX API Context, setup the intermediate color texture, and setup UI section for Lens.

### Method
Init

### Signature
```cpp
virtual void Init(const json &initData) override
```

### Parameters
- `initData` (const json &) - Required - Initialization data.

### Attributes
- `virtual`

### Source
`samples/lens/lensrendermodule.h` (line 78, column 10)
```

--------------------------------

### ffxBrixelizerRawContextGetScratchMemorySize

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_brixelizer/ffx_brixelizer

Gets the size in bytes needed from a FfxResource to be used as a scratch buffer in a cascade update.

```APIDOC
## ffxBrixelizerRawContextGetScratchMemorySize

### Description
Gets the size in bytes needed from a FfxResource to be used as a scratch buffer in a cascade update.

### Signature
`FFX_API FfxErrorCode ffxBrixelizerRawContextGetScratchMemorySize(FfxBrixelizerRawContext *context, const FfxBrixelizerRawCascadeUpdateDescription *cascadeUpdateDescription, size_t *size)`

### Parameters
- **context** (`FfxBrixelizerRawContext *`) - [out] The FfxBrixelizerRawContext to calculate the required scratch buffer size for.
- **cascadeUpdateDescription** (`const FfxBrixelizerRawCascadeUpdateDescription *`) - [in] A FfxBrixelizerRawCascadeUpdateDescription struct with the parameters for the cascade update.
- **size** (`size_t *`) - [out] A size_t to store the required scratch buffer size to.

### Returns
`FFX_API FfxErrorCode`

### Source
`sdk/include/FidelityFX/host/ffx_brixelizer_raw.h` (line 470, column 22)
```

--------------------------------

### InitSdkContexts()

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_cacao_sample/cacaorendermodule/cacao_r_m

Initializes the SDK contexts.

```APIDOC
## InitSdkContexts()

### Description
Initializes the SDK contexts.

### Method
Member function

### Signature
```cpp
void InitSdkContexts()
```

### Source
`samples/cacao/cacaorendermodule.h` (line 388, column 10)
```

--------------------------------

### GetInterpolant

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/cauldron/render/cauldron_render

Gets the AnimInterpolants for the given index (frame). Returns a pointer to the offsetted interpolant data.

```APIDOC
## GetInterpolant

### Description
Gets the AnimInterpolants for the given index (frame). Returns a pointer to the offsetted interpolant data.

### Signature
```cpp
const void * GetInterpolant(const AnimInterpolants *pInterpolant, int32_t index)
```

### Parameters
- **pInterpolant** (`const AnimInterpolants *`) - [in] The animation interpolants to read from.
- **index** (`int32_t`) - [in] The index of frame of the data to fetch.

### Returns
`const void *`

### Source
`framework/cauldron/framework/inc/render/animation.h` (line 59, column 16)
```

--------------------------------

### SetupFidelityFxInterface()

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_depth_of_field_sample/dofrendermodule/dof_r_m

Sets up the FidelityFX interface. No description provided in the source.

```APIDOC
## SetupFidelityFxInterface()

### Description
No description provided.

### Method
Member function

### Signature
```cpp
void SetupFidelityFxInterface()
```

### Source
`samples/dof/dofrendermodule.h` (line 91, column 10)
```

--------------------------------

### GetRecommendedThreadCount

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/cauldron/miscellaneous/corecounts/cauldron_core_counts

Gets the recommended thread pool size. Returns the recommended number of threads to create.

```APIDOC
## GetRecommendedThreadCount

### Description
Gets the recommended thread pool size.

### Method
Function

### Signature
```cpp
uint32_t GetRecommendedThreadCount()
```

### Parameters
None.

### Returns
- **uint32_t** - The recommended number of threads to create.

### Source
`framework/cauldron/framework/inc/misc/corecounts.h` (line 40, column 14)
```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/classes/c_a_s_render_module

Initializes the FFX API Context, sets up the internal color texture used as temporary input, and sets up the UI section for CAS.

```APIDOC
## Init(const json &initData)

### Description
Initialize FFX API Context, setup the internal color texture used as temporary input, and setup UI section for CAS.

### Method
Public Function

### Signature
```cpp
virtual void Init(const json &initData) override
```

### Parameters
- **initData** (const json &) - Required - Initialization data.

### Attributes
- `virtual`

### Source
`samples/cas/casrendermodule.h` (line 70, column 18)
```

--------------------------------

### InitUI(cauldron::UISection *uiSection)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/classes/f_s_r_render_module

Init UI.

```APIDOC
## InitUI(cauldron::UISection *uiSection)

### Description
Init UI.

### Method
InitUI

### Signature
```cpp
void InitUI(cauldron::UISection *uiSection)
```

### Parameters
- **uiSection** (`cauldron::UISection *`) - Required - Pointer to the UI section.

### Source
`samples/fsrapi/fsrapirendermodule.h` (line 89, column 10)
```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/classes/lighting_render_module

Initialization function that sets up resource pointers, pipeline objects, root signatures, and parameter sets for the lighting render module.

```APIDOC
## Init(const json &initData)

### Description
Initialization function that sets up resource pointers, pipeline objects, root signatures, and parameter sets for the lighting render module.

### Method
Init

### Signature
```cpp
virtual void Init(const json &initData) override
```

### Parameters
- **initData** (const json &) - Required - Initialization data.

### Attributes
- `virtual`

### Source
`framework/rendermodules/lighting/lightingrendermodule.h` (line 65, column 10)
```

--------------------------------

### FindClosestInterpolant

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/cauldron/render/cauldron_render

Gets the closest AnimInterpolants for the given animation value. Returns the index of the closest interpolant data to the desired value.

```APIDOC
## FindClosestInterpolant

### Description
Gets the closest AnimInterpolants for the given animation value. Returns the index of the closest interpolant data to the desired value.

### Signature
```cpp
int32_t FindClosestInterpolant(const AnimInterpolants *pInterpolant, float value)
```

### Parameters
- **pInterpolant** (`const AnimInterpolants *`) - [in] The animation interpolants to read from.
- **value** (`float`) - [in] The value (time) at which to get nearest interpolated data from.

### Returns
`int32_t`

### Source
`framework/cauldron/framework/inc/render/animation.h` (line 69, column 13)
```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/classes/raster_shadow_render_module

Initialization function. Sets up resource pointers, pipeline objects, root signatures, and parameter sets.

```APIDOC
## Init(const json &initData)

### Description
Initialization function. Sets up resource pointers, pipeline objects, root signatures, and parameter sets.

### Method
Virtual function

### Signature
```cpp
virtual void Init(const json &initData) override
```

### Parameters
- `initData` (const json &) - Required - Initialization data.

### Attributes
- `virtual`

### Source
`framework/rendermodules/rastershadow/rastershadowrendermodule.h` (line 73, column 10)
```

--------------------------------

### ffxFsr3UpscalerGetUpscaleRatioFromQualityMode

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_fsr3/ffx_fsr3_upscaler

Gets the upscale ratio from the quality mode. The function returns the per-dimension scaling ratio for the given quality mode preset.

```APIDOC
## ffxFsr3UpscalerGetUpscaleRatioFromQualityMode

### Description
Get the upscale ratio from the quality mode. The following table enumerates the mapping of the quality modes to per-dimension scaling ratios.

| Quality preset | Scale factor |
| --- | --- |
| FFX_FSR3UPSCALER_QUALITY_MODE_QUALITY | 1.5x |
| FFX_FSR3UPSCALER_QUALITY_MODE_BALANCED | 1.7x |
| FFX_FSR3UPSCALER_QUALITY_MODE_PERFORMANCE | 2.0x |
| FFX_FSR3UPSCALER_QUALITY_MODE_ULTRA_PERFORMANCE | 3.0x |

Passing an invalid qualityMode will return 0.0f.

### Function Signature
```c
FFX_API float ffxFsr3UpscalerGetUpscaleRatioFromQualityMode(FfxFsr3UpscalerQualityMode qualityMode)
```

### Parameters
- **qualityMode** (`FfxFsr3UpscalerQualityMode`) - [in] The quality mode preset.

### Returns
`FFX_API float` - The upscaling the per-dimension upscaling ratio for qualityMode according to the table above.

### Source
`sdk/include/FidelityFX/host/ffx_fsr3upscaler.h` (line 420, column 15)

```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_brixelizer_sample/brixelizer_rendermodule/brixelizer_r_m

Tear down the FFX API Context and release resources.

```APIDOC
## Init(const json &initData)

### Description
Tear down the FFX API Context and release resources.

### Signature
```cpp
virtual void Init(const json &initData) override
```

### Parameters
- **initData** (`const json &`) - Required - Initialization data.

### Attributes
- `virtual`

### Source
`samples/brixelizergi/brixelizergirendermodule.h` (line 79, column 10)
```

--------------------------------

### LPMRenderModule::Init()

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/classes/l_p_m_render_module

Initializes the LPM render module by setting up the parameters used as input to tone and gamut mapping, including input/output resources and all parameters described in the ffx_lpm header.

```APIDOC
## LPMRenderModule::Init()

### Description
Initializes the LPM render module by setting up the parameters used as input to tone and gamut mapping, including input/output resources and all parameters described in the ffx_lpm header.

### Method
Init()

### Parameters
- None explicitly documented.

### Returns
- None explicitly documented.

```

--------------------------------

### ffxFsr2GetUpscaleRatioFromQualityMode

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_fsr2/ffx_fsr2

Gets the upscale ratio from the quality mode. The following table enumerates the mapping of the quality modes to per-dimension scaling ratios.

```APIDOC
## ffxFsr2GetUpscaleRatioFromQualityMode

### Description
Get the upscale ratio from the quality mode. The following table enumerates the mapping of the quality modes to per-dimension scaling ratios.

| Quality preset | Scale factor |
|----------------|--------------|
| FFX_FSR2_QUALITY_MODE_QUALITY | 1.5x |
| FFX_FSR2_QUALITY_MODE_BALANCED | 1.7x |
| FFX_FSR2_QUALITY_MODE_PERFORMANCE | 2.0x |
| FFX_FSR2_QUALITY_MODE_ULTRA_PERFORMANCE | 3.0x |

Passing an invalid qualityMode will return 0.0f.

### Function Signature
`FFX_API float ffxFsr2GetUpscaleRatioFromQualityMode(FfxFsr2QualityMode qualityMode)`

### Parameters
- **qualityMode** (FfxFsr2QualityMode) - [in] The quality mode preset.

### Returns
- **float** - The per-dimension upscaling ratio for qualityMode according to the table above.
```

--------------------------------

### Execute(double deltaTime, cauldron::CommandList *pCmdList)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/classes/c_a_s_render_module

Sets up input/output texture and parameters FFX API needs this frame and then calls the FFX Dispatch.

```APIDOC
## Execute(double deltaTime, cauldron::CommandList *pCmdList)

### Description
Setup input/output texture and parameters FFX API needs this frame and then call the FFX Dispatch.

### Method
Public Function

### Signature
```cpp
virtual void Execute(double deltaTime, cauldron::CommandList *pCmdList) override
```

### Parameters
- **deltaTime** (double) - Required - Time delta since last frame.
- **pCmdList** (cauldron::CommandList *) - Required - Pointer to the command list.

### Attributes
- `virtual`

### Source
`samples/cas/casrendermodule.h` (line 75, column 18)
```

--------------------------------

### ADLXHelper_GetAdlMapping

Source: https://gpuopen.com/manuals/adlx/adlx-sdk-references/adlx-helpers/adlx-helper-functions/adlxhelper-getadlmapping

Gets the ADL Mapping interface. Returns a valid pointer to IADLMapping if ADLX was successfully initialized with ADL, otherwise nullptr.

```APIDOC
## ADLXHelper_GetAdlMapping

### Description
Gets the ADL Mapping interface. This function is used to convert data between ADL and ADLX in applications where ADLX was initialized with ADLXHelper_InitializeWithCallerAdl.

### Syntax
```
IADLMapping* ADLXHelper_GetAdlMapping ()
```

### Parameters
N/A

### Return Value
If ADLX was successfully initialized with ADL, a valid pointer of the IADLMapping interface is returned. If ADLX was initialized under any of the following circumstances, **nullptr** is returned:
- ADLX initialization was with other initialization methods.
- ADLX initialization was failed.
- ADLX initialization was not called.

### Remarks
**ADLXHelper_GetAdlMapping** is used to convert data between ADL and ADLX in applications where ADLX was initialized with ADLXHelper_InitializeWithCallerAdl.

### Requirements
| Header | Minimum version |
| --- | --- |
| include "ADLXHelper/Windows/C/ADLXHelper.h" | 1.0 |

### See Also
- IADLMapping
- ADLXHelper_InitializeWithCallerAdl
```

--------------------------------

### ffxBrixelizerRawGetCascadeToUpdate

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/effect_components/fidelityfx_brixelizer/ffx_brixelizer

Gets the index of the recommended cascade to update given the total number of cascades and current frame. Follows a pattern that updates more detailed cascades more often.

```APIDOC
## ffxBrixelizerRawGetCascadeToUpdate

### Description
Gets the index of the recommended cascade to update given the total number of cascades and current frame. Follows a pattern that updates more detailed cascades more often.

### Method
Function

### Signature
`FFX_API uint32_t ffxBrixelizerRawGetCascadeToUpdate(uint32_t frameIndex, uint32_t maxCascades)`

### Parameters
- **frameIndex** (`uint32_t`) - [in] The current frame index.
- **maxCascades** (`uint32_t`) - [in] The total number of cascades.

### Returns
`FFX_API uint32_t` - The index of the cascade to update.

### Source
`sdk/include/FidelityFX/host/ffx_brixelizer_raw.h` (line 660, column 22)
```

--------------------------------

### FfxCalculateLpmConsts

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/sdk/gpu/fidelityfx_gpu_references/fidelityfx_lpm/ffx_g_p_u_lpm

Sets up required constant values for LPM (works on CPU or GPU). Output goes to the user-defined LpmSetupOut() function.

```APIDOC
## FfxCalculateLpmConsts

### Description
Sets up required constant values for LPM (works on CPU or GPU). Output goes to the user-defined LpmSetupOut() function.

### Function Signature
```
FFX_STATIC void FfxCalculateLpmConsts(FfxBoolean shoulder, FfxBoolean con, FfxBoolean soft, FfxBoolean con2, FfxBoolean clip, FfxBoolean scaleOnly, FfxFloat32x2 xyRedW, FfxFloat32x2 xyGreenW, FfxFloat32x2 xyBlueW, FfxFloat32x2 xyWhiteW, FfxFloat32x2 xyRedO, FfxFloat32x2 xyGreenO, FfxFloat32x2 xyBlueO, FfxFloat32x2 xyWhiteO, FfxFloat32x2 xyRedC, FfxFloat32x2 xyGreenC, FfxFloat32x2 xyBlueC, FfxFloat32x2 xyWhiteC, FfxFloat32 scaleC, FfxFloat32 softGap, FfxFloat32 hdrMax, FfxFloat32 exposure, FfxFloat32 contrast, FfxFloat32 shoulderContrast, FfxFloat32x3 saturation, FfxFloat32x3 crosstalk)
```

### Parameters
- **shoulder** (FfxBoolean) - [in] Use optional extra shoulderContrast tuning (set to false if shoulderContrast is 1.0).
- **con** (FfxBoolean) - [in] Use first RGB conversion matrix, if 'soft' then 'con' must be true also.
- **soft** (FfxBoolean) - [in] Use soft gamut mapping.
- **con2** (FfxBoolean) - [in] Use last RGB conversion matrix.
- **clip** (FfxBoolean) - [in] Use clipping in last conversion matrix.
- **scaleOnly** (FfxBoolean) - [in] Scale only for last conversion matrix (used for 709 HDR to scRGB).
- **xyRedW** (FfxFloat32x2) - [in] Red Chroma coordinates for working color space.
- **xyGreenW** (FfxFloat32x2) - [in] Green Chroma coordinates for working color space.
- **xyBlueW** (FfxFloat32x2) - [in] Blue Chroma coordinates for working color space.
- **xyWhiteW** (FfxFloat32x2) - [in] White Chroma coordinates for working color space.
- **xyRedO** (FfxFloat32x2) - [in] Red Chroma coordinates for output color space.
- **xyGreenO** (FfxFloat32x2) - [in] Green Chroma coordinates for output color space.
- **xyBlueO** (FfxFloat32x2) - [in] Blue Chroma coordinates for output color space.
- **xyWhiteO** (FfxFloat32x2) - [in] White Chroma coordinates for output color space.
- **xyRedC** (FfxFloat32x2) - [in] Red Chroma coordinates for output container or display colour space.
- **xyGreenC** (FfxFloat32x2) - [in] Green Chroma coordinates for output container or display color space.
- **xyBlueC** (FfxFloat32x2) - [in] Blue Chroma coordinates for output container or display color space.
- **xyWhiteC** (FfxFloat32x2) - [in] White Chroma coordinates for output container or display color space.
- **scaleC** (FfxFloat32) - [in] scale factor for PQ or scRGB adjustment
- **softGap** (FfxFloat32) - [in] Range of 0 to a little over zero, controls how much feather region in out-of-gamut mapping, 0=clip.
- **hdrMax** (FfxFloat32) - [in] Maximum input value.
- **exposure** (FfxFloat32) - [in] Number of stops between 'hdrMax' and 18% mid-level on input.
- **contrast** (FfxFloat32) - [in] Input range {0.0 (no extra contrast) to 1.0 (maximum contrast)}.
- **shoulderContrast** (FfxFloat32) - [in] Shoulder shaping, 1.0 = no change (fast path).
- **saturation** (FfxFloat32x3) - [in] A per channel adjustment, use <0 decrease, 0=no change,>0 increase.
- **crosstalk** (FfxFloat32x3) - [in] One channel must be 1.0, the rest can be <= 1.0 but not zero. Lenghtnes colours path to white by walking across gamut. Check documentation for usage

### Returns
FFX_STATIC void

### Source
sdk/include/FidelityFX/gpu/lpm/ffx_lpm.h (line 180, column 17)
```

--------------------------------

### Init(const json &initData)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/classes/g_buffer_render_module

Initialization function. Sets up target pointers and other global data.

```APIDOC
## Init(const json &initData)

### Description
Initialization function. Sets up target pointers and other global data.

### Method
Init

### Signature
```cpp
virtual void Init(const json &initData) override
```

### Parameters
- `initData` (const json &) - Required - Initialization data.

### Attributes
- `virtual`

### Source
`framework/rendermodules/gbuffer/gbufferrendermodule.h` (line 72, column 10)
```

--------------------------------

### Execute(double deltaTime, cauldron::CommandList *pCmdList)

Source: https://gpuopen.com/manuals/fidelityfx_sdk/reference_documentation/samples/effect_samples/fidelityfx_brixelizer_sample/brixelizer_rendermodule/brixelizer_r_m

Submit dynamic instances, dispatch Brixelizer workloads and visualize sparse distance field using the example shader.

```APIDOC
## Execute(double deltaTime, cauldron::CommandList *pCmdList)

### Description
Submit dynamic instances, dispatch Brixelizer workloads and visualize sparse distance field using the example shader.

### Signature
```cpp
virtual void Execute(double deltaTime, cauldron::CommandList *pCmdList) override
```

### Parameters
- **deltaTime** (`double`) - Required - Time delta since last frame.
- **pCmdList** (`cauldron::CommandList *`) - Required - Pointer to the command list.

### Attributes
- `virtual`

### Source
`samples/brixelizergi/brixelizergirendermodule.h` (line 89, column 10)
```
Tokens:
Raw