OGRE: Ogre::Terrain::GpuBufferAllocator Class Reference - OGRE Documentation

Public Member Functions

# Ogre::Terrain::GpuBufferAllocator Class Reference

Interface used to by the Terrain instance to allocate GPU buffers. More...

`#include <OgreTerrain.h>`

Inheritance diagram for Ogre::Terrain::GpuBufferAllocator:
[legend]

List of all members.

## Public Member Functions
| GpuBufferAllocator ()
virtual | ~GpuBufferAllocator ()
virtual void | allocateVertexBuffers (Terrain *forTerrain, size_t numVertices, HardwareVertexBufferSharedPtr &destPos, HardwareVertexBufferSharedPtr &destDelta)=0
| Allocate (or reuse) vertex buffers for a terrain LOD.
virtual void | freeVertexBuffers (const HardwareVertexBufferSharedPtr &posbuf, const HardwareVertexBufferSharedPtr &deltabuf)=0
| Free (or return to the pool) vertex buffers for terrain.
virtual HardwareIndexBufferSharedPtr | getSharedIndexBuffer (uint16 batchSize, uint16 vdatasize, size_t vertexIncrement, uint16 xoffset, uint16 yoffset, uint16 numSkirtRowsCols, uint16 skirtRowColSkip)=0
| Get a shared index buffer for a given number of settings.
virtual void | freeAllBuffers ()=0
| Free any buffers we're holding.
void * | operator new (size_t sz, const char *file, int line, const char *func)
| operator new, with debug line info
void * | operator new (size_t sz)
void * | operator new (size_t sz, void *ptr)
| placement operator new
void * | operator new[] (size_t sz, const char *file, int line, const char *func)
| array operator new, with debug line info
void * | operator new[] (size_t sz)
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 *)

## Detailed Description

Interface used to by the Terrain instance to allocate GPU buffers.

Remarks:
  This class exists to make it easier to re-use buffers between multiple instances of terrain.

Definition at line 524 of file OgreTerrain.h.

## Constructor & Destructor Documentation

Ogre::Terrain::GpuBufferAllocator::GpuBufferAllocator | ( |  | ) |

Definition at line 527 of file OgreTerrain.h.

virtual Ogre::Terrain::GpuBufferAllocator::~GpuBufferAllocator | ( |  | ) | `[virtual]`

Definition at line 528 of file OgreTerrain.h.

## Member Function Documentation

virtual void Ogre::Terrain::GpuBufferAllocator::allocateVertexBuffers | ( | Terrain * | forTerrain,
|  | size_t | numVertices,
|  | HardwareVertexBufferSharedPtr & | destPos,
|  | HardwareVertexBufferSharedPtr & | destDelta |
| ) |  |  | `[pure virtual]`

Allocate (or reuse) vertex buffers for a terrain LOD.

Parameters:

  | numVertices | The total number of vertices
  | destPos | Pointer to a vertex buffer for positions, to be bound
  | destDelta | Pointer to a vertex buffer for deltas, to be bound

Implemented in Ogre::Terrain::DefaultGpuBufferAllocator.

virtual void Ogre::Terrain::GpuBufferAllocator::freeAllBuffers | ( |  | ) | `[pure virtual]`

Free any buffers we're holding.

Implemented in Ogre::Terrain::DefaultGpuBufferAllocator.

virtual void Ogre::Terrain::GpuBufferAllocator::freeVertexBuffers | ( | const HardwareVertexBufferSharedPtr & | posbuf,
|  | const HardwareVertexBufferSharedPtr & | deltabuf |
| ) |  |  | `[pure virtual]`

Free (or return to the pool) vertex buffers for terrain.

Implemented in Ogre::Terrain::DefaultGpuBufferAllocator.

virtual HardwareIndexBufferSharedPtr Ogre::Terrain::GpuBufferAllocator::getSharedIndexBuffer | ( | uint16 | batchSize,
|  | uint16 | vdatasize,
|  | size_t | vertexIncrement,
|  | uint16 | xoffset,
|  | uint16 | yoffset,
|  | uint16 | numSkirtRowsCols,
|  | uint16 | skirtRowColSkip |
| ) |  |  | `[pure virtual]`

Get a shared index buffer for a given number of settings.

Remarks:
  Since all index structures are the same at the same LOD level and relative position, we can share index buffers. Therefore the buffer returned from this method does not need to be 'freed' like the vertex buffers since it is never owned.

Parameters:

  | batchSize | The batch size along one edge
  | vdatasize | The size of the referenced vertex data along one edge
  | vertexIncrement | The number of vertices to increment for each new indexed row / column
  | xoffset | The x offset from the start of vdatasize, at that resolution
  | yoffset | The y offset from the start of vdatasize, at that resolution
  | numSkirtRowsCols | Number of rows and columns of skirts
  | skirtRowColSkip | The number of rows / cols to skip in between skirts

Implemented in Ogre::Terrain::DefaultGpuBufferAllocator.

template<class Alloc >

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

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

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 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 72 of file OgreMemoryAllocatedObject.h.

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 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

Definition at line 90 of file OgreMemoryAllocatedObject.h.

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

- OgreTerrain.h

Copyright © 2008 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Wed Nov 3 2010 19:25:04