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

Standard implementation of a buffer allocator which re-uses buffers. More...

#include <OgreTerrain.h>

+ Inheritance diagram for Ogre::Terrain::DefaultGpuBufferAllocator:
+ Collaboration diagram for Ogre::Terrain::DefaultGpuBufferAllocator:

Public Member Functions

 DefaultGpuBufferAllocator ()
 
virtual ~DefaultGpuBufferAllocator ()
 
void allocateVertexBuffers (Terrain *forTerrain, size_t numVertices, HardwareVertexBufferSharedPtr &destPos, HardwareVertexBufferSharedPtr &destDelta)
 Allocate (or reuse) vertex buffers for a terrain LOD. More...
 
void freeAllBuffers ()
 Free any buffers we're holding. More...
 
void freeVertexBuffers (const HardwareVertexBufferSharedPtr &posbuf, const HardwareVertexBufferSharedPtr &deltabuf)
 Free (or return to the pool) vertex buffers for terrain. More...
 
HardwareIndexBufferSharedPtr getSharedIndexBuffer (uint16 batchSize, uint16 vdatasize, size_t vertexIncrement, uint16 xoffset, uint16 yoffset, uint16 numSkirtRowsCols, uint16 skirtRowColSkip)
 Get a shared index buffer for a given number of settings. 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 warmStart (size_t numInstances, uint16 terrainSize, uint16 maxBatchSize, uint16 minBatchSize)
 'Warm start' the allocator based on needing x instances of terrain with the given configuration. More...
 

Protected Types

typedef map< uint32,
HardwareIndexBufferSharedPtr >
::type 
IBufMap
 
typedef list
< HardwareVertexBufferSharedPtr >
::type 
VBufList
 

Protected Member Functions

HardwareVertexBufferSharedPtr getVertexBuffer (VBufList &list, size_t vertexSize, size_t numVertices)
 
uint32 hashIndexBuffer (uint16 batchSize, uint16 vdatasize, size_t vertexIncrement, uint16 xoffset, uint16 yoffset, uint16 numSkirtRowsCols, uint16 skirtRowColSkip)
 

Protected Attributes

VBufList mFreeDeltaBufList
 
VBufList mFreePosBufList
 
IBufMap mSharedIBufMap
 

Detailed Description

Standard implementation of a buffer allocator which re-uses buffers.

Definition at line 575 of file OgreTerrain.h.

Member Typedef Documentation

Constructor & Destructor Documentation

Ogre::Terrain::DefaultGpuBufferAllocator::DefaultGpuBufferAllocator ( )
virtual Ogre::Terrain::DefaultGpuBufferAllocator::~DefaultGpuBufferAllocator ( )
virtual

Member Function Documentation

void Ogre::Terrain::DefaultGpuBufferAllocator::allocateVertexBuffers ( Terrain forTerrain,
size_t  numVertices,
HardwareVertexBufferSharedPtr destPos,
HardwareVertexBufferSharedPtr destDelta 
)
virtual

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

Parameters
numVerticesThe total number of vertices
destPosPointer to a vertex buffer for positions, to be bound
destDeltaPointer to a vertex buffer for deltas, to be bound

Implements Ogre::Terrain::GpuBufferAllocator.

void Ogre::Terrain::DefaultGpuBufferAllocator::freeAllBuffers ( )
virtual

Free any buffers we're holding.

Implements Ogre::Terrain::GpuBufferAllocator.

void Ogre::Terrain::DefaultGpuBufferAllocator::freeVertexBuffers ( const HardwareVertexBufferSharedPtr posbuf,
const HardwareVertexBufferSharedPtr deltabuf 
)
virtual

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

Implements Ogre::Terrain::GpuBufferAllocator.

HardwareIndexBufferSharedPtr Ogre::Terrain::DefaultGpuBufferAllocator::getSharedIndexBuffer ( uint16  batchSize,
uint16  vdatasize,
size_t  vertexIncrement,
uint16  xoffset,
uint16  yoffset,
uint16  numSkirtRowsCols,
uint16  skirtRowColSkip 
)
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
batchSizeThe batch size along one edge
vdatasizeThe size of the referenced vertex data along one edge
vertexIncrementThe number of vertices to increment for each new indexed row / column
xoffsetThe x offset from the start of vdatasize, at that resolution
yoffsetThe y offset from the start of vdatasize, at that resolution
numSkirtRowsColsNumber of rows and columns of skirts
skirtRowColSkipThe number of rows / cols to skip in between skirts

Implements Ogre::Terrain::GpuBufferAllocator.

HardwareVertexBufferSharedPtr Ogre::Terrain::DefaultGpuBufferAllocator::getVertexBuffer ( VBufList list,
size_t  vertexSize,
size_t  numVertices 
)
protected
uint32 Ogre::Terrain::DefaultGpuBufferAllocator::hashIndexBuffer ( uint16  batchSize,
uint16  vdatasize,
size_t  vertexIncrement,
uint16  xoffset,
uint16  yoffset,
uint16  numSkirtRowsCols,
uint16  skirtRowColSkip 
)
protected
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.

void Ogre::Terrain::DefaultGpuBufferAllocator::warmStart ( size_t  numInstances,
uint16  terrainSize,
uint16  maxBatchSize,
uint16  minBatchSize 
)

'Warm start' the allocator based on needing x instances of terrain with the given configuration.

Member Data Documentation

VBufList Ogre::Terrain::DefaultGpuBufferAllocator::mFreeDeltaBufList
protected

Definition at line 596 of file OgreTerrain.h.

VBufList Ogre::Terrain::DefaultGpuBufferAllocator::mFreePosBufList
protected

Definition at line 595 of file OgreTerrain.h.

IBufMap Ogre::Terrain::DefaultGpuBufferAllocator::mSharedIBufMap
protected

Definition at line 598 of file OgreTerrain.h.


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