This class declares the usage of a single vertex buffer as a component of a complete VertexDeclaration. More...

#include <OgreHardwareVertexBuffer.h>

Inheritance diagram for Ogre::VertexElement:

Public Member Functions
	VertexElement ()
	Constructor, should not be called directly, only needed because of list. More...

	VertexElement (unsigned short source, size_t offset, VertexElementType theType, VertexElementSemantic semantic, unsigned short index=0)
	Constructor, should not be called directly, call VertexDeclaration::addElement. More...

void	baseVertexPointerToElement (void pBase, void *pElem) const
	Adjusts a pointer to the base of a vertex to point at this element. More...

void	baseVertexPointerToElement (void pBase, float *pElem) const
	Adjusts a pointer to the base of a vertex to point at this element. More...

void	baseVertexPointerToElement (void pBase, RGBA *pElem) const
	Adjusts a pointer to the base of a vertex to point at this element. More...

void	baseVertexPointerToElement (void pBase, unsigned char *pElem) const
	Adjusts a pointer to the base of a vertex to point at this element. More...

void	baseVertexPointerToElement (void pBase, unsigned short *pElem) const
	Adjusts a pointer to the base of a vertex to point at this element. More...

unsigned short	getIndex (void) const
	Gets the index of this element, only applicable for repeating elements. More...

size_t	getOffset (void) const
	Gets the offset into the buffer where this element starts. More...

VertexElementSemantic	getSemantic (void) const
	Gets the meaning of this element. More...

size_t	getSize (void) const
	Gets the size of this element in bytes. More...

unsigned short	getSource (void) const
	Gets the vertex buffer index from where this element draws it's values. More...

VertexElementType	getType (void) const
	Gets the data format of this element. More...

bool	operator== (const VertexElement &rhs) const

Static Public Member Functions
static void	convertColourValue (VertexElementType srcType, VertexElementType dstType, uint32 *ptr)
	Utility method for converting colour from one packed 32-bit colour type to another. More...

static uint32	convertColourValue (const ColourValue &src, VertexElementType dst)
	Utility method for converting colour to a packed 32-bit colour type. More...

static VertexElementType	getBaseType (VertexElementType multiType)
	Simple converter function which will turn a type into it's single-value (or lowest multiple-value) equivalent - makes switches on type easier. More...

static VertexElementType	getBestColourVertexElementType (void)
	Utility method to get the most appropriate packed colour vertex element format. More...

static unsigned short	getTypeCount (VertexElementType etype)
	Utility method which returns the count of values in a given type (result for colors may be counter-intuitive) More...

static size_t	getTypeSize (VertexElementType etype)
	Utility method for helping to calculate offsets. More...

static VertexElementType	multiplyTypeCount (VertexElementType baseType, unsigned short count)
	Simple converter function which will return a type large enough to hold 'count' values of the same type as the values in 'baseType'. More...

Detailed Description

This class declares the usage of a single vertex buffer as a component of a complete VertexDeclaration.

Remarks: Several vertex buffers can be used to supply the input geometry for a rendering operation, and in each case a vertex buffer can be used in different ways for different operations; the buffer itself does not define the semantics (position, normal etc), the VertexElement class does.

Constructor & Destructor Documentation

◆ VertexElement() [1/2]

Ogre::VertexElement::VertexElement ( )

inline

Constructor, should not be called directly, only needed because of list.

◆ VertexElement() [2/2]

Ogre::VertexElement::VertexElement	(	unsigned short	source,
		size_t	offset,
		VertexElementType	theType,
		VertexElementSemantic	semantic,
		unsigned short	index = `0`
	)

Constructor, should not be called directly, call VertexDeclaration::addElement.

Member Function Documentation

◆ getSource()

unsigned short Ogre::VertexElement::getSource ( void ) const

inline

Gets the vertex buffer index from where this element draws it's values.

◆ getOffset()

size_t Ogre::VertexElement::getOffset ( void ) const

inline

Gets the offset into the buffer where this element starts.

◆ getType()

VertexElementType Ogre::VertexElement::getType ( void ) const

inline

Gets the data format of this element.

◆ getSemantic()

VertexElementSemantic Ogre::VertexElement::getSemantic ( void ) const

inline

Gets the meaning of this element.

◆ getIndex()

unsigned short Ogre::VertexElement::getIndex ( void ) const

inline

Gets the index of this element, only applicable for repeating elements.

◆ getSize()

size_t Ogre::VertexElement::getSize ( void ) const

Gets the size of this element in bytes.

◆ getTypeSize()

static size_t Ogre::VertexElement::getTypeSize ( VertexElementType etype )

static

Utility method for helping to calculate offsets.

◆ getTypeCount()

static unsigned short Ogre::VertexElement::getTypeCount ( VertexElementType etype )

static

Utility method which returns the count of values in a given type (result for colors may be counter-intuitive)

