RootSignatureDesc

The description structure used to construct FidelityFX Cauldron Framework ‘s RootSignature

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

Construction

Return type

Description
RootSignatureDesc ()
Construction. Implemented at api/platform level.
RootSignatureDesc (RootSignatureDesc&&)
RootSignatureDesc (const RootSignatureDesc&&)

Methods

Return type

Description

PipelineType
GetPipelineType () const
Gets the pipeline type for the root signature to create.

RootSignatureDesc&
operator = (RootSignatureDesc&&)
Move assignement operator. Handles impl memory in a custom fashion.

RootSignatureDesc&
operator = (const RootSignatureDesc&&)

void
AddTextureSRVSet ( uint32_t bindingIndex, ShaderBindStage bindStages, uint32_t count )
Add a texture srv set to the signature description.

void
AddTextureUAVSet ( uint32_t bindingIndex, ShaderBindStage bindStages, uint32_t count )
Add a texture uav set to the signature description.

void
AddBufferSRVSet ( uint32_t bindingIndex, ShaderBindStage bindStages, uint32_t count )
Add a buffer srv set to the signature description.

void
AddBufferUAVSet ( uint32_t bindingIndex, ShaderBindStage bindStages, uint32_t count )
Add a buffer uav set to the signature description.

void
AddRTAccelerationStructureSet ( uint32_t bindingIndex, ShaderBindStage bindStages, uint32_t count )
Add an rt acceleration structure set to the signature description.

void
AddSamplerSet ( uint32_t bindingIndex, ShaderBindStage bindStages, uint32_t count )
Add a sampler set to the signature description.

void
AddStaticSamplers ( uint32_t bindingIndex, ShaderBindStage bindStages, uint32_t count, const SamplerDesc * samplerDescList )
Add a static sampler set to the signature description.

void
AddConstantBufferSet ( uint32_t bindingIndex, ShaderBindStage bindStages, uint32_t count )
Add a constant buffer set to the signature description.

void
AddConstantBufferView ( uint32_t bindingIndex, ShaderBindStage bindStages, uint32_t count )
Add a constant buffer view to the signature description.

void
Add32BitConstantBuffer ( uint32_t bindingIndex, ShaderBindStage bindStages, uint32_t count )
Add a 32-bit push constant buffer to the signature description.

void
UpdatePipelineType (ShaderBindStage bindStages)
Sanity check to ensure root signature description is capable of being created.

Detailed description

The description structure used to construct FidelityFX Cauldron Framework ‘s RootSignature

Data fields

Type

Description

PipelineType
m_PipelineType
The pipeline type for the root signature.

RootSignatureDescInternal*
m_pSignatureDescImpl
The api/platform specific implementation pointer.

Construction

RootSignatureDesc

Copied!

RootSignatureDesc ()

Construction. Implemented at api/platform level.

Methods

GetPipelineType

Copied!

PipelineType  GetPipelineType () const

Gets the pipeline type for the root signature to create.

operator=

Copied!

RootSignatureDesc& operator =  (RootSignatureDesc&&)

Move assignement operator. Handles impl memory in a custom fashion.

AddTextureSRVSet

Copied!

void AddTextureSRVSet (
    uint32_t bindingIndex,
    ShaderBindStage  bindStages,
    uint32_t count
)

Add a texture srv set to the signature description.

AddTextureUAVSet

Copied!

void AddTextureUAVSet (
    uint32_t bindingIndex,
    ShaderBindStage  bindStages,
    uint32_t count
)

Add a texture uav set to the signature description.

AddBufferSRVSet

Copied!

void AddBufferSRVSet (
    uint32_t bindingIndex,
    ShaderBindStage  bindStages,
    uint32_t count
)

Add a buffer srv set to the signature description.

AddBufferUAVSet

Copied!

void AddBufferUAVSet (
    uint32_t bindingIndex,
    ShaderBindStage  bindStages,
    uint32_t count
)

Add a buffer uav set to the signature description.

AddRTAccelerationStructureSet

Copied!

void AddRTAccelerationStructureSet (
    uint32_t bindingIndex,
    ShaderBindStage  bindStages,
    uint32_t count
)

Add an rt acceleration structure set to the signature description.

AddSamplerSet

Copied!

void AddSamplerSet (
    uint32_t bindingIndex,
    ShaderBindStage  bindStages,
    uint32_t count
)

Add a sampler set to the signature description.

AddStaticSamplers

Copied!

void AddStaticSamplers (
    uint32_t bindingIndex,
    ShaderBindStage  bindStages,
    uint32_t count,
    const SamplerDesc * samplerDescList
)

Add a static sampler set to the signature description.

AddConstantBufferSet

Copied!

void AddConstantBufferSet (
    uint32_t bindingIndex,
    ShaderBindStage  bindStages,
    uint32_t count
)

Add a constant buffer set to the signature description.

AddConstantBufferView

Copied!

void AddConstantBufferView (
    uint32_t bindingIndex,
    ShaderBindStage  bindStages,
    uint32_t count
)

Add a constant buffer view to the signature description.

Add32BitConstantBuffer

Copied!

void Add32BitConstantBuffer (
    uint32_t bindingIndex,
    ShaderBindStage  bindStages,
    uint32_t count
)

Add a 32-bit push constant buffer to the signature description.

UpdatePipelineType

Copied!

void UpdatePipelineType (ShaderBindStage  bindStages)

Sanity check to ensure root signature description is capable of being created.