class UploadHeap

The FidelityFX Cauldron Framework api/platform-agnostic representation of the upload heap.

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

Methods

Return type

Description

static UploadHeap*
CreateUploadHeap ()
UploadHeap instance creation function. Implemented per api/platform to return the correct internal resource type.

void
InitAllocationBlocks ()
Initializes the allocation blocks.

const GPUResource *
GetResource () const
Returns the UploadHeap’s backing “GPUResource“.

GPUResource *
GetResource ()

uint8_t*
BasePtr ()
Returns the UploadHeap’s base data pointer.

TransferInfo *
BeginResourceTransfer ( size_t sliceSize, uint64_t sliceAlignment, uint32_t numSlices )
Returns a “TransferInfo“ instance setup to load a resource as requested.

void
EndResourceTransfer (TransferInfo * pTransferBlock)
Ends the resource transfer associated with the “TransferInfo“ pointer.

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

const UploadHeapInternal*
GetImpl () const = 0

Detailed description

The FidelityFX Cauldron Framework api/platform-agnostic representation of the upload heap.

Methods

CreateUploadHeap

Copied!

static UploadHeap* CreateUploadHeap ()

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

InitAllocationBlocks

Copied!

void InitAllocationBlocks ()

Initializes the allocation blocks.

GetResource

Copied!

const GPUResource * GetResource () const

Returns the UploadHeap’s backing GPUResource.

BasePtr

Copied!

uint8_t* BasePtr ()

Returns the UploadHeap’s base data pointer.

BeginResourceTransfer

Copied!

TransferInfo * BeginResourceTransfer (
    size_t sliceSize,
    uint64_t sliceAlignment,
    uint32_t numSlices
)

Returns a TransferInfo instance setup to load a resource as requested.

EndResourceTransfer

Copied!

void EndResourceTransfer (TransferInfo * pTransferBlock)

Ends the resource transfer associated with the TransferInfo pointer.

GetImpl

Copied!

virtual UploadHeapInternal* GetImpl () = 0

Gets the internal implementation for api/platform parameter accessors.