Ogre::HardwareBufferManager Class Reference

Abstract singleton class for managing hardware buffers, a concrete instance of this will be created by the RenderSystem. More...

#include <OgreHardwareBufferManager.h>

Inheritance diagram for Ogre::HardwareBufferManager:

List of all members.


Public Types
enum	BufferLicenseType { BLT_MANUAL_RELEASE, BLT_AUTOMATIC_RELEASE }
Public Member Functions
	HardwareBufferManager ()
virtual	~HardwareBufferManager ()
virtual HardwareVertexBufferSharedPtr	createVertexBuffer (size_t vertexSize, size_t numVerts, HardwareBuffer::Usage usage, bool useShadowBuffer=false)=0
	Create a hardware vertex buffer.
virtual HardwareIndexBufferSharedPtr	createIndexBuffer (HardwareIndexBuffer::IndexType itype, size_t numIndexes, HardwareBuffer::Usage usage, bool useShadowBuffer=false)=0
	Create a hardware index buffer.
virtual VertexDeclaration *	createVertexDeclaration (void)
	Creates a vertex declaration, may be overridden by certain rendering APIs.
virtual void	destroyVertexDeclaration (VertexDeclaration *decl)
	Destroys a vertex declaration, may be overridden by certain rendering APIs.
virtual VertexBufferBinding *	createVertexBufferBinding (void)
	Creates a new VertexBufferBinding.
virtual void	destroyVertexBufferBinding (VertexBufferBinding *binding)
	Destroys a VertexBufferBinding.
virtual void	registerVertexBufferSourceAndCopy (const HardwareVertexBufferSharedPtr &sourceBuffer, const HardwareVertexBufferSharedPtr &copy)
	Registers a vertex buffer as a copy of another.
virtual HardwareVertexBufferSharedPtr	allocateVertexBufferCopy (const HardwareVertexBufferSharedPtr &sourceBuffer, BufferLicenseType licenseType, HardwareBufferLicensee *licensee, bool copyData=false)
	Allocates a copy of a given vertex buffer.
virtual void	releaseVertexBufferCopy (const HardwareVertexBufferSharedPtr &bufferCopy)
	Manually release a vertex buffer copy for others to subsequently use.
virtual void	_releaseBufferCopies (void)
	Internal method for releasing all temporary buffers which have been allocated using BLT_AUTOMATIC_RELEASE; is called by OGRE.
virtual void	_forceReleaseBufferCopies (const HardwareVertexBufferSharedPtr &sourceBuffer)
	Internal method that forces the release of copies of a given buffer.
void	_forceReleaseBufferCopies (HardwareVertexBuffer *sourceBuffer)
	Internal method that forces the release of copies of a given buffer.
void	_notifyVertexBufferDestroyed (HardwareVertexBuffer *buf)
	Notification that a hardware vertex buffer has been destroyed.
void	_notifyIndexBufferDestroyed (HardwareIndexBuffer *buf)
	Notification that a hardware index buffer has been destroyed.
Static Public Member Functions
HardwareBufferManager &	getSingleton (void)
	Override standard Singleton retrieval.
HardwareBufferManager *	getSingletonPtr (void)
	Override standard Singleton retrieval.
Protected Types
typedef std::list< VertexDeclaration * >	VertexDeclarationList
typedef std::list< VertexBufferBinding * >	VertexBufferBindingList
typedef std::vector< HardwareVertexBufferSharedPtr >	FreeTemporaryVertexBufferList
	List of free temporary vertex buffers.
typedef std::map< HardwareVertexBuffer , FreeTemporaryVertexBufferList >	FreeTemporaryVertexBufferMap
	Map from original buffer to list of temporary buffers.
typedef std::vector< VertexBufferLicense >	TemporaryVertexBufferLicenseList
	List of currently licensed temp buffers.
typedef std::set< HardwareVertexBuffer * >	VertexBufferList
typedef std::set< HardwareIndexBuffer * >	IndexBufferList
Protected Member Functions
virtual void	destroyAllDeclarations (void)
virtual void	destroyAllBindings (void)
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
VertexDeclarationList	mVertexDeclarations
VertexBufferBindingList	mVertexBufferBindings
FreeTemporaryVertexBufferMap	mFreeTempVertexBufferMap
	Map of current available temp buffers.
TemporaryVertexBufferLicenseList	mTempVertexBufferLicenses
	List of currently licensed temp buffers.
VertexBufferList	mVertexBuffers
IndexBufferList	mIndexBuffers
Static Protected Attributes
HardwareBufferManager *	ms_Singleton
Friends
class	HardwareVertexBufferSharedPtr
class	HardwareIndexBufferSharedPtr

Detailed Description

Abstract singleton class for managing hardware buffers, a concrete instance of this will be created by the RenderSystem.

Definition at line 86 of file OgreHardwareBufferManager.h.

Member Typedef Documentation

typedef std::vector<HardwareVertexBufferSharedPtr> Ogre::HardwareBufferManager::FreeTemporaryVertexBufferList [protected]

