Implementation of HardwareBufferManager for OpenGL. More...

#include <OgreGLHardwareBufferManager.h>

Inheritance diagram for Ogre::GLHardwareBufferManagerBase:

Public Types
enum	BufferLicenseType { BLT_MANUAL_RELEASE, BLT_AUTOMATIC_RELEASE }

Public Member Functions
	GLHardwareBufferManagerBase ()

	~GLHardwareBufferManagerBase ()

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

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=HardwareBuffer::HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE, bool useShadowBuffer=false, const String &name="")
	Create counter buffer. More...

HardwareIndexBufferSharedPtr	createIndexBuffer (HardwareIndexBuffer::IndexType itype, size_t numIndexes, HardwareBuffer::Usage usage, bool useShadowBuffer=false)
	Create a hardware vertex 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 a uniform buffer. More...

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

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

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

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

GLStateCacheManager *	getStateCacheManager ()

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

Detailed Description

Implementation of HardwareBufferManager for OpenGL.

Member Enumeration Documentation

◆ BufferLicenseType

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.

Constructor & Destructor Documentation

◆ GLHardwareBufferManagerBase()

Ogre::GLHardwareBufferManagerBase::GLHardwareBufferManagerBase ( )

◆ ~GLHardwareBufferManagerBase()

Ogre::GLHardwareBufferManagerBase::~GLHardwareBufferManagerBase ( )

Member Function Documentation

◆ createVertexBuffer()

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

virtual

Creates a vertex buffer.

Implements Ogre::HardwareBufferManagerBase.

◆ createIndexBuffer()

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

virtual

Create a hardware vertex buffer.

Implements Ogre::HardwareBufferManagerBase.

◆ createRenderToVertexBuffer()

RenderToVertexBufferSharedPtr Ogre::GLHardwareBufferManagerBase::createRenderToVertexBuffer ( )

virtual

Create a render to vertex buffer.

Implements Ogre::HardwareBufferManagerBase.

◆ createUniformBuffer()

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

virtual

Create a uniform buffer.

Implements Ogre::HardwareBufferManagerBase.

◆ createCounterBuffer()

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

virtual

Create counter buffer.

The update shall be triggered by GpuProgramParameters, if is dirty

Implements Ogre::HardwareBufferManagerBase.

◆ getGLUsage()

static GLenum Ogre::GLHardwareBufferManagerBase::getGLUsage ( unsigned int usage )

static

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

Referenced by Ogre::GLHardwareBufferManager::getGLUsage().

◆ getGLType()

static GLenum Ogre::GLHardwareBufferManagerBase::getGLType ( unsigned int type )

static

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

Referenced by Ogre::GLHardwareBufferManager::getGLType().

◆ getStateCacheManager()

GLStateCacheManager* Ogre::GLHardwareBufferManagerBase::getStateCacheManager ( )

◆ allocateScratch()

void* Ogre::GLHardwareBufferManagerBase::allocateScratch ( uint32 size )

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.

◆ deallocateScratch()

void Ogre::GLHardwareBufferManagerBase::deallocateScratch ( void * ptr )

See also: allocateScratch

◆ getGLMapBufferThreshold()

size_t Ogre::GLHardwareBufferManagerBase::getGLMapBufferThreshold ( ) const

Threshold after which glMapBuffer is used and not glBufferSubData.

◆ setGLMapBufferThreshold()

void Ogre::GLHardwareBufferManagerBase::setGLMapBufferThreshold ( const size_t value )

◆ createVertexDeclaration()

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

virtualinherited

Creates a new vertex declaration.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ destroyVertexDeclaration()

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

virtualinherited

Destroys a vertex declaration.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ createVertexBufferBinding()

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

virtualinherited

Creates a new VertexBufferBinding.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ destroyVertexBufferBinding()

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

virtualinherited

Destroys a VertexBufferBinding.

Reimplemented in Ogre::HardwareBufferManager.

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

◆ registerVertexBufferSourceAndCopy()

virtual void Ogre::HardwareBufferManagerBase::registerVertexBufferSourceAndCopy	(	const HardwareVertexBufferSharedPtr &	sourceBuffer,
		const HardwareVertexBufferSharedPtr &	copy
	)

virtualinherited

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`
	)

virtualinherited

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 )

virtualinherited

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 )

virtualinherited

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 )

virtualinherited

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 )

virtualinherited

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 )

virtualinherited

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 )

virtualinherited

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 )

inherited

Notification that a hardware vertex buffer has been destroyed.

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

◆ _notifyIndexBufferDestroyed()

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

inherited

Notification that a hardware index buffer has been destroyed.

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

◆ _notifyUniformBufferDestroyed()

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

inherited

Notification that at hardware uniform buffer has been destroyed.

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

◆ _notifyCounterBufferDestroyed()

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

inherited

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:

OgreGLHardwareBufferManager.h

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ BufferLicenseType

Constructor & Destructor Documentation

◆ GLHardwareBufferManagerBase()

◆ ~GLHardwareBufferManagerBase()

Member Function Documentation

◆ createVertexBuffer()

◆ createIndexBuffer()

◆ createRenderToVertexBuffer()

◆ createUniformBuffer()

◆ createCounterBuffer()

◆ getGLUsage()

◆ getGLType()

◆ getStateCacheManager()

◆ allocateScratch()

◆ deallocateScratch()

◆ getGLMapBufferThreshold()

◆ setGLMapBufferThreshold()

◆ createVertexDeclaration()

◆ destroyVertexDeclaration()

◆ createVertexBufferBinding()

◆ destroyVertexBufferBinding()

◆ registerVertexBufferSourceAndCopy()

◆ allocateVertexBufferCopy()

◆ releaseVertexBufferCopy()

◆ touchVertexBufferCopy()

◆ _freeUnusedBufferCopies()

◆ _releaseBufferCopies()

◆ _forceReleaseBufferCopies() [1/2]

◆ _forceReleaseBufferCopies() [2/2]

◆ _notifyVertexBufferDestroyed()

◆ _notifyIndexBufferDestroyed()

◆ _notifyUniformBufferDestroyed()

◆ _notifyCounterBufferDestroyed()