Ogre::IndexData Class Reference
Core » RenderSystem

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

`#include <OgreVertexIndexData.h>`

Inheritance diagram for Ogre::IndexData:
[legend]

## Public Member Functions

| IndexData ()
| ~IndexData ()
IndexData * | clone (bool copyData=true, HardwareBufferManagerBase *mgr=0) const
| Clones this index data, potentially including replicating the index buffer. 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)
void | optimiseVertexCacheTriList (void)
| 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...

## Protected Member Functions

| IndexData (const IndexData &rhs)
| Protected copy constructor, to prevent misuse. More...
IndexData & | operator= (const IndexData &rhs)
| Protected operator=, to prevent misuse. More...

## Detailed Description

Summary class collecting together index data source information.

Definition at line 242 of file OgreVertexIndexData.h.

## Constructor & Destructor Documentation

## IndexData() [1/2]

Ogre::IndexData::IndexData | ( | const IndexData & | rhs | ) |

protected

Protected copy constructor, to prevent misuse.

## IndexData() [2/2]

Ogre::IndexData::IndexData | ( |  | ) |

## ~IndexData()

Ogre::IndexData::~IndexData | ( |  | ) |

## Member Function Documentation

## clone()

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

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

Parameters

  copyData | Whether to create new buffers too or just reference the existing ones
  mgr | If supplied, the buffer manager through which copies should be made

Remarks
  The caller is expected to delete the returned pointer when finished

## operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) |

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

## operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr,
|  | void * |
| ) |  |

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

## operator delete() [3/3]

template<class Alloc >

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

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) |

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

## operator delete[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

## operator new() [1/3]

template<class Alloc >

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

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

## operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) |

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

## operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

## operator new[]() [1/2]

template<class Alloc >

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

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

## operator new[]() [2/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

## operator=()

IndexData& Ogre::IndexData::operator= | ( | const IndexData & | rhs | ) |

protected

Protected operator=, to prevent misuse.

## optimiseVertexCacheTriList()

void Ogre::IndexData::optimiseVertexCacheTriList | ( | void |  | ) |

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::IndexData::indexBuffer

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

Definition at line 253 of file OgreVertexIndexData.h.

## indexCount

size_t Ogre::IndexData::indexCount

The number of indexes to use from the buffer.

Definition at line 259 of file OgreVertexIndexData.h.

## indexStart

size_t Ogre::IndexData::indexStart

Index in the buffer to start from for this operation.

Definition at line 256 of file OgreVertexIndexData.h.

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

- OgreVertexIndexData.h

Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.