HgiBufferToTextureOp Struct Reference

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

#include <blitCmdsOps.h>

Public Attributes
HgiBufferHandle	gpuSourceBuffer
size_t	sourceByteOffset
HgiTextureHandle	gpuDestinationTexture
GfVec3i	destinationTexelOffset
uint32_t	mipLevel
size_t	byteSize

Detailed Description

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

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.

• gpuSourceBuffer: The gpu buffer to copy data from.
• sourceByteOffset: The byte offset in source buffer to start copying the data from.
• gpuDestinationTexture: The GPU texture to upload the data into.
• 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.
• byteSize: Size of the data (in bytes) to copy

Definition at line 297 of file blitCmdsOps.h.

Constructor & Destructor Documentation

HgiBufferToTextureOp()

HgiBufferToTextureOp ( )

inline

Definition at line 299 of file blitCmdsOps.h.

Member Data Documentation

byteSize

size_t byteSize

Definition at line 313 of file blitCmdsOps.h.

destinationTexelOffset

GfVec3i destinationTexelOffset

Definition at line 311 of file blitCmdsOps.h.

gpuDestinationTexture

HgiTextureHandle gpuDestinationTexture

Definition at line 310 of file blitCmdsOps.h.

gpuSourceBuffer

HgiBufferHandle gpuSourceBuffer

Definition at line 308 of file blitCmdsOps.h.

mipLevel

uint32_t mipLevel

Definition at line 312 of file blitCmdsOps.h.

sourceByteOffset

size_t sourceByteOffset

Definition at line 309 of file blitCmdsOps.h.

---

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

• pxr/imaging/hgi/blitCmdsOps.h