castor3d::ParticleDeclaration Class Reference

#include <ParticleDeclaration.hpp>

Public Types
using	iterator = ParticleElementDeclarationArrayIt
using	const_iterator = ParticleElementDeclarationArrayConstIt

Public Member Functions
	CU_DeclareVector (ParticleElementDeclaration, ParticleElementDeclaration)
C3D_API	ParticleDeclaration ()
	Constructor.
C3D_API	ParticleDeclaration (ParticleElementDeclaration const *elements, uint32_t count)
	Constructor.
template<uint32_t N>
	ParticleDeclaration (ParticleElementDeclaration const(&elements)[N])
	Constructor.
	ParticleDeclaration (castor::Vector< ParticleElementDeclaration > const &elements)
	Constructor.
size_t	count () const
uint32_t	stride () const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
void	push_back (ParticleElementDeclaration const &element)
	Adds an element to the end of the list.
template<typename ... Params>
void	emplace_back (Params &&... params)
	Adds an element to the end of the list.

Member Typedef Documentation

const_iterator

using castor3d::ParticleDeclaration::const_iterator = ParticleElementDeclarationArrayConstIt

iterator

using castor3d::ParticleDeclaration::iterator = ParticleElementDeclarationArrayIt

Constructor & Destructor Documentation

ParticleDeclaration() [1/4]

C3D_API castor3d::ParticleDeclaration::ParticleDeclaration

(

)

Constructor.

ParticleDeclaration() [2/4]

C3D_API castor3d::ParticleDeclaration::ParticleDeclaration	(	ParticleElementDeclaration const *	elements,
		uint32_t	count )

Constructor.

Parameters

[in]	elements	The elements array
[in]	count	Elements array size

ParticleDeclaration() [3/4]

template<uint32_t N>

castor3d::ParticleDeclaration::ParticleDeclaration ( ParticleElementDeclaration const(&) elements[N] )

inlineexplicit

Constructor.

Parameters

[in]

elements

The elements array

ParticleDeclaration() [4/4]

castor3d::ParticleDeclaration::ParticleDeclaration ( castor::Vector< ParticleElementDeclaration > const & elements )

inlineexplicit

Constructor.

Parameters

[in]

elements

The elements array

Member Function Documentation

begin() [1/2]

iterator castor3d::ParticleDeclaration::begin ( )

inline

Returns

An iterator to the beginning of the elements.

begin() [2/2]

const_iterator castor3d::ParticleDeclaration::begin ( ) const

inline

Returns

An iterator to the beginning of the elements.

count()

size_t castor3d::ParticleDeclaration::count ( ) const

inline

Returns

The elements count.

CU_DeclareVector()

castor3d::ParticleDeclaration::CU_DeclareVector	(	ParticleElementDeclaration	,
		ParticleElementDeclaration	)

emplace_back()

template<typename ... Params>

void castor3d::ParticleDeclaration::emplace_back ( Params &&... params )

inline

Adds an element to the end of the list.

Parameters

[in]

params

The element construction parameters.

References castor3d::getSize().

Here is the call graph for this function:

end() [1/2]

iterator castor3d::ParticleDeclaration::end ( )

inline

Returns

An iterator to the end of the elements.

end() [2/2]

const_iterator castor3d::ParticleDeclaration::end ( ) const

inline

Returns

An iterator to the end of the elements.

push_back()

void castor3d::ParticleDeclaration::push_back ( ParticleElementDeclaration const & element )

inline

Adds an element to the end of the list.

Parameters

[in]

element

The element.

References castor3d::getSize().

Here is the call graph for this function:

stride()

uint32_t castor3d::ParticleDeclaration::stride ( ) const

inline

Returns

The byte size of the declaration.

---

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

• Castor3D/Scene/ParticleSystem/ParticleDeclaration.hpp