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

#include <blitCmdsOps.h>

Public Member Functions

 HgiTextureCpuToGpuOp ()

Public Attributes

void constcpuSourceBuffer
size_t bufferByteSize
GfVec3i destinationTexelOffset
uint32_t mipLevel
HgiTextureHandle gpuDestinationTexture

Detailed Description

Describes the properties needed to copy texture data from CPU to GPU. This uploads one mip at a time.

It is the responsibility of the caller to:

  • ensure the destination textures is large enough to receive the data.
  • ensure the source buffer and destination texture are valid at the time the command is executed.
  • cpuSourceBuffer: Pointer to CPU source (ie. texels) to copy the data from.
  • bufferByteSize: Byte size (length) of cpuSourceBuffer.
  • destinationTexelOffset: The texel offset (width, height, depth) of where to upload the data. If the texture is a 2d_array the third element is the layer/slice.
  • mipLevel: Mip level to upload into.
  • gpuDestinationTexture: The GPU texture to upload the data into.

Definition at line 110 of file blitCmdsOps.h.

Constructor & Destructor Documentation

HgiTextureCpuToGpuOp::HgiTextureCpuToGpuOp ( )

Definition at line 112 of file blitCmdsOps.h.

Member Data Documentation

size_t HgiTextureCpuToGpuOp::bufferByteSize

Definition at line 121 of file blitCmdsOps.h.

void const* HgiTextureCpuToGpuOp::cpuSourceBuffer

Definition at line 120 of file blitCmdsOps.h.

GfVec3i HgiTextureCpuToGpuOp::destinationTexelOffset

Definition at line 122 of file blitCmdsOps.h.

HgiTextureHandle HgiTextureCpuToGpuOp::gpuDestinationTexture

Definition at line 124 of file blitCmdsOps.h.

uint32_t HgiTextureCpuToGpuOp::mipLevel

Definition at line 123 of file blitCmdsOps.h.

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