Ogre::DefaultHardwareBufferManager Class Reference
Core » RenderSystem

DefaultHardwareBufferManager as a Singleton. More...

`#include <OgreDefaultHardwareBufferManager.h>`

Inheritance diagram for Ogre::DefaultHardwareBufferManager:
[legend]

## Public Types

enum | BufferLicenseType { BLT_MANUAL_RELEASE, BLT_AUTOMATIC_RELEASE }

## Public Member Functions

| DefaultHardwareBufferManager ()
| ~DefaultHardwareBufferManager ()
virtual void | _forceReleaseBufferCopies (const HardwareVertexBufferSharedPtr &sourceBuffer)
| Internal method that forces the release of copies of a given buffer. More...
virtual void | _forceReleaseBufferCopies (HardwareVertexBuffer *sourceBuffer)
| Internal method that forces the release of copies of a given buffer. More...
virtual void | _freeUnusedBufferCopies (void)
| Free all unused vertex buffer copies. More...
void | _notifyConterBufferDestroyed (HardwareCounterBuffer *buf)
void | _notifyCounterBufferDestroyed (HardwareCounterBuffer *buf)
| Notification that at hardware counter buffer has been destroyed. More...
void | _notifyIndexBufferDestroyed (HardwareIndexBuffer *buf)
| Notification that a hardware index buffer has been destroyed. More...
void | _notifyUniformBufferDestroyed (HardwareUniformBuffer *buf)
void | _notifyVertexBufferDestroyed (HardwareVertexBuffer *buf)
| Notification that a hardware vertex buffer has been destroyed. More...
virtual void | _releaseBufferCopies (bool forceFreeUnused=false)
| Internal method for releasing all temporary buffers which have been allocated using BLT_AUTOMATIC_RELEASE; is called by OGRE. More...
virtual HardwareVertexBufferSharedPtr | allocateVertexBufferCopy (const HardwareVertexBufferSharedPtr &sourceBuffer, BufferLicenseType licenseType, HardwareBufferLicensee *licensee, bool copyData=false)
| Allocates a copy of a given vertex buffer. More...
HardwareCounterBufferSharedPtr | createCounterBuffer (size_t sizeBytes, HardwareBuffer::Usage usage, bool useShadowBuffer, const String &name="")
| Create counter buffer. More...
HardwareIndexBufferSharedPtr | createIndexBuffer (HardwareIndexBuffer::IndexType itype, size_t numIndexes, HardwareBuffer::Usage usage, bool useShadowBuffer=false)
| Create a hardware index buffer. More...
RenderToVertexBufferSharedPtr | createRenderToVertexBuffer ()
| Create a render to vertex buffer. More...
HardwareUniformBufferSharedPtr | createUniformBuffer (size_t sizeBytes, HardwareBuffer::Usage usage, bool useShadowBuffer, const String &name="")
| Create uniform buffer. More...
HardwareVertexBufferSharedPtr | createVertexBuffer (size_t vertexSize, size_t numVerts, HardwareBuffer::Usage usage, bool useShadowBuffer=false)
| Create a hardware vertex buffer. More...
virtual VertexBufferBinding * | createVertexBufferBinding (void)
| Creates a new VertexBufferBinding. More...
virtual VertexDeclaration * | createVertexDeclaration (void)
virtual void | destroyVertexBufferBinding (VertexBufferBinding *binding)
| Destroys a VertexBufferBinding. More...
virtual void | destroyVertexDeclaration (VertexDeclaration *decl)
| Destroys a vertex declaration. 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)
virtual void | registerVertexBufferSourceAndCopy (const HardwareVertexBufferSharedPtr &sourceBuffer, const HardwareVertexBufferSharedPtr &copy)
| Registers a vertex buffer as a copy of another. More...
virtual void | releaseVertexBufferCopy (const HardwareVertexBufferSharedPtr &bufferCopy)
| Manually release a vertex buffer copy for others to subsequently use. More...
virtual void | touchVertexBufferCopy (const HardwareVertexBufferSharedPtr &bufferCopy)
| Tell engine that the vertex buffer copy intent to reuse. More...

## Static Public Member Functions

static HardwareBufferManager & | getSingleton (void)
| Override standard Singleton retrieval. More...
static HardwareBufferManager * | getSingletonPtr (void)
| Override standard Singleton retrieval. More...

## Protected Types

