SDKWrapper

SDKWrapper

Functions

ffxGetScratchMemorySize

size_t ffxGetScratchMemorySize(size_t maxContexts)

Query how much memory is required for the backend’s scratch buffer.

Parameters:

Name	Type	Default
maxContexts	size_t	“

Returns: size_t

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 55, column 16)

ffxGetInterface

FfxErrorCode ffxGetInterface(FfxInterface *backendInterface, cauldron::Device *device, void *scratchBuffer, size_t scratchBufferSize, size_t maxContexts)

Initialize the FfxInterface with function pointers for the backend.

Parameters:

Name	Type	Default
backendInterface	FfxInterface *	“
device	cauldron::Device *	“
scratchBuffer	void *	“
scratchBufferSize	size_t	“
maxContexts	size_t	“

Returns: FfxErrorCode

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 59, column 16)

ffxGetCommandList

FfxCommandList ffxGetCommandList(cauldron::CommandList *cauldronCmdList)

Create a FfxCommandList from a CommandList.

Parameters:

Name	Type	Default
cauldronCmdList	cauldron::CommandList *	“

Returns: FfxCommandList

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 63, column 16)

ffxGetPipeline

FfxPipeline ffxGetPipeline(cauldron::PipelineObject *cauldronPipeline)

Create a FfxPipeline from a PipelineObject.

Parameters:

Name	Type	Default
cauldronPipeline	cauldron::PipelineObject *	“

Returns: FfxPipeline

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 67, column 16)

ffxGetResource

FfxResource ffxGetResource(const cauldron::GPUResource *cauldronResource, const wchar_t *name=nullptr, FfxResourceStates state=FFX_RESOURCE_STATE_COMPUTE_READ, FfxResourceUsage additionalUsages=(FfxResourceUsage) 0)

Fetch a FfxResource from a GPUResource.

Parameters:

Name	Type	Default
cauldronResource	const cauldron::GPUResource *	“
name	const wchar_t *	nullptr
state	FfxResourceStates	FFX_RESOURCE_STATE_COMPUTE_READ
additionalUsages	FfxResourceUsage	(FfxResourceUsage) 0

Returns: FfxResource

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 71, column 16)

ffxReplaceSwapchainForFrameinterpolation

FfxErrorCode ffxReplaceSwapchainForFrameinterpolation(FfxCommandQueue gameQueue, FfxSwapchain &gameSwapChain, const void *replacementParameters)

Replaces the current swapchain with the provided FfxSwapchain for FSR 3 frame interpolation support.

Parameters:

Name	Type	Default
gameQueue	FfxCommandQueue	“
gameSwapChain	FfxSwapchain &	“
replacementParameters	const void *	“

Returns: FfxErrorCode

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 117, column 24)

ffxRegisterFrameinterpolationUiResource

FfxErrorCode ffxRegisterFrameinterpolationUiResource(FfxSwapchain gameSwapChain, FfxResource uiResource, uint32_t flags)

Registers a FfxResource to use for UI with the provided FfxSwapchain for FSR 3 frame interpolation support.

Parameters:

Name	Type	Default
gameSwapChain	FfxSwapchain	“
uiResource	FfxResource	“
flags	uint32_t	“

Returns: FfxErrorCode

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 121, column 24)

ffxGetInterpolationCommandlist

FfxErrorCode ffxGetInterpolationCommandlist(FfxSwapchain gameSwapChain, FfxCommandList &gameCommandlist)

Fetches a FfxCommandList from the FfxSwapchain for FSR 3 frame interpolation support for FSR 3 frame interpolation support.

Parameters:

Name	Type	Default
gameSwapChain	FfxSwapchain	“
gameCommandlist	FfxCommandList &	“

Returns: FfxErrorCode

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 125, column 24)

ffxGetSwapchain

FfxSwapchain ffxGetSwapchain(cauldron::SwapChain *pSwapChain)

Fetch a FfxSwapchain from a Cauldron SwapChain.

Parameters:

Name	Type	Default
pSwapChain	cauldron::SwapChain *	“

