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

#include <resourceBindings.h>

Public Member Functions

HGI_API HgiBufferBindDesc ()

Public Attributes

HgiBufferHandleVector buffers
std::vector< uint32_t > offsets
std::vector< uint32_t > sizes
HgiBindResourceType resourceType
uint32_t bindingIndex
HgiShaderStage stageUsage
bool writable

Detailed Description

Describes the binding information of a buffer (or array of buffers).

  • buffers: The buffer(s) to be bound. If there are more than one buffer, the buffers will be put in an array-of-buffers. Please note that different platforms have varying limits to max buffers in an array.
  • offsets: Offset (in bytes) where data begins from the start of the buffer. There is an offset corresponding to each buffer in 'buffers'.
  • sizes: Size (in bytes) of the range of data in the buffer to bind. There is a size corresponding to each buffer in 'buffers'. If sizes is empty or the size for a buffer is specified as zero, then the entire buffer is bound. If the offset for a buffer is non-zero, then a non-zero size must also be specified.
  • resourceType: The type of buffer(s) that is to be bound. All buffers in the array must have the same type. Vertex, index and indirect buffers are not bound to a resourceSet. They are instead passed to the draw command.
  • bindingIndex: Binding location for the buffer(s).
  • stageUsage: What shader stage(s) the buffer will be used in.
  • writable: Whether the buffer binding should be non-const.

Definition at line 79 of file resourceBindings.h.

Constructor & Destructor Documentation

HGI_API HgiBufferBindDesc::HgiBufferBindDesc ( )

Member Data Documentation

uint32_t HgiBufferBindDesc::bindingIndex

Definition at line 88 of file resourceBindings.h.

HgiBufferHandleVector HgiBufferBindDesc::buffers

Definition at line 84 of file resourceBindings.h.

std::vector<uint32_t> HgiBufferBindDesc::offsets

Definition at line 85 of file resourceBindings.h.

HgiBindResourceType HgiBufferBindDesc::resourceType

Definition at line 87 of file resourceBindings.h.

std::vector<uint32_t> HgiBufferBindDesc::sizes

Definition at line 86 of file resourceBindings.h.

HgiShaderStage HgiBufferBindDesc::stageUsage

Definition at line 89 of file resourceBindings.h.

bool HgiBufferBindDesc::writable

Definition at line 90 of file resourceBindings.h.

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