Base definition of a hardware buffer manager. More...

#include <OgreHardwareBufferManager.h>

Inheritance diagram for Ogre::HardwareBufferManagerBase:

Public Types
enum	BufferLicenseType { BLT_MANUAL_RELEASE, BLT_AUTOMATIC_RELEASE }

Public Member Functions
	HardwareBufferManagerBase ()

virtual	~HardwareBufferManagerBase ()

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	_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)
	Notification that at hardware uniform buffer has been destroyed. More...

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

virtual HardwareCounterBufferSharedPtr	createCounterBuffer (size_t sizeBytes, HardwareBuffer::Usage usage=HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE, bool useShadowBuffer=false, const String &name="")=0
	Create counter buffer. More...

virtual HardwareIndexBufferSharedPtr	createIndexBuffer (HardwareIndexBuffer::IndexType itype, size_t numIndexes, HardwareBuffer::Usage usage, bool useShadowBuffer=false)=0
	Create a hardware index buffer. More...

virtual RenderToVertexBufferSharedPtr	createRenderToVertexBuffer ()=0
	Create a render to vertex buffer. More...

virtual HardwareUniformBufferSharedPtr	createUniformBuffer (size_t sizeBytes, HardwareBuffer::Usage usage=HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE, bool useShadowBuffer=false, const String &name="")=0
	Create uniform buffer. More...

virtual HardwareVertexBufferSharedPtr	createVertexBuffer (size_t vertexSize, size_t numVerts, HardwareBuffer::Usage usage, bool useShadowBuffer=false)=0
	Create a hardware vertex buffer. More...

virtual VertexBufferBinding *	createVertexBufferBinding (void)
	Creates a new VertexBufferBinding. More...

virtual VertexDeclaration *	createVertexDeclaration (void)
	Creates a new vertex declaration. More...

virtual void	destroyVertexBufferBinding (VertexBufferBinding *binding)
	Destroys a VertexBufferBinding. More...

virtual void	destroyVertexDeclaration (VertexDeclaration *decl)
	Destroys a vertex declaration. More...

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

Detailed Description

Base definition of a hardware buffer manager.

Remarks: This class is deliberately not a Singleton, so that multiple types can exist at once. The Singleton is wrapped via the Decorator pattern in HardwareBufferManager, below. Each concrete implementation should provide a subclass of HardwareBufferManagerBase, which does the actual work, and also a very simple subclass of HardwareBufferManager which simply constructs the instance of the HardwareBufferManagerBase subclass and passes it to the HardwareBufferManager superclass as a delegate. This subclass must also delete the implementation instance it creates.

Member Enumeration Documentation

◆ BufferLicenseType

enum Ogre::HardwareBufferManagerBase::BufferLicenseType

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

Constructor & Destructor Documentation

◆ HardwareBufferManagerBase()

Ogre::HardwareBufferManagerBase::HardwareBufferManagerBase ( )

◆ ~HardwareBufferManagerBase()

virtual Ogre::HardwareBufferManagerBase::~HardwareBufferManagerBase ( )

virtual

Member Function Documentation

◆ createVertexBuffer()

virtual HardwareVertexBufferSharedPtr Ogre::HardwareBufferManagerBase::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::HardwareBufferManager, Ogre::DefaultHardwareBufferManagerBase, Ogre::GL3PlusHardwareBufferManagerBase, Ogre::GLHardwareBufferManagerBase, Ogre::GLES2HardwareBufferManagerBase, Ogre::D3D11HardwareBufferManagerBase, and Ogre::D3D9HardwareBufferManagerBase.

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

◆ createIndexBuffer()

virtual HardwareIndexBufferSharedPtr Ogre::HardwareBufferManagerBase::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 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.

Implemented in Ogre::HardwareBufferManager, Ogre::DefaultHardwareBufferManagerBase, Ogre::GL3PlusHardwareBufferManagerBase, Ogre::D3D11HardwareBufferManagerBase, Ogre::GLHardwareBufferManagerBase, Ogre::GLES2HardwareBufferManagerBase, and Ogre::D3D9HardwareBufferManagerBase.

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

◆ createRenderToVertexBuffer()

virtual RenderToVertexBufferSharedPtr Ogre::HardwareBufferManagerBase::createRenderToVertexBuffer ( )

pure virtual

Create a render to vertex buffer.

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

Implemented in Ogre::HardwareBufferManager, Ogre::DefaultHardwareBufferManagerBase, Ogre::GL3PlusHardwareBufferManagerBase, Ogre::GLHardwareBufferManagerBase, Ogre::D3D11HardwareBufferManagerBase, Ogre::GLES2HardwareBufferManagerBase, and Ogre::D3D9HardwareBufferManagerBase.

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

◆ createUniformBuffer()

virtual HardwareUniformBufferSharedPtr Ogre::HardwareBufferManagerBase::createUniformBuffer	(	size_t	sizeBytes,
		HardwareBuffer::Usage	usage = `HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE`,
		bool	useShadowBuffer = `false`,
		const String &	name = `""`
	)

pure virtual

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

