class ResourceView

The FidelityFX Cauldron Framework api/platform-agnostic representation of the resource view.

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

Methods

Return type

Description

static ResourceView*
CreateResourceView ( ResourceViewHeapType type, uint32_t count, void* pInitParams )
ResourceView instance creation function. Implemented per api/platform to return the correct internal resource type.

const uint32_t
GetCount () const
Returns the number of entries in the resource view.

const ResourceViewHeapType
GetType () const
Returns the resource view type.

const ResourceViewInfo
GetViewInfo (uint32_t index = 0) const = 0
Returns the “ResourceViewInfo“.

void
BindTextureResource ( const GPUResource * pResource, const TextureDesc & texDesc, ResourceViewType type, ViewDimension dimension, int32_t mip, int32_t arraySize, int32_t firstArraySlice, uint32_t index = 0 ) = 0
Binds a texture resource view.

void
BindBufferResource ( const GPUResource * pResource, const BufferDesc & bufferDesc, ResourceViewType type, uint32_t firstElement, uint32_t numElements, uint32_t index = 0 ) = 0
Binds a buffer resource view.

void
BindSamplerResource (const Sampler * pSampler, uint32_t index = 0) = 0
Binds a sampler resource view.

Detailed description

The FidelityFX Cauldron Framework api/platform-agnostic representation of the resource view.

Methods

CreateResourceView

Copied!

static ResourceView* CreateResourceView (
    ResourceViewHeapType  type,
    uint32_t count,
    void* pInitParams
)

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

GetCount

Copied!

const uint32_t GetCount () const

Returns the number of entries in the resource view.

GetType

Copied!

const ResourceViewHeapType  GetType () const

Returns the resource view type.

GetViewInfo

Copied!

virtual const ResourceViewInfo  GetViewInfo (uint32_t index = 0) const = 0

Returns the ResourceViewInfo.

BindTextureResource

Copied!

virtual void BindTextureResource (
    const GPUResource * pResource,
    const TextureDesc & texDesc,
    ResourceViewType  type,
    ViewDimension  dimension,
    int32_t mip,
    int32_t arraySize,
    int32_t firstArraySlice,
    uint32_t index = 0
) = 0

Binds a texture resource view.

BindBufferResource

Copied!

virtual void BindBufferResource (
    const GPUResource * pResource,
    const BufferDesc & bufferDesc,
    ResourceViewType  type,
    uint32_t firstElement,
    uint32_t numElements,
    uint32_t index = 0
) = 0

Binds a buffer resource view.

BindSamplerResource

Copied!

virtual void BindSamplerResource (const Sampler * pSampler, uint32_t index = 0) = 0

Binds a sampler resource view.