Loading...
Searching...
No Matches
Public Attributes | List of all members
HgiTextureToBufferOp Struct Reference

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

#include <blitCmdsOps.h>

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 ( )
inline

Definition at line 272 of file blitCmdsOps.h.

Member Data Documentation

◆ byteSize

size_t byteSize

Definition at line 286 of file blitCmdsOps.h.

◆ destinationByteOffset

size_t destinationByteOffset

Definition at line 285 of file blitCmdsOps.h.

◆ gpuDestinationBuffer

HgiBufferHandle gpuDestinationBuffer

Definition at line 284 of file blitCmdsOps.h.

◆ gpuSourceTexture

HgiTextureHandle gpuSourceTexture

Definition at line 281 of file blitCmdsOps.h.

◆ mipLevel

uint32_t mipLevel

Definition at line 283 of file blitCmdsOps.h.

◆ sourceTexelOffset

GfVec3i sourceTexelOffset

Definition at line 282 of file blitCmdsOps.h.

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