OGRE-Next  3.0.0
Object-Oriented Graphics Rendering Engine
Ogre::v1::IndexData Class Reference

Summary class collecting together index data source information. More...

#include <OgreVertexIndexData.h>

+ Inheritance diagram for Ogre::v1::IndexData:

Public Member Functions

 IndexData ()
 
 ~IndexData ()
 
IndexDataclone (bool copyData=true, HardwareBufferManagerBase *mgr=0) const
 Clones this index data, potentially including replicating the index buffer. More...
 
void optimiseVertexCacheTriList ()
 Re-order the indexes in this index data structure to be more vertex cache friendly; that is to re-use the same vertices as close together as possible. More...
 

Public Attributes

HardwareIndexBufferSharedPtr indexBuffer
 Pointer to the HardwareIndexBuffer to use, must be specified if useIndexes = true. More...
 
size_t indexCount
 The number of indexes to use from the buffer. More...
 
size_t indexStart
 Index in the buffer to start from for this operation. More...
 

Detailed Description

Summary class collecting together index data source information.

Constructor & Destructor Documentation

◆ IndexData()

Ogre::v1::IndexData::IndexData ( )

◆ ~IndexData()

Ogre::v1::IndexData::~IndexData ( )

Member Function Documentation

◆ clone()

IndexData* Ogre::v1::IndexData::clone ( bool  copyData = true,
HardwareBufferManagerBase mgr = 0 
) const

Clones this index data, potentially including replicating the index buffer.

Parameters
copyDataWhether to create new buffers too or just reference the existing ones
mgrIf supplied, the buffer manager through which copies should be made
Remarks
The caller is expected to delete the returned pointer when finished

◆ optimiseVertexCacheTriList()

void Ogre::v1::IndexData::optimiseVertexCacheTriList ( )

Re-order the indexes in this index data structure to be more vertex cache friendly; that is to re-use the same vertices as close together as possible.

Remarks
Can only be used for index data which consists of triangle lists. It would in fact be pointless to use it on triangle strips or fans in any case.

Member Data Documentation

◆ indexBuffer

HardwareIndexBufferSharedPtr Ogre::v1::IndexData::indexBuffer

Pointer to the HardwareIndexBuffer to use, must be specified if useIndexes = true.

Referenced by Ogre::VerticesRemapInfo::markUsedIndices(), and Ogre::VerticesRemapInfo::performIndexDataRemap().

◆ indexCount

size_t Ogre::v1::IndexData::indexCount

The number of indexes to use from the buffer.

Referenced by Ogre::VerticesRemapInfo::markUsedIndices(), and Ogre::VerticesRemapInfo::performIndexDataRemap().

◆ indexStart

size_t Ogre::v1::IndexData::indexStart

Index in the buffer to start from for this operation.

Referenced by Ogre::VerticesRemapInfo::markUsedIndices(), and Ogre::VerticesRemapInfo::performIndexDataRemap().


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