OGRE  1.12.1
Object-Oriented Graphics Rendering Engine
Ogre::HardwareBufferManagerBase Class Referenceabstract

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 ()
 
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...
 
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...
 
VertexBufferBindingcreateVertexBufferBinding (void)
 Creates a new VertexBufferBinding. More...
 
VertexDeclarationcreateVertexDeclaration (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...
 

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 (notably DefaultHardwareBufferManagerBase). The Singleton is add via the inheritance in HardwareBufferManager below.

Member Enumeration Documentation

◆ 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
vertexSizeThe 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.
numVertsThe number of vertices in this buffer.
usageOne 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.
useShadowBufferIf 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::DefaultHardwareBufferManagerBase, Ogre::GL3PlusHardwareBufferManager, Ogre::GLHardwareBufferManager, Ogre::GLES2HardwareBufferManager, Ogre::D3D11HardwareBufferManager, and Ogre::D3D9HardwareBufferManager.

Referenced by Ogre::Lod0Stripifier::~Lod0Stripifier().

◆ 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
itypeThe type in index, either 16- or 32-bit, depending on how many vertices you need to be able to address
numIndexesThe number of indexes in the buffer
usageOne or more members of the HardwareBuffer::Usage enumeration.
useShadowBufferIf 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::DefaultHardwareBufferManagerBase, Ogre::GL3PlusHardwareBufferManager, Ogre::D3D11HardwareBufferManager, Ogre::GLHardwareBufferManager, Ogre::GLES2HardwareBufferManager, and Ogre::D3D9HardwareBufferManager.

Referenced by Ogre::Lod0Stripifier::~Lod0Stripifier().

◆ 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::DefaultHardwareBufferManager, Ogre::DefaultHardwareBufferManagerBase, Ogre::GL3PlusHardwareBufferManager, Ogre::GLHardwareBufferManager, Ogre::D3D11HardwareBufferManager, Ogre::GLES2HardwareBufferManager, and Ogre::D3D9HardwareBufferManager.

◆ 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::DefaultHardwareBufferManager, Ogre::DefaultHardwareBufferManagerBase, Ogre::GL3PlusHardwareBufferManager, Ogre::GLHardwareBufferManager, Ogre::D3D11HardwareBufferManager, Ogre::GLES2HardwareBufferManager, and Ogre::D3D9HardwareBufferManager.

◆ 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

◆ createVertexDeclaration()

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

Creates a new vertex declaration.

◆ destroyVertexDeclaration()

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

Destroys a vertex declaration.

◆ createVertexBufferBinding()

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

Creates a new VertexBufferBinding.

◆ destroyVertexBufferBinding()

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

Destroys a VertexBufferBinding.

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

◆ allocateVertexBufferCopy()

HardwareVertexBufferSharedPtr Ogre::HardwareBufferManagerBase::allocateVertexBufferCopy ( const HardwareVertexBufferSharedPtr sourceBuffer,
BufferLicenseType  licenseType,
HardwareBufferLicensee licensee,
bool  copyData = false 
)

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
sourceBufferThe source buffer to use as a copy.
licenseTypeThe type of license required on this buffer - automatic release causes this class to release licenses every frame so that they can be reallocated anew.
licenseePointer back to the class requesting the copy, which must implement HardwareBufferLicense in order to be notified when the license expires.
copyDataIf true, the current data is copied as well as the structure of the buffer/

◆ releaseVertexBufferCopy()

void Ogre::HardwareBufferManagerBase::releaseVertexBufferCopy ( const HardwareVertexBufferSharedPtr bufferCopy)

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

◆ touchVertexBufferCopy()

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

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
bufferCopyThe buffer copy. The caller is expected to keep this buffer copy for use.

◆ _freeUnusedBufferCopies()

void Ogre::HardwareBufferManagerBase::_freeUnusedBufferCopies ( void  )

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

◆ _releaseBufferCopies()

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

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

Parameters
forceFreeUnusedIf true, free all unused temporary buffers. If false, auto detect and free all unused temporary buffers based on temporary buffers utilization.

◆ _forceReleaseBufferCopies() [1/2]

void Ogre::HardwareBufferManagerBase::_forceReleaseBufferCopies ( const HardwareVertexBufferSharedPtr 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
sourceBufferThe source buffer as a shared pointer. Any buffer copies created from the source buffer are deleted.

◆ _forceReleaseBufferCopies() [2/2]

void Ogre::HardwareBufferManagerBase::_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
sourceBufferThe source buffer as a pointer. Any buffer copies created from the source buffer are deleted.

◆ _notifyVertexBufferDestroyed()

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

Notification that a hardware vertex buffer has been destroyed.

◆ _notifyIndexBufferDestroyed()

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

Notification that a hardware index buffer has been destroyed.

◆ _notifyUniformBufferDestroyed()

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

Notification that at hardware uniform buffer has been destroyed.

◆ _notifyCounterBufferDestroyed()

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

Notification that at hardware counter buffer has been destroyed.


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