class RootSignature

The FidelityFX Cauldron Framework api/platform-agnostic representation of the root signature.

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

Methods

Return type

Description

static RootSignature*

CreateRootSignature (const wchar_t* name, const RootSignatureDesc & desc)
RootSignature instance creation function. Implemented per api/platform to return the correct internal resource type.

PipelineType

Returns the “PipelineType“ associated with this root signature.

const wchar_t*

GetName () const
Returns the root signature’s name.

const std::vector<BindingDesc >&

Returns the vector of binding descriptions.

const int32_t

GetBindingDescOffset (BindingType bindType) const
Returns the binding description offset by binding type.

RootSignatureInternal*

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

const RootSignatureInternal*

GetImpl () const = 0

Detailed description

The FidelityFX Cauldron Framework api/platform-agnostic representation of the root signature.

Methods

CreateRootSignature

Copied!

static RootSignature* CreateRootSignature (
    const wchar_t* name,
    const RootSignatureDesc & desc
)

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


GetPipelineType

Copied!

PipelineType  GetPipelineType () const

Returns the PipelineType associated with this root signature.


GetName

Copied!

const wchar_t* GetName () const

Returns the root signature’s name.


GetBindingDescriptions

Copied!

const std::vector<BindingDesc >& GetBindingDescriptions () const

Returns the vector of binding descriptions.


GetBindingDescOffset

Copied!

const int32_t GetBindingDescOffset (BindingType  bindType) const

Returns the binding description offset by binding type.


GetImpl

Copied!

virtual RootSignatureInternal* GetImpl () = 0

Gets the internal implementation for api/platform parameter accessors.