◆ multiplyTypeCount()

static VertexElementType Ogre::VertexElement::multiplyTypeCount	(	VertexElementType	baseType,
		unsigned short	count
	)

static

Simple converter function which will return a type large enough to hold 'count' values of the same type as the values in 'baseType'.

The 'baseType' parameter should have the smallest count available. The return type may have the count rounded up to the next multiple of 4 bytes. Byte types will always return a 4-count type, while short types will return either a 2-count or 4-count type.

◆ getBaseType()

static VertexElementType Ogre::VertexElement::getBaseType ( VertexElementType multiType )

static

Simple converter function which will turn a type into it's single-value (or lowest multiple-value) equivalent - makes switches on type easier.

May give counter-intuitive results with bytes or shorts.

◆ convertColourValue() [1/2]

static void Ogre::VertexElement::convertColourValue	(	VertexElementType	srcType,
		VertexElementType	dstType,
		uint32 *	ptr
	)

static

Utility method for converting colour from one packed 32-bit colour type to another.

Parameters

srcType	The source type
dstType	The destination type
ptr	Read / write value to change

◆ convertColourValue() [2/2]

static uint32 Ogre::VertexElement::convertColourValue	(	const ColourValue &	src,
		VertexElementType	dst
	)

static

Utility method for converting colour to a packed 32-bit colour type.

Parameters

src	source colour
dst	The destination type

◆ getBestColourVertexElementType()

static VertexElementType Ogre::VertexElement::getBestColourVertexElementType ( void )

static

Utility method to get the most appropriate packed colour vertex element format.

◆ operator==()

bool Ogre::VertexElement::operator== ( const VertexElement & rhs ) const

inline

◆ baseVertexPointerToElement() [1/5]

void Ogre::VertexElement::baseVertexPointerToElement	(	void *	pBase,
		void **	pElem
	)		const

inline

Adjusts a pointer to the base of a vertex to point at this element.

Remarks: This variant is for void pointers, passed as a parameter because we can't rely on covariant return types.

Parameters

pBase	Pointer to the start of a vertex in this buffer.
pElem	Pointer to a pointer which will be set to the start of this element.

◆ baseVertexPointerToElement() [2/5]

void Ogre::VertexElement::baseVertexPointerToElement	(	void *	pBase,
		float **	pElem
	)		const

inline

Adjusts a pointer to the base of a vertex to point at this element.

Remarks: This variant is for float pointers, passed as a parameter because we can't rely on covariant return types.

Parameters

pBase	Pointer to the start of a vertex in this buffer.
pElem	Pointer to a pointer which will be set to the start of this element.

◆ baseVertexPointerToElement() [3/5]

void Ogre::VertexElement::baseVertexPointerToElement	(	void *	pBase,
		RGBA **	pElem
	)		const

inline

Adjusts a pointer to the base of a vertex to point at this element.

Remarks: This variant is for RGBA pointers, passed as a parameter because we can't rely on covariant return types.

Parameters

pBase	Pointer to the start of a vertex in this buffer.
pElem	Pointer to a pointer which will be set to the start of this element.

◆ baseVertexPointerToElement() [4/5]

void Ogre::VertexElement::baseVertexPointerToElement	(	void *	pBase,
		unsigned char **	pElem
	)		const

inline

Adjusts a pointer to the base of a vertex to point at this element.

Remarks: This variant is for char pointers, passed as a parameter because we can't rely on covariant return types.

Parameters

pBase	Pointer to the start of a vertex in this buffer.
pElem	Pointer to a pointer which will be set to the start of this element.

◆ baseVertexPointerToElement() [5/5]

void Ogre::VertexElement::baseVertexPointerToElement	(	void *	pBase,
		unsigned short **	pElem
	)		const

inline

Adjusts a pointer to the base of a vertex to point at this element.

Remarks: This variant is for ushort pointers, passed as a parameter because we can't rely on covariant return types.

Parameters

pBase	Pointer to the start of a vertex in this buffer.
pElem	Pointer to a pointer which will be set to the start of this element.

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

OgreHardwareVertexBuffer.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ VertexElement() [1/2]

◆ VertexElement() [2/2]

Member Function Documentation

◆ getSource()

◆ getOffset()

◆ getType()

◆ getSemantic()

◆ getIndex()

◆ getSize()

◆ getTypeSize()

◆ getTypeCount()

◆ multiplyTypeCount()

◆ getBaseType()

◆ convertColourValue() [1/2]

◆ convertColourValue() [2/2]

◆ getBestColourVertexElementType()

◆ operator==()

◆ baseVertexPointerToElement() [1/5]

◆ baseVertexPointerToElement() [2/5]

◆ baseVertexPointerToElement() [3/5]

◆ baseVertexPointerToElement() [4/5]

◆ baseVertexPointerToElement() [5/5]