Ogre::VertexElement Class Reference
[RenderSystem]

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.
	VertexElement (unsigned short source, size_t offset, VertexElementType theType, VertexElementSemantic semantic, unsigned short index=0)
	Constructor, should not be called directly, call VertexDeclaration::addElement.
unsigned short	getSource (void) const
	Gets the vertex buffer index from where this element draws it's values.
size_t	getOffset (void) const
	Gets the offset into the buffer where this element starts.
VertexElementType	getType (void) const
	Gets the data format of this element.
VertexElementSemantic	getSemantic (void) const
	Gets the meaning of this element.
unsigned short	getIndex (void) const
	Gets the index of this element, only applicable for repeating elements.
size_t	getSize (void) const
	Gets the size of this element in bytes.
bool	operator== (const VertexElement &rhs) const
void	baseVertexPointerToElement (void pBase, void *pElem) const
	Adjusts a pointer to the base of a vertex to point at this element.
void	baseVertexPointerToElement (void pBase, float *pElem) const
	Adjusts a pointer to the base of a vertex to point at this element.
void	baseVertexPointerToElement (void pBase, RGBA *pElem) const
	Adjusts a pointer to the base of a vertex to point at this element.
void	baseVertexPointerToElement (void pBase, unsigned char *pElem) const
	Adjusts a pointer to the base of a vertex to point at this element.
void	baseVertexPointerToElement (void pBase, unsigned short *pElem) const
	Adjusts a pointer to the base of a vertex to point at this element.
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
Static Public Member Functions
static size_t	getTypeSize (VertexElementType etype)
	Utility method for helping to calculate offsets.
static unsigned short	getTypeCount (VertexElementType etype)
	Utility method which returns the count of values in a given type.
static VertexElementType	multiplyTypeCount (VertexElementType baseType, unsigned short count)
	Simple converter function which will turn a single-value type into a multi-value type based on a parameter.
static VertexElementType	getBaseType (VertexElementType multiType)
	Simple converter function which will a type into it's single-value equivalent - makes switches on type easier.
static void	convertColourValue (VertexElementType srcType, VertexElementType dstType, uint32 *ptr)
	Utility method for converting colour from one packed 32-bit colour type to another.
static uint32	convertColourValue (const ColourValue &src, VertexElementType dst)
	Utility method for converting colour to a packed 32-bit colour type.
static VertexElementType	getBestColourVertexElementType (void)
	Utility method to get the most appropriate packed colour vertex element format.
Protected Attributes
unsigned short	mSource
	The source vertex buffer, as bound to an index using VertexBufferBinding.
size_t	mOffset
	The offset in the buffer that this element starts at.
VertexElementType	mType
	The type of element.
VertexElementSemantic	mSemantic
	The meaning of the element.
unsigned short	mIndex
	Index of the item, only applicable for some elements like texture coords.

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.

Definition at line 147 of file OgreHardwareVertexBuffer.h.

Constructor & Destructor Documentation

Ogre::VertexElement::VertexElement ( )

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

Definition at line 162 of file OgreHardwareVertexBuffer.h.

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.