typedef set< HardwareCounterBuffer * >::type | CounterBufferList
typedef multimap< HardwareVertexBuffer *, HardwareVertexBufferSharedPtr >::type | FreeTemporaryVertexBufferMap
| Map from original buffer to temporary buffers. More...
typedef set< HardwareIndexBuffer * >::type | IndexBufferList
typedef map< HardwareVertexBuffer *, VertexBufferLicense >::type | TemporaryVertexBufferLicenseMap
| Map from temporary buffer to details of a license. More...
typedef set< HardwareUniformBuffer * >::type | UniformBufferList
typedef set< VertexBufferBinding * >::type | VertexBufferBindingList
typedef set< HardwareVertexBuffer * >::type | VertexBufferList
| WARNING: The following two members should place before all other members. More...
typedef set< VertexDeclaration * >::type | VertexDeclarationList

## Protected Member Functions

virtual VertexBufferBinding * | createVertexBufferBindingImpl (void)
| Internal method for creates a new VertexBufferBinding, may be overridden by certain rendering APIs. More...
virtual VertexDeclaration * | createVertexDeclarationImpl (void)
| Internal method for creates a new vertex declaration, may be overridden by certain rendering APIs. More...
virtual void | destroyAllBindings (void)
| Internal method for destroys all vertex buffer bindings. More...
virtual void | destroyAllDeclarations (void)
| Internal method for destroys all vertex declarations. More...
virtual void | destroyVertexBufferBindingImpl (VertexBufferBinding *binding)
| Internal method for destroys a VertexBufferBinding, may be overridden by certain rendering APIs. More...
virtual void | destroyVertexDeclarationImpl (VertexDeclaration *decl)
| Internal method for destroys a vertex declaration, may be overridden by certain rendering APIs. More...
virtual HardwareVertexBufferSharedPtr | makeBufferCopy (const HardwareVertexBufferSharedPtr &source, HardwareBuffer::Usage usage, bool useShadowBuffer)
| Creates a new buffer as a copy of the source, does not copy data. More...
| OGRE_MUTEX (mVertexBuffersMutex)
| OGRE_MUTEX (mIndexBuffersMutex)
| OGRE_MUTEX (mUniformBuffersMutex)
| OGRE_MUTEX (mCounterBuffersMutex)
| OGRE_MUTEX (mVertexDeclarationsMutex)
| OGRE_MUTEX (mVertexBufferBindingsMutex)
| OGRE_MUTEX (mTempBuffersMutex)

## Protected Attributes

CounterBufferList | mCounterBuffers
FreeTemporaryVertexBufferMap | mFreeTempVertexBufferMap
| Map of current available temp buffers. More...
HardwareBufferManagerBase * | mImpl
IndexBufferList | mIndexBuffers
TemporaryVertexBufferLicenseMap | mTempVertexBufferLicenses
| Map of currently licensed temporary buffers. More...
size_t | mUnderUsedFrameCount
| Number of frames elapsed since temporary buffers utilization was above half the available. More...
UniformBufferList | mUniformBuffers
VertexBufferBindingList | mVertexBufferBindings
VertexBufferList | mVertexBuffers
VertexDeclarationList | mVertexDeclarations

## Static Protected Attributes

static const size_t | EXPIRED_DELAY_FRAME_THRESHOLD
| Frame delay for BLT_AUTOMATIC_RELEASE temporary buffers. More...
static HardwareBufferManager * | msSingleton
static const size_t | UNDER_USED_FRAME_THRESHOLD
| Number of frames to wait before free unused temporary buffers. More...

## Detailed Description

DefaultHardwareBufferManager as a Singleton.

Definition at line 183 of file OgreDefaultHardwareBufferManager.h.

## Member Typedef Documentation

## CounterBufferList

typedef set<HardwareCounterBuffer*>::type Ogre::HardwareBufferManagerBase::CounterBufferList

protected inherited

Definition at line 126 of file OgreHardwareBufferManager.h.

## FreeTemporaryVertexBufferMap

typedef multimap<HardwareVertexBuffer*, HardwareVertexBufferSharedPtr>::type Ogre::HardwareBufferManagerBase::FreeTemporaryVertexBufferMap

protected inherited

Map from original buffer to temporary buffers.

Definition at line 197 of file OgreHardwareBufferManager.h.

## IndexBufferList

typedef set<HardwareIndexBuffer*>::type Ogre::HardwareBufferManagerBase::IndexBufferList

protected inherited

Definition at line 124 of file OgreHardwareBufferManager.h.

## TemporaryVertexBufferLicenseMap

typedef map<HardwareVertexBuffer*, VertexBufferLicense>::type Ogre::HardwareBufferManagerBase::TemporaryVertexBufferLicenseMap

protected inherited

Map from temporary buffer to details of a license.

Definition at line 201 of file OgreHardwareBufferManager.h.

## UniformBufferList

typedef set<HardwareUniformBuffer*>::type Ogre::HardwareBufferManagerBase::UniformBufferList

protected inherited

Definition at line 125 of file OgreHardwareBufferManager.h.

## VertexBufferBindingList

typedef set<VertexBufferBinding*>::type Ogre::HardwareBufferManagerBase::VertexBufferBindingList

protected inherited

Definition at line 134 of file OgreHardwareBufferManager.h.

## VertexBufferList

typedef set<HardwareVertexBuffer*>::type Ogre::HardwareBufferManagerBase::VertexBufferList

protected inherited

WARNING: The following two members should place before all other members.

Members destruct order is very important here, because destructing other members will cause notify back to this class, and then will access to this two members.

Definition at line 123 of file OgreHardwareBufferManager.h.

## VertexDeclarationList

typedef set<VertexDeclaration*>::type Ogre::HardwareBufferManagerBase::VertexDeclarationList

protected inherited

Definition at line 133 of file OgreHardwareBufferManager.h.

## Member Enumeration Documentation

## BufferLicenseType

enum Ogre::HardwareBufferManagerBase::BufferLicenseType

inherited

Enumerator
BLT_MANUAL_RELEASE | Licensee will only release buffer when it says so.
BLT_AUTOMATIC_RELEASE | Licensee can have license revoked.

Definition at line 163 of file OgreHardwareBufferManager.h.

## Constructor & Destructor Documentation

## DefaultHardwareBufferManager()

Ogre::DefaultHardwareBufferManager::DefaultHardwareBufferManager | ( |  | ) |

Definition at line 186 of file OgreDefaultHardwareBufferManager.h.

## ~DefaultHardwareBufferManager()

Ogre::DefaultHardwareBufferManager::~DefaultHardwareBufferManager | ( |  | ) |

Definition at line 191 of file OgreDefaultHardwareBufferManager.h.

References OGRE_DELETE.

## Member Function Documentation

## _forceReleaseBufferCopies() [1/2]

virtual void Ogre::HardwareBufferManager::_forceReleaseBufferCopies | ( | const HardwareVertexBufferSharedPtr & | sourceBuffer | ) |

virtual inherited

Internal method that forces the release of copies of a given buffer.

Remarks
  This usually means that the buffer which the copies are based on has been changed in some fundamental way, and the owner of the original wishes to make that known so that new copies will reflect the changes.

Parameters

  sourceBuffer | The source buffer as a shared pointer. Any buffer copies created from the source buffer are deleted.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 536 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_forceReleaseBufferCopies().

## _forceReleaseBufferCopies() [2/2]

virtual void Ogre::HardwareBufferManager::_forceReleaseBufferCopies | ( | HardwareVertexBuffer * | sourceBuffer | ) |

virtual inherited

Internal method that forces the release of copies of a given buffer.

Remarks
  This usually means that the buffer which the copies are based on has been changed in some fundamental way, and the owner of the original wishes to make that known so that new copies will reflect the changes.

Parameters

  sourceBuffer | The source buffer as a shared pointer. Any buffer copies created from the source buffer are deleted.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 542 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_forceReleaseBufferCopies().

## _freeUnusedBufferCopies()

virtual void Ogre::HardwareBufferManager::_freeUnusedBufferCopies | ( | void |  | ) |

virtual inherited

Free all unused vertex buffer copies.

Remarks
  This method free all temporary vertex buffers that not in used. In normally, temporary vertex buffers are subsequently stored and can be made available for other purposes later without incurring the cost of construction / destruction. But in some cases you want to free them to save hardware memory (e.g. application was runs in a long time, you might free temporary buffers periodically to avoid memory overload).

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 526 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_freeUnusedBufferCopies().

## _notifyConterBufferDestroyed()

