OGRE  1.9
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::GLES2VertexDeclaration Class Reference

Specialisation of VertexDeclaration for OpenGL ES 2 Vertex Array Object usage. More...

#include <OgreGLES2VertexDeclaration.h>

+ Inheritance diagram for Ogre::GLES2VertexDeclaration:
+ Collaboration diagram for Ogre::GLES2VertexDeclaration:

Public Types

typedef list< VertexElement >::type VertexElementList
 Defines the list of vertex elements that makes up this declaration. More...
 

Public Member Functions

 GLES2VertexDeclaration ()
 
 ~GLES2VertexDeclaration ()
 
virtual const VertexElementaddElement (unsigned short source, size_t offset, VertexElementType theType, VertexElementSemantic semantic, unsigned short index=0)
 Adds a new VertexElement to this declaration. More...
 
void bind (void)
 
virtual VertexDeclarationclone (HardwareBufferManagerBase *mgr=0) const
 Clones this declaration. More...
 
void closeGapsInSource (void)
 Remove any gaps in the source buffer list used by this declaration. More...
 
virtual const VertexElementfindElementBySemantic (VertexElementSemantic sem, unsigned short index=0) const
 Finds a VertexElement with the given semantic, and index if there is more than one element with the same semantic. More...
 
virtual VertexElementList findElementsBySource (unsigned short source) const
 Based on the current elements, gets the size of the vertex for a given buffer source. More...
 
VertexDeclarationgetAutoOrganisedDeclaration (bool skeletalAnimation, bool vertexAnimation, bool vertexAnimationNormals) const
 Generates a new VertexDeclaration for optimal usage based on the current vertex declaration, which can be used with VertexData::reorganiseBuffers later if you wish, or simply used as a template. More...
 
const VertexElementgetElement (unsigned short index) const
 Get a single element. More...
 
size_t getElementCount (void) const
 Get the number of elements in the declaration. More...
 
const VertexElementListgetElements (void) const
 Gets read-only access to the list of vertex elements. More...
 
unsigned short getMaxSource (void) const
 Gets the index of the highest source value referenced by this declaration. More...
 
virtual unsigned short getNextFreeTextureCoordinate () const
 Return the index of the next free texture coordinate set which may be added to this declaration. More...
 
virtual size_t getVertexSize (unsigned short source) const
 Gets the vertex size defined by this declaration for a given source. More...
 
virtual const VertexElementinsertElement (unsigned short atPosition, unsigned short source, size_t offset, VertexElementType theType, VertexElementSemantic semantic, unsigned short index=0)
 Inserts a new VertexElement at a given position in this declaration. More...
 
bool isInitialised (void)
 
virtual void modifyElement (unsigned short elem_index, unsigned short source, size_t offset, VertexElementType theType, VertexElementSemantic semantic, unsigned short index=0)
 Modify an element in-place, params as addElement. More...
 
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 *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
bool operator!= (const VertexDeclaration &rhs) const
 
bool operator== (const VertexDeclaration &rhs) const
 
virtual void removeAllElements (void)
 Remove all elements. More...
 
virtual void removeElement (unsigned short elem_index)
 Remove the element at the given index from this declaration. More...
 
virtual void removeElement (VertexElementSemantic semantic, unsigned short index=0)
 Remove the element with the given semantic and usage index. More...
 
void setInitialised (bool flag)
 
void sort (void)
 Sorts the elements in this list to be compatible with the maximum number of rendering APIs / graphics cards. More...
 

Static Public Member Functions

static bool vertexElementLess (const VertexElement &e1, const VertexElement &e2)
 Sort routine for vertex elements. More...
 

Protected Attributes

VertexElementList mElementList
 
bool mIsInitialised
 
GLuint mVAO
 OpenGL id for the vertex array object. More...
 

Detailed Description

Specialisation of VertexDeclaration for OpenGL ES 2 Vertex Array Object usage.

Definition at line 37 of file OgreGLES2VertexDeclaration.h.

Member Typedef Documentation

Defines the list of vertex elements that makes up this declaration.

Definition at line 341 of file OgreHardwareVertexBuffer.h.

Constructor & Destructor Documentation

Ogre::GLES2VertexDeclaration::GLES2VertexDeclaration ( )
Ogre::GLES2VertexDeclaration::~GLES2VertexDeclaration ( )

Member Function Documentation

virtual const VertexElement& Ogre::VertexDeclaration::addElement ( unsigned short  source,
size_t  offset,
VertexElementType  theType,
VertexElementSemantic  semantic,
unsigned short  index = 0 
)
virtualinherited

Adds a new VertexElement to this declaration.

Remarks
This method adds a single element (positions, normals etc) to the end of the vertex declaration. Please read the information in VertexDeclaration about the importance of ordering and structure for compatibility with older D3D drivers.
Parameters
sourceThe binding index of HardwareVertexBuffer which will provide the source for this element. See VertexBufferBinding for full information.
offsetThe offset in bytes where this element is located in the buffer
theTypeThe data format of the element (3 floats, a colour etc)
semanticThe meaning of the data (position, normal, diffuse colour etc)
indexOptional index for multi-input elements like texture coordinates
Returns
A reference to the VertexElement added.

Reimplemented in Ogre::D3D11VertexDeclaration, and Ogre::D3D9VertexDeclaration.

void Ogre::GLES2VertexDeclaration::bind ( void  )
virtual VertexDeclaration* Ogre::VertexDeclaration::clone ( HardwareBufferManagerBase mgr = 0) const
virtualinherited

Clones this declaration.

Parameters
mgrOptional HardwareBufferManager to use for creating the clone (if null, use the current default).
void Ogre::VertexDeclaration::closeGapsInSource ( void  )
inherited

Remove any gaps in the source buffer list used by this declaration.

Remarks
This is useful if you've modified a declaration and want to remove any gaps in the list of buffers being used. Note, however, that if this declaration is already being used with a VertexBufferBinding, you will need to alter that too. This method is mainly useful when reorganising buffers based on an altered declaration.
Note
This will cause the vertex declaration to be re-sorted.
virtual const VertexElement* Ogre::VertexDeclaration::findElementBySemantic ( VertexElementSemantic  sem,
unsigned short  index = 0 
) const
virtualinherited

Finds a VertexElement with the given semantic, and index if there is more than one element with the same semantic.

Remarks
If the element is not found, this method returns null.
virtual VertexElementList Ogre::VertexDeclaration::findElementsBySource ( unsigned short  source) const
virtualinherited

Based on the current elements, gets the size of the vertex for a given buffer source.

Parameters
sourceThe buffer binding index for which to get the vertex size. Gets a list of elements which use a given source.
Remarks
Note that the list of elements is returned by value therefore is separate from the declaration as soon as this method returns.
VertexDeclaration* Ogre::VertexDeclaration::getAutoOrganisedDeclaration ( bool  skeletalAnimation,
bool  vertexAnimation,
bool  vertexAnimationNormals 
) const
inherited

Generates a new VertexDeclaration for optimal usage based on the current vertex declaration, which can be used with VertexData::reorganiseBuffers later if you wish, or simply used as a template.

Remarks
Different buffer organisations and buffer usages will be returned depending on the parameters passed to this method.
Parameters
skeletalAnimationWhether this vertex data is going to be skeletally animated
vertexAnimationWhether this vertex data is going to be vertex animated
vertexAnimationNormalsWhether vertex data animation is going to include normals animation
const VertexElement* Ogre::VertexDeclaration::getElement ( unsigned short  index) const
inherited

Get a single element.

size_t Ogre::VertexDeclaration::getElementCount ( void  ) const
inlineinherited

Get the number of elements in the declaration.

Definition at line 352 of file OgreHardwareVertexBuffer.h.

const VertexElementList& Ogre::VertexDeclaration::getElements ( void  ) const
inherited

Gets read-only access to the list of vertex elements.

unsigned short Ogre::VertexDeclaration::getMaxSource ( void  ) const
inherited

Gets the index of the highest source value referenced by this declaration.

virtual unsigned short Ogre::VertexDeclaration::getNextFreeTextureCoordinate ( ) const
virtualinherited

Return the index of the next free texture coordinate set which may be added to this declaration.

virtual size_t Ogre::VertexDeclaration::getVertexSize ( unsigned short  source) const
virtualinherited

Gets the vertex size defined by this declaration for a given source.

virtual const VertexElement& Ogre::VertexDeclaration::insertElement ( unsigned short  atPosition,
unsigned short  source,
size_t  offset,
VertexElementType  theType,
VertexElementSemantic  semantic,
unsigned short  index = 0 
)
virtualinherited

Inserts a new VertexElement at a given position in this declaration.

Remarks
This method adds a single element (positions, normals etc) at a given position in this vertex declaration. Please read the information in VertexDeclaration about the importance of ordering and structure for compatibility with older D3D drivers.
Parameters
sourceThe binding index of HardwareVertexBuffer which will provide the source for this element. See VertexBufferBinding for full information.
offsetThe offset in bytes where this element is located in the buffer
theTypeThe data format of the element (3 floats, a colour etc)
semanticThe meaning of the data (position, normal, diffuse colour etc)
indexOptional index for multi-input elements like texture coordinates
Returns
A reference to the VertexElement added.

Reimplemented in Ogre::D3D11VertexDeclaration, and Ogre::D3D9VertexDeclaration.

bool Ogre::GLES2VertexDeclaration::isInitialised ( void  )
inline

Definition at line 48 of file OgreGLES2VertexDeclaration.h.

References mIsInitialised.

virtual void Ogre::VertexDeclaration::modifyElement ( unsigned short  elem_index,
unsigned short  source,
size_t  offset,
VertexElementType  theType,
VertexElementSemantic  semantic,
unsigned short  index = 0 
)
virtualinherited

Modify an element in-place, params as addElement.

Remarks
Please read the information in VertexDeclaration about the importance of ordering and structure for compatibility with older D3D drivers.

Reimplemented in Ogre::D3D11VertexDeclaration, and Ogre::D3D9VertexDeclaration.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

bool Ogre::VertexDeclaration::operator!= ( const VertexDeclaration rhs) const
inlineinherited

Definition at line 501 of file OgreHardwareVertexBuffer.h.

bool Ogre::VertexDeclaration::operator== ( const VertexDeclaration rhs) const
inlineinherited

Definition at line 484 of file OgreHardwareVertexBuffer.h.

References Ogre::VertexDeclaration::mElementList.

virtual void Ogre::VertexDeclaration::removeAllElements ( void  )
virtualinherited

Remove all elements.

Reimplemented in Ogre::D3D11VertexDeclaration, and Ogre::D3D9VertexDeclaration.

virtual void Ogre::VertexDeclaration::removeElement ( unsigned short  elem_index)
virtualinherited

Remove the element at the given index from this declaration.

Reimplemented in Ogre::D3D11VertexDeclaration, and Ogre::D3D9VertexDeclaration.

virtual void Ogre::VertexDeclaration::removeElement ( VertexElementSemantic  semantic,
unsigned short  index = 0 
)
virtualinherited

Remove the element with the given semantic and usage index.

Remarks
In this case 'index' means the usage index for repeating elements such as texture coordinates. For other elements this will always be 0 and does not refer to the index in the vector.

Reimplemented in Ogre::D3D11VertexDeclaration, and Ogre::D3D9VertexDeclaration.

void Ogre::GLES2VertexDeclaration::setInitialised ( bool  flag)
inline

Definition at line 49 of file OgreGLES2VertexDeclaration.h.

References mIsInitialised.

void Ogre::VertexDeclaration::sort ( void  )
inherited

Sorts the elements in this list to be compatible with the maximum number of rendering APIs / graphics cards.

Remarks
Older graphics cards require vertex data to be presented in a more rigid way, as defined in the main documentation for this class. As well as the ordering being important, where shared source buffers are used, the declaration must list all the elements for each source in turn.
static bool Ogre::VertexDeclaration::vertexElementLess ( const VertexElement e1,
const VertexElement e2 
)
staticinherited

Sort routine for vertex elements.

Member Data Documentation

VertexElementList Ogre::VertexDeclaration::mElementList
protectedinherited

Definition at line 345 of file OgreHardwareVertexBuffer.h.

Referenced by Ogre::VertexDeclaration::operator==().

bool Ogre::GLES2VertexDeclaration::mIsInitialised
protected

Definition at line 42 of file OgreGLES2VertexDeclaration.h.

Referenced by isInitialised(), and setInitialised().

GLuint Ogre::GLES2VertexDeclaration::mVAO
protected

OpenGL id for the vertex array object.

Definition at line 41 of file OgreGLES2VertexDeclaration.h.


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