DigitalSpaces::DIOGREVertexElement Struct Reference
[Ogre]

#include <OGREInterfaces.h>

Inherits DigitalSpaces::DIObjectBase.

Public Member Functions
unsigned short	GetSource (void)
	Gets the vertex buffer index from where this element draws it's values.
unsigned long	GetOffset (void)
	Gets the offset into the buffer where this element starts.
OGREVertexElementType	GetType (void)
	Gets the data format of this element.
OGREVertexElementSemantic	GetSemantic (void)
	Gets the meaning of this element.
unsigned short	GetIndex (void)
	Gets the index of this element, only applicable for repeating elements.
unsigned long	GetSize (void)
	Gets the size of this element in bytes.
unsigned long	GetTypeSize (OGREVertexElementType etype)
	Utility method for helping to calculate offsets.
unsigned short	GetTypeCount (OGREVertexElementType etype)
	Utility method which returns the count of values in a given type.
OGREVertexElementType	MultiplyTypeCount (OGREVertexElementType baseType, unsigned short count)
	Simple converter function which will turn a single-value type into a multi-value type based on a parameter.
OGREVertexElementType	GetBaseType (OGREVertexElementType multiType)
	Simple converter function which will a type into it's single-value equivalent - makes switches on type easier.
void	BaseVertexPointerToElement (void *pBase, void **pElem)
	Adjusts a pointer to the base of a vertex to point at this element.
void	BaseVertexPointerToElement (void *pBase, float **pElem)
	Adjusts a pointer to the base of a vertex to point at this element.
void	BaseVertexPointerToElement (void *pBase, unsigned int **pElem)
	Adjusts a pointer to the base of a vertex to point at this element.
void	BaseVertexPointerToElement (void *pBase, unsigned char **pElem)
	Adjusts a pointer to the base of a vertex to point at this element.
void	BaseVertexPointerToElement (void *pBase, unsigned short **pElem)
	Adjusts a pointer to the base of a vertex to point at this element.

---

Member Function Documentation

unsigned short DigitalSpaces::DIOGREVertexElement::GetSource

(

void

)

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

unsigned long DigitalSpaces::DIOGREVertexElement::GetOffset

(

void

)

Gets the offset into the buffer where this element starts.

OGREVertexElementType DigitalSpaces::DIOGREVertexElement::GetType

(

void

)

Gets the data format of this element.

OGREVertexElementSemantic DigitalSpaces::DIOGREVertexElement::GetSemantic

(

void

)

Gets the meaning of this element.

unsigned short DigitalSpaces::DIOGREVertexElement::GetIndex

(

void

)

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

unsigned long DigitalSpaces::DIOGREVertexElement::GetSize

(

void

)

Gets the size of this element in bytes.

unsigned long DigitalSpaces::DIOGREVertexElement::GetTypeSize

(

OGREVertexElementType

etype

)

Utility method for helping to calculate offsets.

unsigned short DigitalSpaces::DIOGREVertexElement::GetTypeCount

(

OGREVertexElementType

etype

)

Utility method which returns the count of values in a given type.

OGREVertexElementType DigitalSpaces::DIOGREVertexElement::MultiplyTypeCount	(	OGREVertexElementType	baseType,
		unsigned short	count
	)

Simple converter function which will turn a single-value type into a multi-value type based on a parameter.

OGREVertexElementType DigitalSpaces::DIOGREVertexElement::GetBaseType

(

OGREVertexElementType

multiType

)

Simple converter function which will a type into it's single-value equivalent - makes switches on type easier.

void DigitalSpaces::DIOGREVertexElement::BaseVertexPointerToElement	(	void *	pBase,
		void **	pElem
	)

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.

void DigitalSpaces::DIOGREVertexElement::BaseVertexPointerToElement	(	void *	pBase,
		float **	pElem
	)

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.

void DigitalSpaces::DIOGREVertexElement::BaseVertexPointerToElement	(	void *	pBase,
		unsigned int **	pElem
	)

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.

void DigitalSpaces::DIOGREVertexElement::BaseVertexPointerToElement	(	void *	pBase,
		unsigned char **	pElem
	)

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.

void DigitalSpaces::DIOGREVertexElement::BaseVertexPointerToElement	(	void *	pBase,
		unsigned short **	pElem
	)

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 struct was generated from the following file:

• OGREInterfaces/OGREInterfaces.h