Ogre::DefaultHardwareBufferManager Class Reference
[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 ()
HardwareVertexBufferSharedPtr	createVertexBuffer (size_t vertexSize, size_t numVerts, HardwareBuffer::Usage usage, bool useShadowBuffer=false)
HardwareIndexBufferSharedPtr	createIndexBuffer (HardwareIndexBuffer::IndexType itype, size_t numIndexes, HardwareBuffer::Usage usage, bool useShadowBuffer=false)
RenderToVertexBufferSharedPtr	createRenderToVertexBuffer ()
virtual VertexDeclaration *	createVertexDeclaration (void)
virtual void	destroyVertexDeclaration (VertexDeclaration *decl)
virtual VertexBufferBinding *	createVertexBufferBinding (void)
virtual void	destroyVertexBufferBinding (VertexBufferBinding *binding)
virtual void	registerVertexBufferSourceAndCopy (const HardwareVertexBufferSharedPtr &sourceBuffer, const HardwareVertexBufferSharedPtr &copy)
virtual HardwareVertexBufferSharedPtr	allocateVertexBufferCopy (const HardwareVertexBufferSharedPtr &sourceBuffer, BufferLicenseType licenseType, HardwareBufferLicensee *licensee, bool copyData=false)
virtual void	releaseVertexBufferCopy (const HardwareVertexBufferSharedPtr &bufferCopy)
virtual void	touchVertexBufferCopy (const HardwareVertexBufferSharedPtr &bufferCopy)
virtual void	_freeUnusedBufferCopies (void)
virtual void	_releaseBufferCopies (bool forceFreeUnused=false)
virtual void	_forceReleaseBufferCopies (const HardwareVertexBufferSharedPtr &sourceBuffer)
virtual void	_forceReleaseBufferCopies (HardwareVertexBuffer *sourceBuffer)
void	_notifyVertexBufferDestroyed (HardwareVertexBuffer *buf)
void	_notifyIndexBufferDestroyed (HardwareIndexBuffer *buf)
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
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 *)
Static Public Member Functions
static HardwareBufferManager &	getSingleton (void)
	Override standard Singleton retrieval.
static HardwareBufferManager *	getSingletonPtr (void)
	Override standard Singleton retrieval.
Protected Types
typedef set < HardwareVertexBuffer * > ::type	VertexBufferList
	WARNING: The following two members should place before all other members.
typedef set < HardwareIndexBuffer * > ::type	IndexBufferList
typedef set< VertexDeclaration * > ::type	VertexDeclarationList
typedef set < VertexBufferBinding * > ::type	VertexBufferBindingList
typedef multimap < HardwareVertexBuffer *, HardwareVertexBufferSharedPtr > ::type	FreeTemporaryVertexBufferMap
	Map from original buffer to temporary buffers.
typedef map < HardwareVertexBuffer *, VertexBufferLicense >::type	TemporaryVertexBufferLicenseMap
	Map from temporary buffer to details of a license.
Protected Member Functions
virtual void	destroyAllDeclarations (void)
	Internal method for destroys all vertex declarations.
virtual void	destroyAllBindings (void)
	Internal method for destroys all vertex buffer bindings.
virtual VertexDeclaration *	createVertexDeclarationImpl (void)
	Internal method for creates a new vertex declaration, may be overridden by certain rendering APIs.
virtual void	destroyVertexDeclarationImpl (VertexDeclaration *decl)
	Internal method for destroys a vertex declaration, may be overridden by certain rendering APIs.
virtual VertexBufferBinding *	createVertexBufferBindingImpl (void)
	Internal method for creates a new VertexBufferBinding, may be overridden by certain rendering APIs.
virtual void	destroyVertexBufferBindingImpl (VertexBufferBinding *binding)
	Internal method for destroys a VertexBufferBinding, may be overridden by certain rendering APIs.
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.
Protected Attributes
HardwareBufferManagerBase *	mImpl
VertexBufferList	mVertexBuffers
IndexBufferList	mIndexBuffers
VertexDeclarationList	mVertexDeclarations
VertexBufferBindingList	mVertexBufferBindings
FreeTemporaryVertexBufferMap	mFreeTempVertexBufferMap
	Map of current available temp buffers.
TemporaryVertexBufferLicenseMap	mTempVertexBufferLicenses
	Map of currently licensed temporary buffers.
size_t	mUnderUsedFrameCount
	Number of frames elapsed since temporary buffers utilization was above half the available.
Static Protected Attributes
static const size_t	UNDER_USED_FRAME_THRESHOLD
	Number of frames to wait before free unused temporary buffers.
static const size_t	EXPIRED_DELAY_FRAME_THRESHOLD
	Frame delay for BLT_AUTOMATIC_RELEASE temporary buffers.
static HardwareBufferManager *	msSingleton

Detailed Description

DefaultHardwareBufferManager as a Singleton.

Definition at line 121 of file OgreDefaultHardwareBufferManager.h.

Member Typedef Documentation

typedef multimap<HardwareVertexBuffer*, HardwareVertexBufferSharedPtr>::type Ogre::HardwareBufferManagerBase::FreeTemporaryVertexBufferMap [protected, inherited]

Map from original buffer to temporary buffers.

Definition at line 187 of file OgreHardwareBufferManager.h.

typedef set<HardwareIndexBuffer*>::type Ogre::HardwareBufferManagerBase::IndexBufferList [protected, inherited]

Definition at line 120 of file OgreHardwareBufferManager.h.

typedef map<HardwareVertexBuffer*, VertexBufferLicense>::type Ogre::HardwareBufferManagerBase::TemporaryVertexBufferLicenseMap [protected, inherited]

Map from temporary buffer to details of a license.

Definition at line 191 of file OgreHardwareBufferManager.h.

typedef set<VertexBufferBinding*>::type Ogre::HardwareBufferManagerBase::VertexBufferBindingList [protected, inherited]

Definition at line 126 of file OgreHardwareBufferManager.h.

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 119 of file OgreHardwareBufferManager.h.

typedef set<VertexDeclaration*>::type Ogre::HardwareBufferManagerBase::VertexDeclarationList [protected, inherited]

Definition at line 125 of file OgreHardwareBufferManager.h.

Member Enumeration Documentation

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 153 of file OgreHardwareBufferManager.h.

Constructor & Destructor Documentation

Ogre::DefaultHardwareBufferManager::DefaultHardwareBufferManager ( )

Definition at line 124 of file OgreDefaultHardwareBufferManager.h.

Ogre::DefaultHardwareBufferManager::~DefaultHardwareBufferManager ( )

Definition at line 129 of file OgreDefaultHardwareBufferManager.h.

References OGRE_DELETE.

Member Function Documentation

virtual void Ogre::HardwareBufferManager::_forceReleaseBufferCopies ( HardwareVertexBuffer * sourceBuffer ) [virtual, inherited]

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 483 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_forceReleaseBufferCopies().

virtual void Ogre::HardwareBufferManager::_forceReleaseBufferCopies ( const HardwareVertexBufferSharedPtr & sourceBuffer ) [virtual, inherited]

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 477 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_forceReleaseBufferCopies().

virtual void Ogre::HardwareBufferManager::_freeUnusedBufferCopies ( void ) [virtual, inherited]

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 467 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_freeUnusedBufferCopies().

void Ogre::HardwareBufferManager::_notifyIndexBufferDestroyed ( HardwareIndexBuffer * buf ) [inherited]

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 493 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_notifyIndexBufferDestroyed().

void Ogre::HardwareBufferManager::_notifyVertexBufferDestroyed ( HardwareVertexBuffer * buf ) [inherited]

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 488 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_notifyVertexBufferDestroyed().

virtual void Ogre::HardwareBufferManager::_releaseBufferCopies ( bool forceFreeUnused = false ) [virtual, inherited]

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 472 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::_releaseBufferCopies().

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

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 444 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::allocateVertexBufferCopy().

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

Implements Ogre::HardwareBufferManagerBase.

Definition at line 403 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createIndexBuffer().

RenderToVertexBufferSharedPtr Ogre::HardwareBufferManager::createRenderToVertexBuffer ( ) [virtual, inherited]

Implements Ogre::HardwareBufferManagerBase.

Definition at line 410 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createRenderToVertexBuffer().

HardwareVertexBufferSharedPtr Ogre::HardwareBufferManager::createVertexBuffer	(	size_t	vertexSize,
		size_t	numVerts,
		HardwareBuffer::Usage	usage,
		bool	useShadowBuffer = `false`
	)			`[virtual, inherited]`

Implements Ogre::HardwareBufferManagerBase.

Definition at line 396 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createVertexBuffer().

virtual VertexBufferBinding* Ogre::HardwareBufferManager::createVertexBufferBinding ( void ) [virtual, inherited]

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 427 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createVertexBufferBinding().

virtual VertexBufferBinding* Ogre::HardwareBufferManagerBase::createVertexBufferBindingImpl ( void ) [protected, virtual, inherited]

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

virtual VertexDeclaration* Ogre::HardwareBufferManager::createVertexDeclaration ( void ) [virtual, inherited]

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 416 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::createVertexDeclaration().

virtual VertexDeclaration* Ogre::HardwareBufferManagerBase::createVertexDeclarationImpl ( void ) [protected, virtual, inherited]

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

virtual void Ogre::HardwareBufferManagerBase::destroyAllBindings ( void ) [protected, virtual, inherited]

Internal method for destroys all vertex buffer bindings.

virtual void Ogre::HardwareBufferManagerBase::destroyAllDeclarations ( void ) [protected, virtual, inherited]

Internal method for destroys all vertex declarations.

virtual void Ogre::HardwareBufferManager::destroyVertexBufferBinding ( VertexBufferBinding * binding ) [virtual, inherited]

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 432 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::destroyVertexBufferBinding().

virtual void Ogre::HardwareBufferManagerBase::destroyVertexBufferBindingImpl ( VertexBufferBinding * binding ) [protected, virtual, inherited]

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

virtual void Ogre::HardwareBufferManager::destroyVertexDeclaration ( VertexDeclaration * decl ) [virtual, inherited]

Reimplemented from Ogre::HardwareBufferManagerBase.

Definition at line 421 of file OgreHardwareBufferManager.h.

References Ogre::HardwareBufferManagerBase::destroyVertexDeclaration().

virtual void Ogre::HardwareBufferManagerBase::destroyVertexDeclarationImpl ( VertexDeclaration * decl ) [protected, virtual, inherited]

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

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.

Reimplemented from Ogre::Singleton< HardwareBufferManager >.

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.

Reimplemented from Ogre::Singleton< HardwareBufferManager >.

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.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			`[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)			`[inherited]`

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 72 of file OgreMemoryAllocatedObject.h.

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 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 90 of file OgreMemoryAllocatedObject.h.

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 85 of file OgreMemoryAllocatedObject.h.

virtual void Ogre::HardwareBufferManager::registerVertexBufferSourceAndCopy	(	const HardwareVertexBufferSharedPtr &	sourceBuffer,
		const HardwareVertexBufferSharedPtr &	copy
	)			`[virtual, inherited]`