void Ogre::HardwareBufferManager::_notifyConterBufferDestroyed | ( | HardwareCounterBuffer * | buf | ) |

inherited

Definition at line 562 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_notifyCounterBufferDestroyed().

## _notifyCounterBufferDestroyed()

void Ogre::HardwareBufferManagerBase::_notifyCounterBufferDestroyed | ( | HardwareCounterBuffer * | buf | ) |

inherited

Notification that at hardware counter buffer has been destroyed.

Referenced by Ogre::HardwareBufferManager::_notifyConterBufferDestroyed().

## _notifyIndexBufferDestroyed()

void Ogre::HardwareBufferManager::_notifyIndexBufferDestroyed | ( | HardwareIndexBuffer * | buf | ) |

inherited

Notification that a hardware index buffer has been destroyed.

Definition at line 552 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_notifyIndexBufferDestroyed().

## _notifyUniformBufferDestroyed()

void Ogre::HardwareBufferManager::_notifyUniformBufferDestroyed | ( | HardwareUniformBuffer * | buf | ) |

inherited

Definition at line 557 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_notifyUniformBufferDestroyed().

## _notifyVertexBufferDestroyed()

void Ogre::HardwareBufferManager::_notifyVertexBufferDestroyed | ( | HardwareVertexBuffer * | buf | ) |

inherited

Notification that a hardware vertex buffer has been destroyed.

Definition at line 547 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_notifyVertexBufferDestroyed().

## _releaseBufferCopies()

virtual void Ogre::HardwareBufferManager::_releaseBufferCopies | ( | bool | forceFreeUnused = `false` | ) |

virtual inherited

Internal method for releasing all temporary buffers which have been allocated using BLT_AUTOMATIC_RELEASE; is called by OGRE.

Parameters

  forceFreeUnused | If `true`, free all unused temporary buffers. If `false`, auto detect and free all unused temporary buffers based on temporary buffers utilization.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 531 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_releaseBufferCopies().

## allocateVertexBufferCopy()

virtual HardwareVertexBufferSharedPtr Ogre::HardwareBufferManager::allocateVertexBufferCopy | ( | const HardwareVertexBufferSharedPtr & | sourceBuffer,
|  | BufferLicenseType | licenseType,
|  | HardwareBufferLicensee * | licensee,
|  | bool | copyData = `false`
| ) |  |

virtual inherited

Allocates a copy of a given vertex buffer.

Remarks
  This method allocates a temporary copy of an existing vertex buffer. This buffer is subsequently stored and can be made available for other purposes later without incurring the cost of construction / destruction.

Parameters

  sourceBuffer | The source buffer to use as a copy.
  licenseType | The type of license required on this buffer - automatic release causes this class to release licenses every frame so that they can be reallocated anew.
  licensee | Pointer back to the class requesting the copy, which must implement HardwareBufferLicense in order to be notified when the license expires.
  copyData | If `true`, the current data is copied as well as the structure of the buffer/

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 503 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::allocateVertexBufferCopy().

## createCounterBuffer()

HardwareCounterBufferSharedPtr Ogre::HardwareBufferManager::createCounterBuffer | ( | size_t | sizeBytes,
|  | HardwareBuffer::Usage | usage,
|  | bool | useShadowBuffer,
|  | const String & | name = `""`
| ) |  |

virtual inherited

Create counter buffer.

The update shall be triggered by GpuProgramParameters, if is dirty

Implements Ogre::HardwareBufferManagerBase.

Definition at line 469 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createCounterBuffer().

## createIndexBuffer()

HardwareIndexBufferSharedPtr Ogre::HardwareBufferManager::createIndexBuffer | ( | HardwareIndexBuffer::IndexType | itype,
|  | size_t | numIndexes,
|  | HardwareBuffer::Usage | usage,
|  | bool | useShadowBuffer = `false`
| ) |  |

virtual inherited

Create a hardware index buffer.

Remarks
  Note that because buffers can be shared, they are reference counted so you do not need to worry about destroying them this will be done automatically.

Parameters

  itype | The type in index, either 16- or 32-bit, depending on how many vertices you need to be able to address
  numIndexes | The number of indexes in the buffer
  usage | One or more members of the HardwareBuffer::Usage enumeration.

  useShadowBuffer

  If set to `true`, this buffer will be 'shadowed' by one stored in system memory rather than GPU or AGP memory. You should set this flag if you intend to read data back from the index buffer, because reading data from a buffer in the GPU or AGP memory is very expensive, and is in fact impossible if you specify HBU_WRITE_ONLY for the main buffer. If you use this option, all reads and writes will be done to the shadow buffer, and the shadow buffer will be synchronised with the real buffer at an appropriate time.