Returns: FfxSwapchain

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 129, column 24)

ffxGetCommandQueue

FfxCommandQueue ffxGetCommandQueue(cauldron::Device *pDevice)

Fetch a FfxCommandQueue from a Cauldron Device.

Parameters:

Name	Type	Default
pDevice	cauldron::Device *	“

Returns: FfxCommandQueue

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 133, column 24)

ffxGetResourceDescription

FfxResourceDescription ffxGetResourceDescription(cauldron::GPUResource *pResource)

Fetch a FfxResourceDescription from a Cauldron GPUResource.

Parameters:

Name	Type	Default
pResource	cauldron::GPUResource *	“

Returns: FfxResourceDescription

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 137, column 24)

ffxGetFrameinterpolationTexture

FfxResource ffxGetFrameinterpolationTexture(FfxSwapchain ffxSwapChain)

Fetches a FfxResource representing the backbuffer from the FfxSwapchain for FSR 3 frame interpolation support.

Parameters:

Name	Type	Default
ffxSwapChain	FfxSwapchain	“

Returns: FfxResource

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 141, column 24)

ffxSetupFrameInterpolationSwapChain

void ffxSetupFrameInterpolationSwapChain()

Configures the swap chain for FSR 3 interpolation.

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 145, column 24)

ffxRestoreApplicationSwapChain

void ffxRestoreApplicationSwapChain()

Restores previous configuration swap chain to state before FSR 3 interpolation was configured (see ffxSetupFrameInterpolationSwapChain).

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 149, column 24)

ffxAllocateConstantBuffer

FfxConstantAllocation ffxAllocateConstantBuffer(void *data, FfxUInt64 dataSize)

Performs constant buffer allocation using our own allocator.

Parameters:

Name	Type	Default
data	void *	“
dataSize	FfxUInt64	“

Returns: FfxConstantAllocation

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 154, column 23)

GetFrameworkSurfaceFormat

static cauldron::ResourceFormat GetFrameworkSurfaceFormat(FfxSurfaceFormat format)

Parameters:

Name	Type	Default
format	FfxSurfaceFormat	“

Returns: cauldron::ResourceFormat

Attributes: static

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 159, column 33)

GetFrameworkResourceFlags

static cauldron::ResourceFlags GetFrameworkResourceFlags(FfxResourceUsage flags)

Parameters:

Name	Type	Default
flags	FfxResourceUsage	“

Returns: cauldron::ResourceFlags

Attributes: static

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 225, column 32)

GetFrameworkState

inline cauldron::ResourceState GetFrameworkState(FfxResourceStates state)

Parameters:

Name	Type	Default
state	FfxResourceStates	“

Returns: cauldron::ResourceState

Attributes: inline

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 244, column 32)

GetFrameworkTextureDescription

inline cauldron::TextureDesc GetFrameworkTextureDescription(FfxResourceDescription desc)

Parameters:

Name	Type	Default
desc	FfxResourceDescription	“

Returns: cauldron::TextureDesc

Attributes: inline

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 276, column 30)

GetFrameworkBufferDescription

inline cauldron::BufferDesc GetFrameworkBufferDescription(FfxResourceDescription desc)

Parameters:

Name	Type	Default
desc	FfxResourceDescription	“

Returns: cauldron::BufferDesc

Attributes: inline

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 296, column 29)

GetFfxSurfaceFormat

inline FfxSurfaceFormat GetFfxSurfaceFormat(cauldron::ResourceFormat format)

Parameters:

Name	Type	Default
format	cauldron::ResourceFormat	“

Returns: FfxSurfaceFormat

Attributes: inline

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 450, column 25)

GetFfxResourceDescription

inline FfxResourceDescription GetFfxResourceDescription(const cauldron::GPUResource *pResource, FfxResourceUsage additionalUsages)

Parameters:

Name	Type	Default
pResource	const cauldron::GPUResource *	“
additionalUsages	FfxResourceUsage	“

Returns: FfxResourceDescription

Attributes: inline

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 537, column 31)

Source: framework/cauldron/framework/inc/core/backend_interface.h (line 50, column 1)