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

#include <buffer.h>

Public Member Functions

HGI_API HgiBufferDesc ()

Public Attributes

std::string debugName
HgiBufferUsage usage
size_t byteSize
uint32_t vertexStride
void constinitialData

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

HGI_API HgiBufferDesc::HgiBufferDesc ( )

Definition at line 65 of file buffer.h.

Member Data Documentation

size_t HgiBufferDesc::byteSize

Definition at line 74 of file buffer.h.

std::string HgiBufferDesc::debugName

Definition at line 72 of file buffer.h.

void const* HgiBufferDesc::initialData

Definition at line 76 of file buffer.h.

HgiBufferUsage HgiBufferDesc::usage

Definition at line 73 of file buffer.h.

uint32_t HgiBufferDesc::vertexStride

Definition at line 75 of file buffer.h.

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