Implemented in Ogre::HardwareBufferManager, Ogre::DefaultHardwareBufferManagerBase, Ogre::GL3PlusHardwareBufferManagerBase, Ogre::GLHardwareBufferManagerBase, Ogre::D3D11HardwareBufferManagerBase, Ogre::GLES2HardwareBufferManagerBase, and Ogre::D3D9HardwareBufferManagerBase.

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

◆ createCounterBuffer()

virtual HardwareCounterBufferSharedPtr Ogre::HardwareBufferManagerBase::createCounterBuffer	(	size_t	sizeBytes,
		HardwareBuffer::Usage	usage = `HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE`,
		bool	useShadowBuffer = `false`,
		const String &	name = `""`
	)

pure virtual

Create counter buffer.

The update shall be triggered by GpuProgramParameters, if is dirty

Implemented in Ogre::HardwareBufferManager, Ogre::DefaultHardwareBufferManagerBase, Ogre::GL3PlusHardwareBufferManagerBase, Ogre::D3D11HardwareBufferManagerBase, Ogre::GLES2HardwareBufferManagerBase, Ogre::GLHardwareBufferManagerBase, and Ogre::D3D9HardwareBufferManagerBase.

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

◆ createVertexDeclaration()

virtual VertexDeclaration* Ogre::HardwareBufferManagerBase::createVertexDeclaration ( void )

virtual

Creates a new vertex declaration.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ destroyVertexDeclaration()

virtual void Ogre::HardwareBufferManagerBase::destroyVertexDeclaration ( VertexDeclaration * decl )

virtual

Destroys a vertex declaration.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ createVertexBufferBinding()

virtual VertexBufferBinding* Ogre::HardwareBufferManagerBase::createVertexBufferBinding ( void )

virtual

Creates a new VertexBufferBinding.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ destroyVertexBufferBinding()

virtual void Ogre::HardwareBufferManagerBase::destroyVertexBufferBinding ( VertexBufferBinding * binding )

virtual

Destroys a VertexBufferBinding.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ registerVertexBufferSourceAndCopy()

virtual void Ogre::HardwareBufferManagerBase::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.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ allocateVertexBufferCopy()

virtual HardwareVertexBufferSharedPtr Ogre::HardwareBufferManagerBase::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/

Reimplemented in Ogre::HardwareBufferManager.

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

◆ releaseVertexBufferCopy()

virtual void Ogre::HardwareBufferManagerBase::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.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ touchVertexBufferCopy()

virtual void Ogre::HardwareBufferManagerBase::touchVertexBufferCopy ( const HardwareVertexBufferSharedPtr & bufferCopy )

virtual

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 in Ogre::HardwareBufferManager.

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

◆ _freeUnusedBufferCopies()

virtual void Ogre::HardwareBufferManagerBase::_freeUnusedBufferCopies ( void )

virtual

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 in Ogre::HardwareBufferManager.

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

◆ _releaseBufferCopies()

virtual void Ogre::HardwareBufferManagerBase::_releaseBufferCopies ( bool forceFreeUnused = false )

virtual

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 in Ogre::HardwareBufferManager.

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

◆ _forceReleaseBufferCopies() [1/2]

virtual void Ogre::HardwareBufferManagerBase::_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.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ _forceReleaseBufferCopies() [2/2]

virtual void Ogre::HardwareBufferManagerBase::_forceReleaseBufferCopies ( HardwareVertexBuffer * 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 pointer. Any buffer copies created from the source buffer are deleted.

Reimplemented in Ogre::HardwareBufferManager.

◆ _notifyVertexBufferDestroyed()

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

Notification that a hardware vertex buffer has been destroyed.

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

◆ _notifyIndexBufferDestroyed()

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

Notification that a hardware index buffer has been destroyed.

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

◆ _notifyUniformBufferDestroyed()

void Ogre::HardwareBufferManagerBase::_notifyUniformBufferDestroyed ( HardwareUniformBuffer * buf )

Notification that at hardware uniform buffer has been destroyed.

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

◆ _notifyCounterBufferDestroyed()

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

Notification that at hardware counter buffer has been destroyed.

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

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

OgreHardwareBufferManager.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ BufferLicenseType

Constructor & Destructor Documentation

◆ HardwareBufferManagerBase()

◆ ~HardwareBufferManagerBase()

Member Function Documentation

◆ createVertexBuffer()

◆ createIndexBuffer()

◆ createRenderToVertexBuffer()

◆ createUniformBuffer()

◆ createCounterBuffer()

◆ createVertexDeclaration()

◆ destroyVertexDeclaration()

◆ createVertexBufferBinding()

◆ destroyVertexBufferBinding()

◆ registerVertexBufferSourceAndCopy()

◆ allocateVertexBufferCopy()

◆ releaseVertexBufferCopy()

◆ touchVertexBufferCopy()

◆ _freeUnusedBufferCopies()

◆ _releaseBufferCopies()

◆ _forceReleaseBufferCopies() [1/2]

◆ _forceReleaseBufferCopies() [2/2]

◆ _notifyVertexBufferDestroyed()

◆ _notifyIndexBufferDestroyed()

◆ _notifyUniformBufferDestroyed()

◆ _notifyCounterBufferDestroyed()