Implements Ogre::HardwareBufferManagerBase.

Definition at line 448 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createIndexBuffer().

## createRenderToVertexBuffer()

RenderToVertexBufferSharedPtr Ogre::HardwareBufferManager::createRenderToVertexBuffer | ( |  | ) |

virtual inherited

Create a render to vertex buffer.

Remarks
  The parameters (such as vertex size etc) are determined later and are allocated when needed.

Implements Ogre::HardwareBufferManagerBase.

Definition at line 455 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createRenderToVertexBuffer().

## createUniformBuffer()

HardwareUniformBufferSharedPtr Ogre::HardwareBufferManager::createUniformBuffer | ( | size_t | sizeBytes,
|  | HardwareBuffer::Usage | usage,
|  | bool | useShadowBuffer,
|  | const String & | name = `""`
| ) |  |

virtual inherited

Create uniform buffer.

This type of buffer allows the upload of shader constants once, and sharing between shader stages or even shaders from another materials. The update shall be triggered by GpuProgramParameters, if is dirty

Implements Ogre::HardwareBufferManagerBase.

Definition at line 462 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createUniformBuffer().

## createVertexBuffer()

HardwareVertexBufferSharedPtr Ogre::HardwareBufferManager::createVertexBuffer | ( | size_t | vertexSize,
|  | size_t | numVerts,
|  | HardwareBuffer::Usage | usage,
|  | bool | useShadowBuffer = `false`
| ) |  |

virtual inherited

Create a hardware vertex buffer.

Remarks
  This method creates a new vertex buffer; this will act as a source of geometry data for rendering objects. Note that because the meaning of the contents of the vertex buffer depends on the usage, this method does not specify a vertex format; the user of this buffer can actually insert whatever data they wish, in any format. However, in order to use this with a RenderOperation, the data in this vertex buffer will have to be associated with a semantic element of the rendering pipeline, e.g. a position, or texture coordinates. This is done using the VertexDeclaration class, which itself contains VertexElement structures referring to the source data.
  Note that because vertex buffers can be shared, they are reference counted so you do not need to worry about destroying themm this will be done automatically.

Parameters

  vertexSize | The size in bytes of each vertex in this buffer; you must calculate this based on the kind of data you expect to populate this buffer with.
  numVerts | The number of vertices in this buffer.
  usage | One or more members of the HardwareBuffer::Usage enumeration; you are strongly advised to use HBU_STATIC_WRITE_ONLY wherever possible, if you need to update regularly, consider HBU_DYNAMIC_WRITE_ONLY and useShadowBuffer=true.

  useShadowBuffer

  If set to `true`, this buffer will be 'shadowed' by one stored in system memory rather than GPU or AGP memory. You should set this flag if you intend to read data back from the vertex buffer, because reading data from a buffer in the GPU or AGP memory is very expensive, and is in fact impossible if you specify HBU_WRITE_ONLY for the main buffer. If you use this option, all reads and writes will be done to the shadow buffer, and the shadow buffer will be synchronised with the real buffer at an appropriate time.

Implements Ogre::HardwareBufferManagerBase.

Definition at line 441 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createVertexBuffer().

## createVertexBufferBinding()

virtual VertexBufferBinding* Ogre::HardwareBufferManager::createVertexBufferBinding | ( | void |  | ) |

virtual inherited

Creates a new VertexBufferBinding.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 486 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createVertexBufferBinding().

## createVertexBufferBindingImpl()

virtual VertexBufferBinding* Ogre::HardwareBufferManagerBase::createVertexBufferBindingImpl | ( | void |  | ) |

protected virtual inherited

Internal method for creates a new VertexBufferBinding, may be overridden by certain rendering APIs.

## createVertexDeclaration()

virtual VertexDeclaration* Ogre::HardwareBufferManager::createVertexDeclaration | ( | void |  | ) |

virtual inherited

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 475 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createVertexDeclaration().

## createVertexDeclarationImpl()

virtual VertexDeclaration* Ogre::HardwareBufferManagerBase::createVertexDeclarationImpl | ( | void |  | ) |

protected virtual inherited

Internal method for creates a new vertex declaration, may be overridden by certain rendering APIs.

## destroyAllBindings()

virtual void Ogre::HardwareBufferManagerBase::destroyAllBindings | ( | void |  | ) |

protected virtual inherited

Internal method for destroys all vertex buffer bindings.

## destroyAllDeclarations()

virtual void Ogre::HardwareBufferManagerBase::destroyAllDeclarations | ( | void |  | ) |

protected virtual inherited

Internal method for destroys all vertex declarations.

## destroyVertexBufferBinding()

virtual void Ogre::HardwareBufferManager::destroyVertexBufferBinding | ( | VertexBufferBinding * | binding | ) |

virtual inherited

Destroys a VertexBufferBinding.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 491 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::destroyVertexBufferBinding().

## destroyVertexBufferBindingImpl()

virtual void Ogre::HardwareBufferManagerBase::destroyVertexBufferBindingImpl | ( | VertexBufferBinding * | binding | ) |

protected virtual inherited

Internal method for destroys a VertexBufferBinding, may be overridden by certain rendering APIs.

## destroyVertexDeclaration()

virtual void Ogre::HardwareBufferManager::destroyVertexDeclaration | ( | VertexDeclaration * | decl | ) |

virtual inherited

Destroys a vertex declaration.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 480 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::destroyVertexDeclaration().

## destroyVertexDeclarationImpl()

virtual void Ogre::HardwareBufferManagerBase::destroyVertexDeclarationImpl | ( | VertexDeclaration * | decl | ) |

protected virtual inherited

Internal method for destroys a vertex declaration, may be overridden by certain rendering APIs.

## getSingleton()

static HardwareBufferManager& Ogre::HardwareBufferManager::getSingleton | ( | void |  | ) |

static inherited

Override standard Singleton retrieval.

Remarks
  Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

  This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

## getSingletonPtr()

static HardwareBufferManager* Ogre::HardwareBufferManager::getSingletonPtr | ( | void |  | ) |

static inherited

Override standard Singleton retrieval.

Remarks
  Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

  This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

## makeBufferCopy()

virtual HardwareVertexBufferSharedPtr Ogre::HardwareBufferManagerBase::makeBufferCopy | ( | const HardwareVertexBufferSharedPtr & | source,
|  | HardwareBuffer::Usage | usage,
|  | bool | useShadowBuffer
| ) |  |

protected virtual inherited

Creates a new buffer as a copy of the source, does not copy data.

## OGRE_MUTEX() [1/7]

Ogre::HardwareBufferManagerBase::OGRE_MUTEX | ( | mVertexBuffersMutex |  | ) |

protected inherited

## OGRE_MUTEX() [2/7]

Ogre::HardwareBufferManagerBase::OGRE_MUTEX | ( | mIndexBuffersMutex |  | ) |

protected inherited

## OGRE_MUTEX() [3/7]

Ogre::HardwareBufferManagerBase::OGRE_MUTEX | ( | mUniformBuffersMutex |  | ) |

protected inherited

## OGRE_MUTEX() [4/7]

Ogre::HardwareBufferManagerBase::OGRE_MUTEX | ( | mCounterBuffersMutex |  | ) |

protected inherited

## OGRE_MUTEX() [5/7]

Ogre::HardwareBufferManagerBase::OGRE_MUTEX | ( | mVertexDeclarationsMutex |  | ) |

protected inherited

## OGRE_MUTEX() [6/7]

Ogre::HardwareBufferManagerBase::OGRE_MUTEX | ( | mVertexBufferBindingsMutex |  | ) |

protected inherited

## OGRE_MUTEX() [7/7]

Ogre::HardwareBufferManagerBase::OGRE_MUTEX | ( | mTempBuffersMutex |  | ) |

protected inherited

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

## registerVertexBufferSourceAndCopy()

virtual void Ogre::HardwareBufferManager::registerVertexBufferSourceAndCopy | ( | const HardwareVertexBufferSharedPtr & | sourceBuffer,
|  | const HardwareVertexBufferSharedPtr & | copy
| ) |  |

virtual inherited

Registers a vertex buffer as a copy of another.

Remarks
  This is useful for registering an existing buffer as a temporary buffer which can be allocated just like a copy.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 496 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::registerVertexBufferSourceAndCopy().

