| OGRE 1.11.1 Object-Oriented Graphics Rendering Engine

Public Member Functions | List of all members
Ogre::Terrain::GpuBufferAllocator Class Referenceabstract

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

`#include <OgreTerrain.h>`

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

## 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. More...
virtual void | freeAllBuffers ()=0
| Free any buffers we're holding. More...
virtual void | freeVertexBuffers (const HardwareVertexBufferSharedPtr &posbuf, const HardwareVertexBufferSharedPtr &deltabuf)=0
| Free (or return to the pool) vertex buffers for terrain. More...
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. More...

## 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.

## Constructor & Destructor Documentation

## ◆ GpuBufferAllocator()

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

## ◆ ~GpuBufferAllocator()

virtual Ogre::Terrain::GpuBufferAllocator::~GpuBufferAllocator | ( |  | ) |
| inline virtual

## Member Function Documentation

## ◆ allocateVertexBuffers()

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.

## ◆ freeVertexBuffers()

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.

## ◆ getSharedIndexBuffer()

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.

## ◆ freeAllBuffers()

virtual void Ogre::Terrain::GpuBufferAllocator::freeAllBuffers | ( |  | ) |
| pure virtual

Free any buffers we're holding.

Implemented in Ogre::Terrain::DefaultGpuBufferAllocator.

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

- OgreTerrain.h