Singleton wrapper for hardware buffer manager. More...
#include <OgreHardwareBufferManager.h>
Public Types | |
enum | BufferLicenseType { BLT_MANUAL_RELEASE, BLT_AUTOMATIC_RELEASE } |
Public Member Functions | |
HardwareBufferManager (HardwareBufferManagerBase *imp) | |
~HardwareBufferManager () | |
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 ©) |
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... | |
Friends | |
class | HardwareIndexBufferSharedPtr |
class | HardwareVertexBufferSharedPtr |
Singleton wrapper for hardware buffer manager.
Definition at line 429 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Definition at line 126 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Map from original buffer to temporary buffers.
Definition at line 197 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Definition at line 124 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Map from temporary buffer to details of a license.
Definition at line 201 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Definition at line 125 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Definition at line 134 of file OgreHardwareBufferManager.h.
|
protectedinherited |
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.
|
protectedinherited |
Definition at line 133 of file OgreHardwareBufferManager.h.
|
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.
Ogre::HardwareBufferManager::HardwareBufferManager | ( | HardwareBufferManagerBase * | imp | ) |
Ogre::HardwareBufferManager::~HardwareBufferManager | ( | ) |
|
inlinevirtual |
Internal method that forces the release of copies of a given buffer.
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.
|
inlinevirtual |
Internal method that forces the release of copies of a given buffer.
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.
|
inlinevirtual |
Free all unused vertex buffer copies.
Reimplemented from Ogre::HardwareBufferManagerBase.
Definition at line 526 of file OgreHardwareBufferManager.h.
|
inline |
Definition at line 562 of file OgreHardwareBufferManager.h.
|
inherited |
Notification that at hardware counter buffer has been destroyed.
|
inline |
Notification that a hardware index buffer has been destroyed.
Definition at line 552 of file OgreHardwareBufferManager.h.
|
inline |
Definition at line 557 of file OgreHardwareBufferManager.h.
|
inline |
Notification that a hardware vertex buffer has been destroyed.
Definition at line 547 of file OgreHardwareBufferManager.h.
|
inlinevirtual |
Internal method for releasing all temporary buffers which have been allocated using BLT_AUTOMATIC_RELEASE; is called by OGRE.
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.
|
inlinevirtual |
Allocates a copy of a given vertex buffer.
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.
|
inlinevirtual |
Create counter buffer.
The update shall be triggered by GpuProgramParameters, if is dirty
Implements Ogre::HardwareBufferManagerBase.
Definition at line 469 of file OgreHardwareBufferManager.h.
|
inlinevirtual |
Create a hardware index buffer.
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.
|
inlinevirtual |
Create a render to vertex buffer.
Implements Ogre::HardwareBufferManagerBase.
Definition at line 455 of file OgreHardwareBufferManager.h.
|
inlinevirtual |
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::GLESDefaultHardwareBufferManager.
Definition at line 462 of file OgreHardwareBufferManager.h.
|
inlinevirtual |
Create a hardware vertex buffer.
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.
|
inlinevirtual |
Creates a new VertexBufferBinding.
Reimplemented from Ogre::HardwareBufferManagerBase.
Definition at line 486 of file OgreHardwareBufferManager.h.
|
protectedvirtualinherited |
Internal method for creates a new VertexBufferBinding, may be overridden by certain rendering APIs.
|
inlinevirtual |
Reimplemented from Ogre::HardwareBufferManagerBase.
Definition at line 475 of file OgreHardwareBufferManager.h.
|
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.
|
protectedvirtualinherited |
Internal method for destroys all vertex buffer bindings.
|
protectedvirtualinherited |
Internal method for destroys all vertex declarations.
|
inlinevirtual |
Destroys a VertexBufferBinding.
Reimplemented from Ogre::HardwareBufferManagerBase.
Definition at line 491 of file OgreHardwareBufferManager.h.
|
protectedvirtualinherited |
Internal method for destroys a VertexBufferBinding, may be overridden by certain rendering APIs.
|
inlinevirtual |
Destroys a vertex declaration.
Reimplemented from Ogre::HardwareBufferManagerBase.
Definition at line 480 of file OgreHardwareBufferManager.h.
|
protectedvirtualinherited |
Internal method for destroys a vertex declaration, may be overridden by certain rendering APIs.
Reimplemented in Ogre::GLES2HardwareBufferManagerBase, Ogre::D3D11HardwareBufferManagerBase, and Ogre::D3D9HardwareBufferManagerBase.
|
static |
Override standard Singleton retrieval.
|
static |
Override standard Singleton retrieval.
|
protectedvirtualinherited |
Creates a new buffer as a copy of the source, does not copy data.
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inlinevirtual |
Registers a vertex buffer as a copy of another.
Reimplemented from Ogre::HardwareBufferManagerBase.
Definition at line 496 of file OgreHardwareBufferManager.h.
|
inlinevirtual |
Manually release a vertex buffer copy for others to subsequently use.
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.
|
inlinevirtual |
Tell engine that the vertex buffer copy intent to reuse.
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.
|
friend |
Definition at line 432 of file OgreHardwareBufferManager.h.
|
friend |
Definition at line 431 of file OgreHardwareBufferManager.h.
|
staticprotectedinherited |
Frame delay for BLT_AUTOMATIC_RELEASE temporary buffers.
Definition at line 209 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Definition at line 130 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Map of current available temp buffers.
Definition at line 199 of file OgreHardwareBufferManager.h.
|
protected |
Definition at line 434 of file OgreHardwareBufferManager.h.
Referenced by Ogre::D3D11HardwareBufferManager::~D3D11HardwareBufferManager().
|
protectedinherited |
Definition at line 128 of file OgreHardwareBufferManager.h.
|
staticprotectedinherited |
Definition at line 75 of file OgreSingleton.h.
|
protectedinherited |
Map of currently licensed temporary buffers.
Definition at line 203 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Number of frames elapsed since temporary buffers utilization was above half the available.
Definition at line 205 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Definition at line 129 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Definition at line 136 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Definition at line 127 of file OgreHardwareBufferManager.h.
|
protectedinherited |
Definition at line 135 of file OgreHardwareBufferManager.h.
|
staticprotectedinherited |
Number of frames to wait before free unused temporary buffers.
Definition at line 207 of file OgreHardwareBufferManager.h.