## releaseVertexBufferCopy()

virtual void Ogre::HardwareBufferManager::releaseVertexBufferCopy | ( | const HardwareVertexBufferSharedPtr & | bufferCopy | ) |

virtual inherited

Manually release a vertex buffer copy for others to subsequently use.

Remarks
  Only required if the original call to allocateVertexBufferCopy included a licenseType of BLT_MANUAL_RELEASE.

Parameters

  bufferCopy | The buffer copy. The caller is expected to delete or at least no longer use this reference, since another user may well begin to modify the contents of the buffer.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 512 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::releaseVertexBufferCopy().

## touchVertexBufferCopy()

virtual void Ogre::HardwareBufferManager::touchVertexBufferCopy | ( | const HardwareVertexBufferSharedPtr & | bufferCopy | ) |

virtual inherited

Tell engine that the vertex buffer copy intent to reuse.

Remarks
  Ogre internal keep an expired delay counter of BLT_AUTOMATIC_RELEASE buffers, when the counter count down to zero, it'll release for other purposes later. But you can use this function to reset the counter to the internal configured value, keep the buffer not get released for some frames.

Parameters

  bufferCopy | The buffer copy. The caller is expected to keep this buffer copy for use.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 519 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::touchVertexBufferCopy().

## Member Data Documentation

## EXPIRED_DELAY_FRAME_THRESHOLD

const size_t Ogre::HardwareBufferManagerBase::EXPIRED_DELAY_FRAME_THRESHOLD

static protected inherited

Frame delay for BLT_AUTOMATIC_RELEASE temporary buffers.

Definition at line 209 of file OgreHardwareBufferManager.h.

## mCounterBuffers

CounterBufferList Ogre::HardwareBufferManagerBase::mCounterBuffers

protected inherited

Definition at line 130 of file OgreHardwareBufferManager.h.

## mFreeTempVertexBufferMap

FreeTemporaryVertexBufferMap Ogre::HardwareBufferManagerBase::mFreeTempVertexBufferMap

protected inherited

Map of current available temp buffers.

Definition at line 199 of file OgreHardwareBufferManager.h.

## mImpl

HardwareBufferManagerBase* Ogre::HardwareBufferManager::mImpl

protected inherited

Definition at line 434 of file OgreHardwareBufferManager.h.

## mIndexBuffers

IndexBufferList Ogre::HardwareBufferManagerBase::mIndexBuffers

protected inherited

Definition at line 128 of file OgreHardwareBufferManager.h.

## msSingleton

HardwareBufferManager * Ogre::Singleton< HardwareBufferManager >::msSingleton

static protected inherited

Definition at line 75 of file OgreSingleton.h.

## mTempVertexBufferLicenses

TemporaryVertexBufferLicenseMap Ogre::HardwareBufferManagerBase::mTempVertexBufferLicenses

protected inherited

Map of currently licensed temporary buffers.

Definition at line 203 of file OgreHardwareBufferManager.h.

## mUnderUsedFrameCount

size_t Ogre::HardwareBufferManagerBase::mUnderUsedFrameCount

protected inherited

Number of frames elapsed since temporary buffers utilization was above half the available.

Definition at line 205 of file OgreHardwareBufferManager.h.

## mUniformBuffers

UniformBufferList Ogre::HardwareBufferManagerBase::mUniformBuffers

protected inherited

Definition at line 129 of file OgreHardwareBufferManager.h.

## mVertexBufferBindings

VertexBufferBindingList Ogre::HardwareBufferManagerBase::mVertexBufferBindings

protected inherited

Definition at line 136 of file OgreHardwareBufferManager.h.

## mVertexBuffers

VertexBufferList Ogre::HardwareBufferManagerBase::mVertexBuffers

protected inherited

Definition at line 127 of file OgreHardwareBufferManager.h.

## mVertexDeclarations

VertexDeclarationList Ogre::HardwareBufferManagerBase::mVertexDeclarations

protected inherited

Definition at line 135 of file OgreHardwareBufferManager.h.

## UNDER_USED_FRAME_THRESHOLD

const size_t Ogre::HardwareBufferManagerBase::UNDER_USED_FRAME_THRESHOLD

static protected inherited

Number of frames to wait before free unused temporary buffers.

Definition at line 207 of file OgreHardwareBufferManager.h.

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

- OgreDefaultHardwareBufferManager.h

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