Loading...
Searching...
No Matches
HgiBufferBindDesc Struct Reference

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

#include <resourceBindings.h>

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.

Member Data Documentation

◆ bindingIndex

uint32_t bindingIndex

Definition at line 88 of file resourceBindings.h.

◆ buffers

HgiBufferHandleVector buffers

Definition at line 84 of file resourceBindings.h.

◆ offsets

std::vector<uint32_t> offsets

Definition at line 85 of file resourceBindings.h.

◆ resourceType

HgiBindResourceType resourceType

Definition at line 87 of file resourceBindings.h.

◆ sizes

std::vector<uint32_t> sizes

Definition at line 86 of file resourceBindings.h.

◆ stageUsage

HgiShaderStage stageUsage

Definition at line 89 of file resourceBindings.h.

◆ writable

bool writable

Definition at line 90 of file resourceBindings.h.


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