HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HgiTextureGpuToCpuOp Struct Reference

#include <blitCmdsOps.h>

Public Member Functions

 HgiTextureGpuToCpuOp ()
 

Public Attributes

HgiTextureHandle gpuSourceTexture
 
GfVec3i sourceTexelOffset
 
uint32_t mipLevel
 
uint32_t startLayer
 
uint32_t numLayers
 
voidcpuDestinationBuffer
 
size_t destinationByteOffset
 
size_t destinationBufferByteSize
 

Detailed Description

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

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.
  • insert the appropriate barriers in the command buffer prior to reading/writing to/from the resources.
  • gpuSourceTexture: The gpu texture to copy pixels from.
  • sourceTexelOffset: The texel offset (width, height, depth) of where to start copying.
  • mipLevel: Mip level to copy from.
  • startLayer: The first layer to start copying from.
  • numLayers: The number of layers to copy.
  • 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 72 of file blitCmdsOps.h.

Constructor & Destructor Documentation

HgiTextureGpuToCpuOp::HgiTextureGpuToCpuOp ( )
inline

Definition at line 74 of file blitCmdsOps.h.

Member Data Documentation

void* HgiTextureGpuToCpuOp::cpuDestinationBuffer

Definition at line 90 of file blitCmdsOps.h.

size_t HgiTextureGpuToCpuOp::destinationBufferByteSize

Definition at line 92 of file blitCmdsOps.h.

size_t HgiTextureGpuToCpuOp::destinationByteOffset

Definition at line 91 of file blitCmdsOps.h.

HgiTextureHandle HgiTextureGpuToCpuOp::gpuSourceTexture

Definition at line 85 of file blitCmdsOps.h.

uint32_t HgiTextureGpuToCpuOp::mipLevel

Definition at line 87 of file blitCmdsOps.h.

uint32_t HgiTextureGpuToCpuOp::numLayers

Definition at line 89 of file blitCmdsOps.h.

GfVec3i HgiTextureGpuToCpuOp::sourceTexelOffset

Definition at line 86 of file blitCmdsOps.h.

uint32_t HgiTextureGpuToCpuOp::startLayer

Definition at line 88 of file blitCmdsOps.h.


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