Describes the properties needed to copy texture data from GPU to CPU. More...

Public Attributes
HgiTextureHandle	gpuSourceTexture

GfVec3i	sourceTexelOffset

uint32_t	mipLevel

void *	cpuDestinationBuffer

size_t	destinationByteOffset

size_t	destinationBufferByteSize

Detailed Description

Describes the properties needed to copy texture data from GPU to CPU.

This copies one mip at a time.

It is the responsibility of the caller to:

ensure the destination buffer is large enough to receive the data (keep in mind the destinationByteOffset, mipLevel, numLayers, etc).
ensure the source texture and destination buffer are valid at the time the command is executed.

gpuSourceTexture: The gpu texture to copy pixels from.
sourceTexelOffset: The texel offset (width, height, depth) of where to start copying. If the texture is a 2d_array the third element is the layer/slice.
mipLevel: Mip level to copy from.
cpuDestinationBuffer: The copy destination cpu buffer.
destinationByteOffset: The byte offset in destination buffer where to start copying the data to.
destinationBufferByteSize: Size of the destination buffer (in bytes)

Definition at line 50 of file blitCmdsOps.h.

Constructor & Destructor Documentation

HgiTextureGpuToCpuOp ( )

inline

Definition at line 52 of file blitCmdsOps.h.

void* cpuDestinationBuffer

Definition at line 64 of file blitCmdsOps.h.

size_t destinationBufferByteSize

Definition at line 66 of file blitCmdsOps.h.

size_t destinationByteOffset

Definition at line 65 of file blitCmdsOps.h.

HgiTextureHandle gpuSourceTexture

Definition at line 61 of file blitCmdsOps.h.

uint32_t mipLevel

Definition at line 63 of file blitCmdsOps.h.

GfVec3i sourceTexelOffset

Definition at line 62 of file blitCmdsOps.h.

The documentation for this struct was generated from the following file: