Summary class collecting together vertex source information.
More...
#include <OgreVertexIndexData.h>
Summary class collecting together vertex source information.
◆ HardwareAnimationDataList
◆ VertexData() [1/2]
◆ VertexData() [2/2]
Constructor.
- Note
- This constructor receives the VertexDeclaration and VertexBufferBinding from the caller, and as such does not arrange for their deletion afterwards, the caller remains responsible for that.
- Parameters
-
◆ ~VertexData()
Ogre::VertexData::~VertexData |
( |
| ) |
|
◆ clone()
Clones this vertex data, potentially including replicating any vertex buffers.
- Parameters
-
copyData | Whether to create new vertex buffers too or just reference the existing ones |
mgr | If supplied, the buffer manager through which copies should be made |
◆ prepareForShadowVolume()
void Ogre::VertexData::prepareForShadowVolume |
( |
void |
| ) |
|
Modifies the vertex data to be suitable for use for rendering shadow geometry.
- It's important to appreciate that this method can fundamentally change the structure of your vertex buffers, although in reality they will be new buffers. As it happens, if other objects are using the original buffers then they will be unaffected because the reference counting will keep them intact. However, if you have made any assumptions about the structure of the vertex data in the buffers of this object, you may have to rethink them.
◆ reorganiseBuffers() [1/2]
Reorganises the data in the vertex buffers according to the new vertex declaration passed in.
Note that new vertex buffers are created and written to, so if the buffers being referenced by this vertex data object are also used by others, then the original buffers will not be damaged by this operation. Once this operation has completed, the new declaration passed in will overwrite the current one.
- Parameters
-
newDeclaration | The vertex declaration which will be used for the reorganised buffer state. Note that the new declaration must not include any elements which do not already exist in the current declaration; you can drop elements by excluding them from the declaration if you wish, however. |
bufferUsage | Vector of usage flags which indicate the usage options for each new vertex buffer created. The indexes of the entries must correspond to the buffer binding values referenced in the declaration. |
mgr | Optional pointer to the manager to use to create new declarations and buffers etc. If not supplied, the HardwareBufferManager singleton will be used |
◆ reorganiseBuffers() [2/2]
Reorganises the data in the vertex buffers according to the new vertex declaration passed in.
Note that new vertex buffers are created and written to, so if the buffers being referenced by this vertex data object are also used by others, then the original buffers will not be damaged by this operation. Once this operation has completed, the new declaration passed in will overwrite the current one. This version of the method derives the buffer usages from the existing buffers, by using the 'most flexible' usage from the equivalent sources.
- Parameters
-
newDeclaration | The vertex declaration which will be used for the reorganised buffer state. Note that the new delcaration must not include any elements which do not already exist in the current declaration; you can drop elements by excluding them from the declaration if you wish, however. |
mgr | Optional pointer to the manager to use to create new declarations and buffers etc. If not supplied, the HardwareBufferManager singleton will be used |
◆ closeGapsInBindings()
void Ogre::VertexData::closeGapsInBindings |
( |
void |
| ) |
|
Remove any gaps in the vertex buffer bindings.
- Note
- This will cause binding index of the elements in the vertex declaration to be altered to new binding index.
◆ removeUnusedBuffers()
void Ogre::VertexData::removeUnusedBuffers |
( |
void |
| ) |
|
Remove all vertex buffers that never used by the vertex declaration.
- Note
- This also remove any gaps in the vertex buffer bindings.
◆ convertPackedColour()
Convert all packed colour values (VET_COLOUR_*) in buffers used to another type.
- Parameters
-
srcType | The source colour type to assume if the ambiguous VET_COLOUR is encountered. |
destType | The destination colour type, must be VET_COLOUR_ABGR or VET_COLOUR_ARGB. |
◆ allocateHardwareAnimationElements()
ushort Ogre::VertexData::allocateHardwareAnimationElements |
( |
ushort |
count, |
|
|
bool |
animateNormals |
|
) |
| |
Allocate elements to serve a holder of morph / pose target data for hardware morphing / pose blending.
- Returns
- The number of sets that were supported
◆ vertexDeclaration
Declaration of the vertex to be used in this operation.
◆ vertexBufferBinding
The vertex buffer bindings to be used.
◆ mDeleteDclBinding
bool Ogre::VertexData::mDeleteDclBinding |
Whether this class should delete the declaration and binding.
◆ vertexStart
size_t Ogre::VertexData::vertexStart |
The base vertex index to start from.
◆ vertexCount
size_t Ogre::VertexData::vertexCount |
The number of vertices used in this operation.
◆ hwAnimationDataList
VertexElements used for hardware morph / pose animation.
◆ hwAnimDataItemsUsed
size_t Ogre::VertexData::hwAnimDataItemsUsed |
Number of hardware animation data items used.
◆ hardwareShadowVolWBuffer
Additional shadow volume vertex buffer storage.
Note that we don't store any vertex declaration or vertex buffer binding here because this can be reused in the shadow algorithm.
The documentation for this class was generated from the following file: