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

GLHardwareBufferManagerBase as a Singleton. More...

#include <OgreGLHardwareBufferManager.h>

+ Inheritance diagram for Ogre::GLHardwareBufferManager:
+ Collaboration diagram for Ogre::GLHardwareBufferManager:

Public Types

enum  BufferLicenseType { BLT_MANUAL_RELEASE, BLT_AUTOMATIC_RELEASE }
 

Public Member Functions

 GLHardwareBufferManager ()
 
 ~GLHardwareBufferManager ()
 
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...
 
void * allocateScratch (uint32 size)
 Allocator method to allow us to use a pool of memory as a scratch area for hardware buffers. 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 VertexBufferBindingcreateVertexBufferBinding (void)
 Creates a new VertexBufferBinding. More...
 
virtual VertexDeclarationcreateVertexDeclaration (void)
 
void deallocateScratch (void *ptr)
 
virtual void destroyVertexBufferBinding (VertexBufferBinding *binding)
 Destroys a VertexBufferBinding. More...
 
virtual void destroyVertexDeclaration (VertexDeclaration *decl)
 Destroys a vertex declaration. More...
 
size_t getGLMapBufferThreshold () const
 Threshold after which glMapBuffer is used and not glBufferSubData. 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...
 
void setGLMapBufferThreshold (const size_t value)
 
virtual void touchVertexBufferCopy (const HardwareVertexBufferSharedPtr &bufferCopy)
 Tell engine that the vertex buffer copy intent to reuse. More...
 

Static Public Member Functions

static GLenum getGLType (unsigned int type)
 Utility function to get the correct GL type based on VET's. More...
 
static GLenum getGLUsage (unsigned int usage)
 Utility function to get the correct GL usage based on HBU's. More...
 
static HardwareBufferManagergetSingleton (void)
 Override standard Singleton retrieval. More...
 
static HardwareBufferManagergetSingletonPtr (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 VertexBufferBindingcreateVertexBufferBindingImpl (void)
 Internal method for creates a new VertexBufferBinding, may be overridden by certain rendering APIs. More...
 
virtual VertexDeclarationcreateVertexDeclarationImpl (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...
 
HardwareBufferManagerBasemImpl
 
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 HardwareBufferManagermsSingleton
 
static const size_t UNDER_USED_FRAME_THRESHOLD
 Number of frames to wait before free unused temporary buffers. More...
 

Detailed Description

Member Typedef Documentation

Map from original buffer to temporary buffers.

Definition at line 197 of file OgreHardwareBufferManager.h.

Definition at line 124 of file OgreHardwareBufferManager.h.

Map from temporary buffer to details of a license.

Definition at line 201 of file OgreHardwareBufferManager.h.

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.

Member Enumeration Documentation

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

Ogre::GLHardwareBufferManager::GLHardwareBufferManager ( )
inline

Definition at line 97 of file OgreGLHardwareBufferManager.h.

Ogre::GLHardwareBufferManager::~GLHardwareBufferManager ( )
inline

Definition at line 102 of file OgreGLHardwareBufferManager.h.

References OGRE_DELETE.

Member Function Documentation

virtual void Ogre::HardwareBufferManager::_forceReleaseBufferCopies ( const HardwareVertexBufferSharedPtr sourceBuffer)
inlinevirtualinherited

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

virtual void Ogre::HardwareBufferManager::_forceReleaseBufferCopies ( HardwareVertexBuffer sourceBuffer)
inlinevirtualinherited

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

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

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.

void Ogre::HardwareBufferManager::_notifyConterBufferDestroyed ( HardwareCounterBuffer buf)
inlineinherited

Definition at line 562 of file OgreHardwareBufferManager.h.

void Ogre::HardwareBufferManagerBase::_notifyCounterBufferDestroyed ( HardwareCounterBuffer buf)
inherited

Notification that at hardware counter buffer has been destroyed.

void Ogre::HardwareBufferManager::_notifyIndexBufferDestroyed ( HardwareIndexBuffer buf)
inlineinherited

Notification that a hardware index buffer has been destroyed.

Definition at line 552 of file OgreHardwareBufferManager.h.

void Ogre::HardwareBufferManager::_notifyUniformBufferDestroyed ( HardwareUniformBuffer buf)
inlineinherited

Definition at line 557 of file OgreHardwareBufferManager.h.

void Ogre::HardwareBufferManager::_notifyVertexBufferDestroyed ( HardwareVertexBuffer buf)
inlineinherited

Notification that a hardware vertex buffer has been destroyed.

Definition at line 547 of file OgreHardwareBufferManager.h.

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

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

Parameters
forceFreeUnusedIf 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.

void* Ogre::GLHardwareBufferManager::allocateScratch ( uint32  size)
inline

Allocator method to allow us to use a pool of memory as a scratch area for hardware buffers.

This is because glMapBuffer is incredibly inefficient, seemingly no matter what options we give it. So for the period of lock/unlock, we will instead allocate a section of a local memory pool, and use glBufferSubDataARB / glGetBufferSubDataARB instead.

Definition at line 124 of file OgreGLHardwareBufferManager.h.

virtual HardwareVertexBufferSharedPtr Ogre::HardwareBufferManager::allocateVertexBufferCopy ( const HardwareVertexBufferSharedPtr sourceBuffer,
BufferLicenseType  licenseType,
HardwareBufferLicensee licensee,
bool  copyData = false 
)
inlinevirtualinherited

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
sourceBufferThe source buffer to use as a copy.
licenseTypeThe type of license required on this buffer - automatic release causes this class to release licenses every frame so that they can be reallocated anew.
licenseePointer back to the class requesting the copy, which must implement HardwareBufferLicense in order to be notified when the license expires.
copyDataIf 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.

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

Create counter buffer.

The update shall be triggered by GpuProgramParameters, if is dirty

Implements Ogre::HardwareBufferManagerBase.

Definition at line 469 of file OgreHardwareBufferManager.h.

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

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
itypeThe type in index, either 16- or 32-bit, depending on how many vertices you need to be able to address
numIndexesThe number of indexes in the buffer
usageOne or more members of the HardwareBuffer::Usage enumeration.
useShadowBufferIf 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.

RenderToVertexBufferSharedPtr Ogre::HardwareBufferManager::createRenderToVertexBuffer ( void  )
inlinevirtualinherited

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.

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

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.

Reimplemented in Ogre::GLES2DefaultHardwareBufferManager, and Ogre::GLESDefaultHardwareBufferManager.

Definition at line 462 of file OgreHardwareBufferManager.h.

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

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
vertexSizeThe 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.
numVertsThe number of vertices in this buffer.
usageOne 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.
useShadowBufferIf 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.

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

Creates a new VertexBufferBinding.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 486 of file OgreHardwareBufferManager.h.

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

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

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

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 475 of file OgreHardwareBufferManager.h.

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

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

Reimplemented in Ogre::GLES2HardwareBufferManagerBase, Ogre::D3D11HardwareBufferManagerBase, and Ogre::D3D9HardwareBufferManagerBase.

void Ogre::GLHardwareBufferManager::deallocateScratch ( void *  ptr)
inline
See also
allocateScratch

Definition at line 130 of file OgreGLHardwareBufferManager.h.

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

Internal method for destroys all vertex buffer bindings.

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

Internal method for destroys all vertex declarations.

virtual void Ogre::HardwareBufferManager::destroyVertexBufferBinding ( VertexBufferBinding binding)
inlinevirtualinherited

Destroys a VertexBufferBinding.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 491 of file OgreHardwareBufferManager.h.

virtual void Ogre::HardwareBufferManagerBase::destroyVertexBufferBindingImpl ( VertexBufferBinding binding)
protectedvirtualinherited

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

virtual void Ogre::HardwareBufferManager::destroyVertexDeclaration ( VertexDeclaration decl)
inlinevirtualinherited

Destroys a vertex declaration.

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 480 of file OgreHardwareBufferManager.h.

virtual void Ogre::HardwareBufferManagerBase::destroyVertexDeclarationImpl ( VertexDeclaration decl)
protectedvirtualinherited

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

Reimplemented in Ogre::GLES2HardwareBufferManagerBase, Ogre::D3D11HardwareBufferManagerBase, and Ogre::D3D9HardwareBufferManagerBase.

size_t Ogre::GLHardwareBufferManager::getGLMapBufferThreshold ( ) const
inline

Threshold after which glMapBuffer is used and not glBufferSubData.

Definition at line 137 of file OgreGLHardwareBufferManager.h.

static GLenum Ogre::GLHardwareBufferManager::getGLType ( unsigned int  type)
inlinestatic

Utility function to get the correct GL type based on VET's.

Definition at line 114 of file OgreGLHardwareBufferManager.h.

References Ogre::GLHardwareBufferManagerBase::getGLType().

static GLenum Ogre::GLHardwareBufferManager::getGLUsage ( unsigned int  usage)
inlinestatic

Utility function to get the correct GL usage based on HBU's.

Definition at line 110 of file OgreGLHardwareBufferManager.h.

References Ogre::GLHardwareBufferManagerBase::getGLUsage().

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

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.
static HardwareBufferManager* Ogre::HardwareBufferManager::getSingletonPtr ( void  )
staticinherited

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.
virtual HardwareVertexBufferSharedPtr Ogre::HardwareBufferManagerBase::makeBufferCopy ( const HardwareVertexBufferSharedPtr source,
HardwareBuffer::Usage  usage,
bool  useShadowBuffer 
)
protectedvirtualinherited

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

Ogre::HardwareBufferManagerBase::OGRE_MUTEX ( mVertexBuffersMutex  )
protectedinherited
Ogre::HardwareBufferManagerBase::OGRE_MUTEX ( mIndexBuffersMutex  )
protectedinherited
Ogre::HardwareBufferManagerBase::OGRE_MUTEX ( mUniformBuffersMutex  )
protectedinherited
Ogre::HardwareBufferManagerBase::OGRE_MUTEX ( mCounterBuffersMutex  )
protectedinherited
Ogre::HardwareBufferManagerBase::OGRE_MUTEX ( mVertexDeclarationsMutex  )
protectedinherited
Ogre::HardwareBufferManagerBase::OGRE_MUTEX ( mVertexBufferBindingsMutex  )
protectedinherited
Ogre::HardwareBufferManagerBase::OGRE_MUTEX ( mTempBuffersMutex  )
protectedinherited
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.

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

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.

virtual void Ogre::HardwareBufferManager::releaseVertexBufferCopy ( const HardwareVertexBufferSharedPtr bufferCopy)
inlinevirtualinherited

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

void Ogre::GLHardwareBufferManager::setGLMapBufferThreshold ( const size_t  value)
inline

Definition at line 141 of file OgreGLHardwareBufferManager.h.

virtual void Ogre::HardwareBufferManager::touchVertexBufferCopy ( const HardwareVertexBufferSharedPtr bufferCopy)
inlinevirtualinherited

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

Member Data Documentation

const size_t Ogre::HardwareBufferManagerBase::EXPIRED_DELAY_FRAME_THRESHOLD
staticprotectedinherited

Frame delay for BLT_AUTOMATIC_RELEASE temporary buffers.

Definition at line 209 of file OgreHardwareBufferManager.h.

CounterBufferList Ogre::HardwareBufferManagerBase::mCounterBuffers
protectedinherited

Definition at line 130 of file OgreHardwareBufferManager.h.

FreeTemporaryVertexBufferMap Ogre::HardwareBufferManagerBase::mFreeTempVertexBufferMap
protectedinherited

Map of current available temp buffers.

Definition at line 199 of file OgreHardwareBufferManager.h.

HardwareBufferManagerBase* Ogre::HardwareBufferManager::mImpl
protectedinherited
IndexBufferList Ogre::HardwareBufferManagerBase::mIndexBuffers
protectedinherited

Definition at line 128 of file OgreHardwareBufferManager.h.

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

Definition at line 75 of file OgreSingleton.h.

TemporaryVertexBufferLicenseMap Ogre::HardwareBufferManagerBase::mTempVertexBufferLicenses
protectedinherited

Map of currently licensed temporary buffers.

Definition at line 203 of file OgreHardwareBufferManager.h.

size_t Ogre::HardwareBufferManagerBase::mUnderUsedFrameCount
protectedinherited

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

Definition at line 205 of file OgreHardwareBufferManager.h.

UniformBufferList Ogre::HardwareBufferManagerBase::mUniformBuffers
protectedinherited

Definition at line 129 of file OgreHardwareBufferManager.h.

VertexBufferBindingList Ogre::HardwareBufferManagerBase::mVertexBufferBindings
protectedinherited

Definition at line 136 of file OgreHardwareBufferManager.h.

VertexBufferList Ogre::HardwareBufferManagerBase::mVertexBuffers
protectedinherited

Definition at line 127 of file OgreHardwareBufferManager.h.

VertexDeclarationList Ogre::HardwareBufferManagerBase::mVertexDeclarations
protectedinherited

Definition at line 135 of file OgreHardwareBufferManager.h.

const size_t Ogre::HardwareBufferManagerBase::UNDER_USED_FRAME_THRESHOLD
staticprotectedinherited

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: