Muto::BufferLayout Class Reference

Represents the layout of a buffer, consisting of multiple BufferElements. More...

#include <Buffer.h>

Public Member Functions
std::vector< BufferElement >::iterator	begin ()
std::vector< BufferElement >::const_iterator	begin () const
	BufferLayout ()
	BufferLayout (const std::initializer_list< BufferElement > &elements)
	Constructs a BufferLayout with the given list of BufferElements.
std::vector< BufferElement >::iterator	end ()
std::vector< BufferElement >::const_iterator	end () const
const std::vector< BufferElement > &	GetElements () const
	Returns the list of BufferElements in the layout.
uint32_t	GetStride () const
	Returns the stride (total size in bytes) of the buffer layout.

Private Member Functions
void	CalculateOffsetsAndStride ()
	Calculates the offsets and stride for the buffer layout based on its elements.

Private Attributes
std::vector< BufferElement >	m_Elements
uint32_t	m_Stride = 0

Detailed Description

Represents the layout of a buffer, consisting of multiple BufferElements.

Constructor & Destructor Documentation

BufferLayout() [1/2]

Muto::BufferLayout::BufferLayout ( )

inline

{}

BufferLayout() [2/2]

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

inline

Constructs a BufferLayout with the given list of BufferElements.

Parameters

elements

The list of BufferElements that make up the layout. Automatically calculates offsets and stride.

            : m_Elements(elements), m_Stride(0)
        {
            CalculateOffsetsAndStride();
        }

References BufferLayout(), CalculateOffsetsAndStride(), and m_Stride.

Referenced by BufferLayout().

Member Function Documentation

begin() [1/2]

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

inline

{ return m_Elements.begin(); }

begin() [2/2]

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

inline

{ return m_Elements.begin(); }

CalculateOffsetsAndStride()

void Muto::BufferLayout::CalculateOffsetsAndStride ( )

inlineprivate

Calculates the offsets and stride for the buffer layout based on its elements.

                                         {
            uint32_t offset = 0;
            m_Stride = 0;
            for (auto& element : m_Elements) {
                element.Offset = offset;
                offset += element.Size;
                m_Stride += element.Size;
            }
        }

References m_Stride.

Referenced by BufferLayout().

end() [1/2]

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

inline

{ return m_Elements.end(); }

end() [2/2]

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

inline

{ return m_Elements.end(); }

GetElements()

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

inline

Returns the list of BufferElements in the layout.

{ return m_Elements; }

GetStride()

uint32_t Muto::BufferLayout::GetStride ( ) const

inline

Returns the stride (total size in bytes) of the buffer layout.

{ return m_Stride; }

References m_Stride.

Member Data Documentation

m_Elements

std::vector<BufferElement> Muto::BufferLayout::m_Elements

private

m_Stride

uint32_t Muto::BufferLayout::m_Stride = 0

private

Referenced by BufferLayout(), CalculateOffsetsAndStride(), and GetStride().

---

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

• Muto/src/Renderer/Buffer.h