Karma::BufferLayout Class Reference

A format for vertex buffer say. More...

#include <Buffer.h>

Public Member Functions
	BufferLayout ()
	A default constructor.
	BufferLayout (const std::initializer_list< BufferElement > &elements)
	Constructor with specified buffer data format.
uint32_t	GetStride () const
	A getter for m_Stride.
const std::vector< BufferElement > &	GetElements () const
	A getter for m_Elements.
void	PushElement (const BufferElement &element)
	For modifying the list of elements and set paremeters accordingly.
std::vector< BufferElement >::iterator	begin ()
	Getter for iterator begin.
std::vector< BufferElement >::iterator	end ()
	Getter for iterator end.
std::vector< BufferElement >::const_iterator	begin () const
	Getter for const_iterator begin.
std::vector< BufferElement >::const_iterator	end () const
	Getter for const_iterator end.

Detailed Description

A format for vertex buffer say.

See also

GaugeVertexDataLayout

Constructor & Destructor Documentation

BufferLayout() [1/2]

Karma::BufferLayout::BufferLayout ( )

inline

A default constructor.

See also

VulkanVertexBuffer

Since

Karma 1.0.0

BufferLayout() [2/2]

Karma::BufferLayout::BufferLayout ( const std::initializer_list< BufferElement > & elements )

inline

Constructor with specified buffer data format.

Parameters

elements

Note

For legacy purpose only. For instance https://github.com/ravimohan1991/KarmaEngine/blob/138c172ccedf31acfab982af51ae130f9a37d3bb/Application/src/KarmaApp.cpp#L21. See Mesh abstraction for industry purpose usage.

Since

Karma 1.0.0

Member Function Documentation

begin() [1/2]

std::vector< BufferElement >::iterator Karma::BufferLayout::begin ( )

inline

Getter for iterator begin.

Since

Karma 1.0.0

begin() [2/2]

std::vector< BufferElement >::const_iterator Karma::BufferLayout::begin ( ) const

inline

Getter for const_iterator begin.

Since

Karma 1.0.0

end() [1/2]

std::vector< BufferElement >::iterator Karma::BufferLayout::end ( )

inline

Getter for iterator end.

Since

Karma 1.0.0

end() [2/2]

std::vector< BufferElement >::const_iterator Karma::BufferLayout::end ( ) const

inline

Getter for const_iterator end.

Since

Karma 1.0.0

GetElements()

const std::vector< BufferElement > & Karma::BufferLayout::GetElements ( ) const

inline

A getter for m_Elements.

Since

Karma 1.0.0

GetStride()

uint32_t Karma::BufferLayout::GetStride ( ) const

inline

A getter for m_Stride.

Since

Karma 1.0.0

PushElement()

void Karma::BufferLayout::PushElement ( const BufferElement & element )

inline

For modifying the list of elements and set paremeters accordingly.

Since

Karma 1.0.0

---

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

• Karma/src/Karma/Renderer/Buffer.h