class PipelineObject

The FidelityFX Cauldron Framework pipeline object instance used to execute GPU workloads.

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

Methods

Return type

Description

static PipelineObject*

CreatePipelineObject ( const wchar_t* pipelineObjectName, const PipelineDesc & Desc, std::vector<const wchar_t*>* pAdditionalParameters = nullptr )
PipelineObject instance creation function. Implemented per api/platform to return the correct internal resource type.

PipelineType

Returns the “PipelineType“. Graphics or Compute.

const PipelineDesc &

Returns the “PipelineDesc“ description used to create the pipeline.

const wchar_t*

GetName () const
Returns the pipeline object’s name.

PipelineObjectInternal*

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

const PipelineObjectInternal*

GetImpl () const = 0

Detailed description

The FidelityFX Cauldron Framework pipeline object instance used to execute GPU workloads.

Methods

CreatePipelineObject

Copied!

static PipelineObject* CreatePipelineObject (
    const wchar_t* pipelineObjectName,
    const PipelineDesc & Desc,
    std::vector<const wchar_t*>* pAdditionalParameters = nullptr
)

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


GetPipelineType

Copied!

PipelineType  GetPipelineType () const

Returns the PipelineType. Graphics or Compute.


GetDesc

Copied!

const PipelineDesc & GetDesc ()

Returns the PipelineDesc description used to create the pipeline.


GetName

Copied!

const wchar_t* GetName () const

Returns the pipeline object’s name.


GetImpl

Copied!

virtual PipelineObjectInternal* GetImpl () = 0

Gets the internal implementation for api/platform parameter accessors.