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

#include <blitCmdsOps.h>

Public Member Functions

 HgiBufferGpuToGpuOp ()

Public Attributes

HgiBufferHandle gpuSourceBuffer
size_t sourceByteOffset
size_t byteSize
HgiBufferHandle gpuDestinationBuffer
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.
  • insert the appropriate barriers in the command buffer prior to reading/writing to/from the resources.
  • gpuSourceBuffer: The gpu buffer to copy pixels from.
  • sourceByteOffset: The byte offset in source buffer to start copying the data from.
  • byteSize: Size of the data (in bytes) to copy
  • gpuDestinationBuffer: The copy destination cpu buffer.
  • destinationByteOffset: The byte offset in destination buffer where to start copying the data to.

Definition at line 120 of file blitCmdsOps.h.

Constructor & Destructor Documentation

HgiBufferGpuToGpuOp::HgiBufferGpuToGpuOp ( )

Definition at line 122 of file blitCmdsOps.h.

Member Data Documentation

size_t HgiBufferGpuToGpuOp::byteSize

Definition at line 132 of file blitCmdsOps.h.

size_t HgiBufferGpuToGpuOp::destinationByteOffset

Definition at line 134 of file blitCmdsOps.h.

HgiBufferHandle HgiBufferGpuToGpuOp::gpuDestinationBuffer

Definition at line 133 of file blitCmdsOps.h.

HgiBufferHandle HgiBufferGpuToGpuOp::gpuSourceBuffer

Definition at line 130 of file blitCmdsOps.h.

size_t HgiBufferGpuToGpuOp::sourceByteOffset

Definition at line 131 of file blitCmdsOps.h.

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