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

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

#include <blitCmdsOps.h>

Public Attributes

void const * cpuSourceBuffer
 
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 ( )
inline

Definition at line 112 of file blitCmdsOps.h.

Member Data Documentation

◆ bufferByteSize

size_t bufferByteSize

Definition at line 121 of file blitCmdsOps.h.

◆ cpuSourceBuffer

void const* cpuSourceBuffer

Definition at line 120 of file blitCmdsOps.h.

◆ destinationTexelOffset

GfVec3i destinationTexelOffset

Definition at line 122 of file blitCmdsOps.h.

◆ gpuDestinationTexture

HgiTextureHandle gpuDestinationTexture

Definition at line 124 of file blitCmdsOps.h.

◆ mipLevel

uint32_t mipLevel

Definition at line 123 of file blitCmdsOps.h.

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