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

#include <blitCmdsOps.h>

Public Member Functions

 HgiTextureToBufferOp ()

Public Attributes

HgiTextureHandle gpuSourceTexture
GfVec3i sourceTexelOffset
uint32_t mipLevel
HgiBufferHandle gpuDestinationBuffer
size_t destinationByteOffset
size_t byteSize

Detailed Description

Describes the properties needed to copy GPU texture data into a GPU buffer.

It is the responsibility of the caller to:

  • ensure the destination buffer is large enough to receive the data (keep in mind the destinationByteOffset).
  • ensure the source texture and destination buffer are valid at the time the command is executed.
  • gpuSourceTexture: The gpu texture to copy pixels from.
  • mipLevel: Mip level to copy from.
  • gpuDestinationBuffer: The GPU buffer to copy the data into.
  • destinationByteOffset: The byte offset in destination buffer where to start copying the data to.
  • byteSize: Size of the data (in bytes) to copy

Definition at line 270 of file blitCmdsOps.h.

Constructor & Destructor Documentation

HgiTextureToBufferOp::HgiTextureToBufferOp ( )

Definition at line 272 of file blitCmdsOps.h.

Member Data Documentation

size_t HgiTextureToBufferOp::byteSize

Definition at line 286 of file blitCmdsOps.h.

size_t HgiTextureToBufferOp::destinationByteOffset

Definition at line 285 of file blitCmdsOps.h.

HgiBufferHandle HgiTextureToBufferOp::gpuDestinationBuffer

Definition at line 284 of file blitCmdsOps.h.

HgiTextureHandle HgiTextureToBufferOp::gpuSourceTexture

Definition at line 281 of file blitCmdsOps.h.

uint32_t HgiTextureToBufferOp::mipLevel

Definition at line 283 of file blitCmdsOps.h.

GfVec3i HgiTextureToBufferOp::sourceTexelOffset

Definition at line 282 of file blitCmdsOps.h.

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