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

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

#include <blitCmdsOps.h>

Public Attributes

HgiBufferHandle gpuSourceBuffer
 
size_t sourceByteOffset
 
size_t byteSize
 
void * cpuDestinationBuffer
 
size_t destinationByteOffset
 

Detailed Description

Describes the properties needed to copy buffer 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).
  • ensure the source buffer and destination buffer are valid at the time the command is executed.
  • gpuSourceBuffer: The gpu buffer to copy data from.
  • sourceByteOffset: The byte offset in source buffer to start copying the data from.
  • byteSize: Size of the data (in bytes) to copy
  • cpuDestinationBuffer: The copy destination cpu buffer.
  • destinationByteOffset: The byte offset in destination buffer where to start copying the data to.

Definition at line 230 of file blitCmdsOps.h.

Constructor & Destructor Documentation

◆ HgiBufferGpuToCpuOp()

HgiBufferGpuToCpuOp ( )
inline

Definition at line 232 of file blitCmdsOps.h.

Member Data Documentation

◆ byteSize

size_t byteSize

Definition at line 242 of file blitCmdsOps.h.

◆ cpuDestinationBuffer

void* cpuDestinationBuffer

Definition at line 243 of file blitCmdsOps.h.

◆ destinationByteOffset

size_t destinationByteOffset

Definition at line 244 of file blitCmdsOps.h.

◆ gpuSourceBuffer

HgiBufferHandle gpuSourceBuffer

Definition at line 240 of file blitCmdsOps.h.

◆ sourceByteOffset

size_t sourceByteOffset

Definition at line 241 of file blitCmdsOps.h.

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