List of free temporary vertex buffers.

Definition at line 130 of file OgreHardwareBufferManager.h.

typedef std::map<HardwareVertexBuffer*, FreeTemporaryVertexBufferList*> Ogre::HardwareBufferManager::FreeTemporaryVertexBufferMap [protected]

Map from original buffer to list of temporary buffers.

Definition at line 132 of file OgreHardwareBufferManager.h.

typedef std::set<HardwareIndexBuffer*> Ogre::HardwareBufferManager::IndexBufferList [protected]

Definition at line 141 of file OgreHardwareBufferManager.h.

typedef std::vector<VertexBufferLicense> Ogre::HardwareBufferManager::TemporaryVertexBufferLicenseList [protected]

List of currently licensed temp buffers.

Definition at line 136 of file OgreHardwareBufferManager.h.

typedef std::list<VertexBufferBinding*> Ogre::HardwareBufferManager::VertexBufferBindingList [protected]

Definition at line 92 of file OgreHardwareBufferManager.h.

typedef std::set<HardwareVertexBuffer*> Ogre::HardwareBufferManager::VertexBufferList [protected]

Definition at line 140 of file OgreHardwareBufferManager.h.

typedef std::list<VertexDeclaration*> Ogre::HardwareBufferManager::VertexDeclarationList [protected]

Definition at line 91 of file OgreHardwareBufferManager.h.

Member Enumeration Documentation

enum Ogre::HardwareBufferManager::BufferLicenseType

Enumeration values:

BLT_MANUAL_RELEASE Licensee will only release buffer when it says so.

BLT_AUTOMATIC_RELEASE Licensee can have license revoked.

Definition at line 103 of file OgreHardwareBufferManager.h.

Constructor & Destructor Documentation

Ogre::HardwareBufferManager::HardwareBufferManager ( )

virtual Ogre::HardwareBufferManager::~HardwareBufferManager ( ) [virtual]

Member Function Documentation

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

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 pointer. Any buffer copies created from the source buffer are deleted.

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

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.

Definition at line 268 of file OgreHardwareBufferManager.h.
References Ogre::SharedPtr< HardwareVertexBuffer >::get().

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

Notification that a hardware index buffer has been destroyed.

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

Notification that a hardware vertex buffer has been destroyed.

virtual void Ogre::HardwareBufferManager::_releaseBufferCopies ( void ) [virtual]

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

virtual HardwareVertexBufferSharedPtr Ogre::HardwareBufferManager::allocateVertexBufferCopy ( const HardwareVertexBufferSharedPtr & sourceBuffer,

BufferLicenseType licenseType,

HardwareBufferLicensee * licensee,

bool copyData = false

) [virtual]

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

virtual HardwareIndexBufferSharedPtr Ogre::HardwareBufferManager::createIndexBuffer ( HardwareIndexBuffer::IndexType itype,

size_t numIndexes,

HardwareBuffer::Usage usage,

bool useShadowBuffer = false

) [pure virtual]

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

Implemented in Ogre::DefaultHardwareBufferManager, Ogre::D3D7HardwareBufferManager, Ogre::D3D9HardwareBufferManager, Ogre::GLDefaultHardwareBufferManager, and Ogre::GLHardwareBufferManager.

virtual HardwareVertexBufferSharedPtr Ogre::HardwareBufferManager::createVertexBuffer ( size_t vertexSize,

size_t numVerts,

HardwareBuffer::Usage usage,

bool useShadowBuffer = false

) [pure virtual]

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.

Implemented in Ogre::DefaultHardwareBufferManager, Ogre::D3D9HardwareBufferManager, Ogre::GLDefaultHardwareBufferManager, and Ogre::GLHardwareBufferManager.

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

Creates a new VertexBufferBinding.

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

Creates a vertex declaration, may be overridden by certain rendering APIs.

Reimplemented in Ogre::D3D9HardwareBufferManager, and Ogre::GLHardwareBufferManager.

virtual void Ogre::HardwareBufferManager::destroyAllBindings ( void ) [protected, virtual]

virtual void Ogre::HardwareBufferManager::destroyAllDeclarations ( void ) [protected, virtual]

Reimplemented in Ogre::D3D9HardwareBufferManager.

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

Destroys a VertexBufferBinding.

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

Destroys a vertex declaration, may be overridden by certain rendering APIs.

Reimplemented in Ogre::D3D9HardwareBufferManager, and Ogre::GLHardwareBufferManager.

HardwareBufferManager& Ogre::HardwareBufferManager::getSingleton ( void ) [static]

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

HardwareBufferManager* Ogre::HardwareBufferManager::getSingletonPtr ( void ) [static]

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

HardwareVertexBufferSharedPtr Ogre::HardwareBufferManager::makeBufferCopy ( const HardwareVertexBufferSharedPtr & source,

HardwareBuffer::Usage usage,

bool useShadowBuffer

) [protected]

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

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

const HardwareVertexBufferSharedPtr & copy

) [virtual]

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.

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

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.