class CommandList

The FidelityFX Cauldron Framework api/platform-agnostic representation of a command list.

File location: framework/cauldron/framework/inc/render/commandlist.h

Methods

Return type

Description

const bool
GetRastering () const
Query whether we are currently between Begin/End Raster.

void
SetRastering (bool state)
Tells the CommandList we are doing rasterization work.

CommandQueue
GetQueueType () const
Get the CommandQueue type for this CommandList.

const CommandListInternal*
GetImpl () const = 0
Gets the internal implementation for api/platform parameter accessors.

CommandListInternal*
GetImpl () = 0

static CommandList*
CreateCommandList ( const wchar_t* Name, CommandQueue queueType, void* pInitParams )
CommandList instance creation function. Implemented per api/platform to return the correct internal resource type.

static CommandList*
GetWrappedCmdListFromSDK ( const wchar_t* name, CommandQueue queueType, void* pSDKCmdList )
Creates a framework command list from a FidelityFX SDK command list. This resource must be manually destroyed after use by the caller.

static void
ReleaseWrappedCmdList (CommandList* pCmdList)
Releases sdk-backed command list.

Detailed description

The FidelityFX Cauldron Framework api/platform-agnostic representation of a command list.

Methods

GetRastering

Copied!

const bool GetRastering () const

Query whether we are currently between Begin/End Raster.

SetRastering

Copied!

void SetRastering (bool state)

Tells the CommandList we are doing rasterization work.

GetQueueType

Copied!

CommandQueue  GetQueueType () const

Get the CommandQueue type for this CommandList.

GetImpl

Copied!

virtual const CommandListInternal* GetImpl () const = 0

Gets the internal implementation for api/platform parameter accessors.

CreateCommandList

Copied!

static CommandList* CreateCommandList (
    const wchar_t* Name,
    CommandQueue  queueType,
    void* pInitParams
)

CommandList instance creation function. Implemented per api/platform to return the correct internal resource type.

GetWrappedCmdListFromSDK

Copied!

static CommandList* GetWrappedCmdListFromSDK (
    const wchar_t* name,
    CommandQueue  queueType,
    void* pSDKCmdList
)

Creates a framework command list from a FidelityFX SDK command list. This resource must be manually destroyed after use by the caller.

ReleaseWrappedCmdList

Copied!

static void ReleaseWrappedCmdList (CommandList* pCmdList)

Releases sdk-backed command list.