namespace SDKWrapper

namespace SDKWrapper {

Functions

Detailed description

Global functions

ffxGetScratchMemorySize

Copied!

size_t ffxGetScratchMemorySize (size_t maxContexts)

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


ffxGetInterface

Copied!

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

Initialize the FfxInterface with function pointers for the backend.


ffxGetCommandList

Copied!

FfxCommandList  ffxGetCommandList (cauldron::CommandList * cauldronCmdList)

Create a FfxCommandList from a CommandList.


ffxGetPipeline

Copied!

FfxPipeline  ffxGetPipeline (cauldron::PipelineObject * cauldronPipeline)

Create a FfxPipeline from a PipelineObject.


ffxGetResource

Copied!

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.


ffxReplaceSwapchainForFrameinterpolation

Copied!

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

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


ffxRegisterFrameinterpolationUiResource

Copied!

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.


ffxGetInterpolationCommandlist

Copied!

FfxErrorCode  ffxGetInterpolationCommandlist (
    FfxSwapchain gameSwapChain,
    FfxCommandList & gameCommandlist
)

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


ffxGetSwapchain

Copied!

FfxSwapchain ffxGetSwapchain (cauldron::SwapChain * pSwapChain)

Fetch a FfxSwapchain from a Cauldron SwapChain.


ffxGetCommandQueue

Copied!

FfxCommandQueue ffxGetCommandQueue (cauldron::Device * pDevice)

Fetch a FfxCommandQueue from a Cauldron Device.


ffxGetResourceDescription

Copied!

FfxResourceDescription  ffxGetResourceDescription (cauldron::GPUResource * pResource)

Fetch a FfxResourceDescription from a Cauldron GPUResource.


ffxGetFrameinterpolationTexture

Copied!

FfxResource  ffxGetFrameinterpolationTexture (FfxSwapchain ffxSwapChain)

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


ffxSetupFrameInterpolationSwapChain

Copied!

void ffxSetupFrameInterpolationSwapChain ()

Configures the swap chain for FSR 3 interpolation.


ffxRestoreApplicationSwapChain

Copied!

void ffxRestoreApplicationSwapChain ()

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


ffxAllocateConstantBuffer

Copied!

FfxConstantAllocation ffxAllocateConstantBuffer (
    void* data,
    FfxUInt64  dataSize
)

Performs constant buffer allocation using our own allocator.


Related pages

  • Visit the FidelityFX SDK product page for download links and more information.

Looking for more documentation on GPUOpen?

AMD GPUOpen software blogs

Our handy software release blogs will help you make good use of our tools, SDKs, and effects, as well as sharing the latest features with new releases.

GPUOpen Manuals

Don’t miss our manual documentation! And if slide decks are what you’re after, you’ll find 100+ of our finest presentations here.

AMD GPUOpen Performance Guides

The home of great performance and optimization advice for AMD RDNAâ„¢ 2 GPUs, AMD Ryzenâ„¢ CPUs, and so much more.

Getting started: AMD GPUOpen software

New or fairly new to AMD’s tools, libraries, and effects? This is the best place to get started on GPUOpen!

AMD GPUOpen Getting Started Development and Performance

Looking for tips on getting started with developing and/or optimizing your game, whether on AMD hardware or generally? We’ve got you covered!

AMD GPUOpen Technical blogs

Browse our technical blogs, and find valuable advice on developing with AMD hardware, ray tracing, Vulkan®, DirectX®, Unreal Engine, and lots more.

Find out more about our software!

AMD GPUOpen Effects - AMD FidelityFX technologies

Create wonder. No black boxes. Meet the AMD FidelityFX SDK!

AMD GPUOpen Samples

Browse all our useful samples. Perfect for when you’re needing to get started, want to integrate one of our libraries, and much more.

AMD GPUOpen developer SDKs

Discover what our SDK technologies can offer you. Query hardware or software, manage memory, create rendering applications or machine learning, and much more!

AMD GPUOpen Developer Tools

Analyze, Optimize, Profile, Benchmark. We provide you with the developer tools you need to make sure your game is the best it can be!