Castor3D::BufferDeclaration Class Reference

Description of all elements in a vertex buffer. More...

Public Types
using	iterator = BufferElementDeclarationArrayIt
using	const_iterator = BufferElementDeclarationArrayConstIt

Public Member Functions
	DECLARE_VECTOR (BufferElementDeclaration, BufferElementDeclaration)
C3D_API	BufferDeclaration ()
	Constructor. More...
C3D_API	BufferDeclaration (BufferElementDeclaration const *p_elements, uint32_t p_count)
	Constructor. More...
template<uint32_t N>
	BufferDeclaration (BufferElementDeclaration const(&p_elements)[N])
	Constructor. More...
	BufferDeclaration (std::vector< BufferElementDeclaration > const &p_elements)
	Constructor. More...
C3D_API	~BufferDeclaration ()
	Destructor. More...
uint32_t	GetSize () const
	Retrieves the elements count. More...
uint32_t	GetStride () const
	Retrieves the total elements byte count. More...
BufferElementDeclarationArray::iterator	begin ()
BufferElementDeclarationArray::const_iterator	begin () const
BufferElementDeclarationArray::iterator	end ()
BufferElementDeclarationArray::const_iterator	end () const

Protected Attributes
BufferElementDeclarationArray	m_arrayElements
	Element description array. More...
uint32_t	m_uiStride
	Byte size of the element. More...

Detailed Description

Description of all elements in a vertex buffer.

Author

Sylvain DOREMUS

Version

0.6.1.0

Date

03/01/2011

Member Typedef Documentation

const_iterator

using Castor3D::BufferDeclaration::const_iterator = BufferElementDeclarationArrayConstIt

iterator

using Castor3D::BufferDeclaration::iterator = BufferElementDeclarationArrayIt

Constructor & Destructor Documentation

BufferDeclaration() [1/4]

C3D_API Castor3D::BufferDeclaration::BufferDeclaration

(

)

Constructor.

BufferDeclaration() [2/4]

C3D_API Castor3D::BufferDeclaration::BufferDeclaration	(	BufferElementDeclaration const *	p_elements,
		uint32_t	p_count
	)

Constructor.

Parameters

[in]	p_elements	The elements array
[in]	p_count	Elements array size

BufferDeclaration() [3/4]

template<uint32_t N>

Castor3D::BufferDeclaration::BufferDeclaration ( BufferElementDeclaration const(&)  p_elements[N] )

inline

Constructor.

Parameters

[in]

p_elements

The elements array

BufferDeclaration() [4/4]

Castor3D::BufferDeclaration::BufferDeclaration ( std::vector< BufferElementDeclaration > const &  p_elements )

inline

Constructor.

Parameters

[in]

p_elements

The elements array

~BufferDeclaration()

C3D_API Castor3D::BufferDeclaration::~BufferDeclaration

(

)

Destructor.

Member Function Documentation

begin() [1/2]

BufferElementDeclarationArray::iterator Castor3D::BufferDeclaration::begin ( )

inline

Returns

An iterator to the beginning of the elements.

References m_arrayElements.

begin() [2/2]

BufferElementDeclarationArray::const_iterator Castor3D::BufferDeclaration::begin ( ) const

inline

Returns

An iterator to the beginning of the elements.

References m_arrayElements.

DECLARE_VECTOR()

Castor3D::BufferDeclaration::DECLARE_VECTOR	(	BufferElementDeclaration	,
		BufferElementDeclaration
	)

end() [1/2]

BufferElementDeclarationArray::iterator Castor3D::BufferDeclaration::end ( )

inline

Returns

An iterator to the end of the elements.

References m_arrayElements.

end() [2/2]

BufferElementDeclarationArray::const_iterator Castor3D::BufferDeclaration::end ( ) const

inline

Returns

An iterator to the end of the elements.

References m_arrayElements.

GetSize()

uint32_t Castor3D::BufferDeclaration::GetSize ( ) const

inline

Retrieves the elements count.

Returns

The elements count

References m_arrayElements.

GetStride()

uint32_t Castor3D::BufferDeclaration::GetStride ( ) const

inline

Retrieves the total elements byte count.

Returns

The byte count

References m_uiStride.

Referenced by Castor3D::VertexBuffer::LinkCoords().

Here is the caller graph for this function:

Member Data Documentation

m_arrayElements

BufferElementDeclarationArray Castor3D::BufferDeclaration::m_arrayElements

protected

Element description array.

Referenced by begin(), end(), and GetSize().

m_uiStride

uint32_t Castor3D::BufferDeclaration::m_uiStride

protected

Byte size of the element.

Referenced by GetStride().

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/BufferDeclaration.hpp