DefaultHardwareBufferManager as a Singleton. More...

#include <OgreDefaultHardwareBufferManager.h>

Inheritance diagram for Ogre::DefaultHardwareBufferManager:

Public Member Functions
	DefaultHardwareBufferManager ()

	~DefaultHardwareBufferManager ()

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

Public Member Functions inherited from Ogre::HardwareBufferManager
	HardwareBufferManager ()

	~HardwareBufferManager ()

Public Member Functions inherited from Ogre::HardwareBufferManagerBase
	HardwareBufferManagerBase ()

virtual	~HardwareBufferManagerBase ()

void	_forceReleaseBufferCopies (const HardwareVertexBufferSharedPtr &sourceBuffer)
	Internal method that forces the release of copies of a given buffer. More...

void	_forceReleaseBufferCopies (HardwareVertexBuffer *sourceBuffer)
	Internal method that forces the release of copies of a given buffer. More...

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

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

HardwareVertexBufferSharedPtr	allocateVertexBufferCopy (const HardwareVertexBufferSharedPtr &sourceBuffer, BufferLicenseType licenseType, HardwareBufferLicensee *licensee, bool copyData=false)
	Allocates a copy of a given vertex buffer. More...

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

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

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

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

void	releaseVertexBufferCopy (const HardwareVertexBufferSharedPtr &bufferCopy)
	Manually release a vertex buffer copy for others to subsequently use. More...

void	touchVertexBufferCopy (const HardwareVertexBufferSharedPtr &bufferCopy)
	Tell engine that the vertex buffer copy intent to reuse. More...

Public Member Functions inherited from Ogre::Singleton< HardwareBufferManager >
	Singleton (void)

	~Singleton (void)

Additional Inherited Members
Public Types inherited from Ogre::HardwareBufferManagerBase
enum	BufferLicenseType { BLT_MANUAL_RELEASE, BLT_AUTOMATIC_RELEASE }

Static Public Member Functions inherited from Ogre::HardwareBufferManager
static HardwareBufferManager &	getSingleton (void)
	Get the singleton instance. More...

static HardwareBufferManager *	getSingletonPtr (void)
	Get the singleton instance. More...

Static Public Member Functions inherited from Ogre::Singleton< HardwareBufferManager >
static HardwareBufferManager &	getSingleton (void)
	Get the singleton instance. More...

static HardwareBufferManager *	getSingletonPtr (void)
	Get the singleton instance. More...

Detailed Description

DefaultHardwareBufferManager as a Singleton.

Constructor & Destructor Documentation

◆ DefaultHardwareBufferManager()

Ogre::DefaultHardwareBufferManager::DefaultHardwareBufferManager ( )

inline

◆ ~DefaultHardwareBufferManager()

Ogre::DefaultHardwareBufferManager::~DefaultHardwareBufferManager ( )

inline

Member Function Documentation

◆ createVertexBuffer()

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

inlinevirtual

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 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 memory is very expensive, and is in fact impossible if you specify HBU_DETAIL_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.

◆ createIndexBuffer()

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

inlinevirtual

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 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 memory is very expensive, and is in fact impossible if you specify HBU_DETAIL_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.

◆ createRenderToVertexBuffer()

RenderToVertexBufferSharedPtr Ogre::DefaultHardwareBufferManager::createRenderToVertexBuffer ( )

inlinevirtual

Create a render to vertex buffer.

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

Reimplemented from Ogre::HardwareBufferManagerBase.

◆ createUniformBuffer()

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

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

Reimplemented from Ogre::HardwareBufferManagerBase.

◆ createCounterBuffer()

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

inlinevirtual

Create counter buffer.

The update shall be triggered by GpuProgramParameters, if is dirty

Reimplemented from Ogre::HardwareBufferManagerBase.

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

OgreDefaultHardwareBufferManager.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultHardwareBufferManager()

◆ ~DefaultHardwareBufferManager()

Member Function Documentation

◆ createVertexBuffer()

◆ createIndexBuffer()

◆ createRenderToVertexBuffer()

◆ createUniformBuffer()

◆ createCounterBuffer()