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

Describes the properties needed to create a GPU buffer. More...

#include <buffer.h>

Public Attributes

std::string debugName
 
HgiBufferUsage usage
 
size_t byteSize
 
uint32_t vertexStride
 
void const * initialData
 

Detailed Description

Describes the properties needed to create a GPU buffer.

  • debugName: This label can be applied as debug label for gpu debugging.
  • usage: Bits describing the intended usage and properties of the buffer.
  • byteSize: Length of buffer in bytes
  • vertexStride: The size of a vertex in a vertex buffer. This property is only required for vertex buffers.
  • initialData: CPU pointer to initialization data of buffer. The memory is consumed immediately during the creation of the HgiBuffer. The application may alter or free this memory as soon as the constructor of the HgiBuffer has returned.

Definition at line 62 of file buffer.h.

Constructor & Destructor Documentation

◆ HgiBufferDesc()

HGI_API HgiBufferDesc ( )
inline

Definition at line 65 of file buffer.h.

Member Data Documentation

◆ byteSize

size_t byteSize

Definition at line 74 of file buffer.h.

◆ debugName

std::string debugName

Definition at line 72 of file buffer.h.

◆ initialData

void const* initialData

Definition at line 76 of file buffer.h.

◆ usage

HgiBufferUsage usage

Definition at line 73 of file buffer.h.

◆ vertexStride

uint32_t vertexStride

Definition at line 75 of file buffer.h.

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