BufferDesc

A buffer description structure used to create buffer resources. Provides convenience functions for creating buffer descriptions of all supported types of buffers.

File location: framework/cauldron/framework/inc/render/buffer.h

Methods

Return type	Description
static BufferDesc	Vertex ( const wchar_t* name, uint32_t size, uint32_t stride, uint32_t alignment = 0, ResourceFlags flags = ResourceFlags::None ) Convenience creation function for vertex buffer descriptions.
static BufferDesc	Index ( const wchar_t* name, uint32_t size, ResourceFormat format, uint32_t alignment = 0, ResourceFlags flags = ResourceFlags::None ) Convenience creation function for index buffer descriptions.
static BufferDesc	Constant ( const wchar_t* name, uint32_t size, uint32_t stride, uint32_t alignment = 0, ResourceFlags flags = ResourceFlags::None ) Convenience creation function for constant buffer descriptions.
static BufferDesc	Data ( const wchar_t* name, uint32_t size, uint32_t stride, uint32_t alignment = 0, ResourceFlags flags = ResourceFlags::None ) Convenience creation function for data buffer descriptions.
static BufferDesc	AccelerationStructure ( const wchar_t* name, uint32_t size, uint32_t stride, uint32_t alignment = 0, ResourceFlags flags = ResourceFlags::None ) Convenience creation function for acceleration structure descriptions.

Detailed description

A buffer description structure used to create buffer resources. Provides convenience functions for creating buffer descriptions of all supported types of buffers.

Data fields

Type	Description
BufferType	Type The “BufferType“ this resource will be.
ResourceFlags	Flags Needed “ResourceFlags“.
uint32_t	Size The size of the buffer in bytes.
uint32_t	Alignment The required alignment of the buffer.
uint32_t	Stride The stride of the buffer, or.
ResourceFormat	Format The format of the buffer (when using as an index buffer).
std::wstring	Name The name to assign to the created “Buffer“ resource.

Methods

Vertex

Copied!

static BufferDesc Vertex (
    const wchar_t* name,
    uint32_t size,
    uint32_t stride,
    uint32_t alignment = 0,
    ResourceFlags  flags = ResourceFlags::None
)

Convenience creation function for vertex buffer descriptions.

Index

Copied!

static BufferDesc Index (
    const wchar_t* name,
    uint32_t size,
    ResourceFormat  format,
    uint32_t alignment = 0,
    ResourceFlags  flags = ResourceFlags::None
)

Convenience creation function for index buffer descriptions.

Constant

Copied!

static BufferDesc Constant (
    const wchar_t* name,
    uint32_t size,
    uint32_t stride,
    uint32_t alignment = 0,
    ResourceFlags  flags = ResourceFlags::None
)

Convenience creation function for constant buffer descriptions.

Data

Copied!

static BufferDesc Data (
    const wchar_t* name,
    uint32_t size,
    uint32_t stride,
    uint32_t alignment = 0,
    ResourceFlags  flags = ResourceFlags::None
)

Convenience creation function for data buffer descriptions.

AccelerationStructure

Copied!

static BufferDesc AccelerationStructure (
    const wchar_t* name,
    uint32_t size,
    uint32_t stride,
    uint32_t alignment = 0,
    ResourceFlags  flags = ResourceFlags::None
)