OGRE  1.10.12
Object-Oriented Graphics Rendering Engine
Ogre::D3D9HardwareBufferManager Class Reference

D3D9HardwareBufferManagerBase as a Singleton. More...

#include <OgreD3D9HardwareBufferManager.h>

+ Inheritance diagram for Ogre::D3D9HardwareBufferManager:

Public Types

enum  BufferLicenseType { BLT_MANUAL_RELEASE, BLT_AUTOMATIC_RELEASE }
 

Public Member Functions

 D3D9HardwareBufferManager ()
 
 ~D3D9HardwareBufferManager ()
 
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 _notifyConterBufferDestroyed (HardwareCounterBuffer *buf)
 Notification that at hardware counter buffer has been destroyed. 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...
 
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...
 
virtual VertexBufferBindingcreateVertexBufferBinding (void)
 Creates a new VertexBufferBinding. More...
 
virtual VertexDeclarationcreateVertexDeclaration (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...
 

Static Public Member Functions

static HardwareBufferManagergetSingleton (void)
 Get the singleton instance. More...
 
static HardwareBufferManagergetSingletonPtr (void)
 Get the singleton instance. More...
 

Detailed Description

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

◆ D3D9HardwareBufferManager()

Ogre::D3D9HardwareBufferManager::D3D9HardwareBufferManager ( )
inline

◆ ~D3D9HardwareBufferManager()

Ogre::D3D9HardwareBufferManager::~D3D9HardwareBufferManager ( )
inline

References OGRE_DELETE.

Member Function Documentation

◆ createVertexBuffer()

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

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.

Implements Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::createVertexBuffer().

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

◆ createIndexBuffer()

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

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.

Implements Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::createIndexBuffer().

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

◆ createRenderToVertexBuffer()

RenderToVertexBufferSharedPtr Ogre::HardwareBufferManager::createRenderToVertexBuffer ( )
inlinevirtualinherited

Create a render to vertex buffer.

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

Implements Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::createRenderToVertexBuffer().

◆ createUniformBuffer()

HardwareUniformBufferSharedPtr Ogre::HardwareBufferManager::createUniformBuffer ( size_t  sizeBytes,
HardwareBuffer::Usage  usage,
bool  useShadowBuffer,
const String name = "" 
)
inlinevirtualinherited

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

Implements Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::createUniformBuffer().

◆ createCounterBuffer()

HardwareCounterBufferSharedPtr Ogre::HardwareBufferManager::createCounterBuffer ( size_t  sizeBytes,
HardwareBuffer::Usage  usage,
bool  useShadowBuffer,
const String name = "" 
)
inlinevirtualinherited

Create counter buffer.

The update shall be triggered by GpuProgramParameters, if is dirty

Implements Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::createCounterBuffer().

◆ createVertexDeclaration()

virtual VertexDeclaration* Ogre::HardwareBufferManager::createVertexDeclaration ( void  )
inlinevirtualinherited

Creates a new vertex declaration.

Reimplemented from Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::createVertexDeclaration().

◆ destroyVertexDeclaration()

virtual void Ogre::HardwareBufferManager::destroyVertexDeclaration ( VertexDeclaration decl)
inlinevirtualinherited

Destroys a vertex declaration.

Reimplemented from Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::destroyVertexDeclaration().

◆ createVertexBufferBinding()

virtual VertexBufferBinding* Ogre::HardwareBufferManager::createVertexBufferBinding ( void  )
inlinevirtualinherited

◆ destroyVertexBufferBinding()

virtual void Ogre::HardwareBufferManager::destroyVertexBufferBinding ( VertexBufferBinding binding)
inlinevirtualinherited

◆ registerVertexBufferSourceAndCopy()

virtual void Ogre::HardwareBufferManager::registerVertexBufferSourceAndCopy ( const HardwareVertexBufferSharedPtr sourceBuffer,
const HardwareVertexBufferSharedPtr copy 
)
inlinevirtualinherited

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

References Ogre::HardwareBufferManagerBase::registerVertexBufferSourceAndCopy().

◆ allocateVertexBufferCopy()

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

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/

Reimplemented from Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::allocateVertexBufferCopy().

◆ releaseVertexBufferCopy()

virtual void Ogre::HardwareBufferManager::releaseVertexBufferCopy ( const HardwareVertexBufferSharedPtr bufferCopy)
inlinevirtualinherited

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.

Reimplemented from Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::releaseVertexBufferCopy().

◆ touchVertexBufferCopy()

virtual void Ogre::HardwareBufferManager::touchVertexBufferCopy ( const HardwareVertexBufferSharedPtr bufferCopy)
inlinevirtualinherited

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.

Reimplemented from Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::touchVertexBufferCopy().

◆ _freeUnusedBufferCopies()

virtual void Ogre::HardwareBufferManager::_freeUnusedBufferCopies ( void  )
inlinevirtualinherited

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

References Ogre::HardwareBufferManagerBase::_freeUnusedBufferCopies().

◆ _releaseBufferCopies()

virtual void Ogre::HardwareBufferManager::_releaseBufferCopies ( bool  forceFreeUnused = false)
inlinevirtualinherited

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.

Reimplemented from Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::_releaseBufferCopies().

◆ _forceReleaseBufferCopies() [1/2]

virtual void Ogre::HardwareBufferManager::_forceReleaseBufferCopies ( const HardwareVertexBufferSharedPtr sourceBuffer)
inlinevirtualinherited

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.

Reimplemented from Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::_forceReleaseBufferCopies().

◆ _forceReleaseBufferCopies() [2/2]

virtual void Ogre::HardwareBufferManager::_forceReleaseBufferCopies ( HardwareVertexBuffer sourceBuffer)
inlinevirtualinherited

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.

Reimplemented from Ogre::HardwareBufferManagerBase.

References Ogre::HardwareBufferManagerBase::_forceReleaseBufferCopies().

◆ _notifyVertexBufferDestroyed()

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

Notification that a hardware vertex buffer has been destroyed.

References Ogre::HardwareBufferManagerBase::_notifyVertexBufferDestroyed().

◆ _notifyIndexBufferDestroyed()

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

Notification that a hardware index buffer has been destroyed.

References Ogre::HardwareBufferManagerBase::_notifyIndexBufferDestroyed().

◆ _notifyUniformBufferDestroyed()

void Ogre::HardwareBufferManager::_notifyUniformBufferDestroyed ( HardwareUniformBuffer buf)
inlineinherited

Notification that at hardware uniform buffer has been destroyed.

References Ogre::HardwareBufferManagerBase::_notifyUniformBufferDestroyed().

◆ _notifyConterBufferDestroyed()

void Ogre::HardwareBufferManager::_notifyConterBufferDestroyed ( HardwareCounterBuffer buf)
inlineinherited

Notification that at hardware counter buffer has been destroyed.

References Ogre::HardwareBufferManagerBase::_notifyCounterBufferDestroyed().

◆ getSingleton()

static HardwareBufferManager& Ogre::HardwareBufferManager::getSingleton ( void  )
staticinherited

Get the singleton instance.

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

◆ getSingletonPtr()

static HardwareBufferManager* Ogre::HardwareBufferManager::getSingletonPtr ( void  )
staticinherited

Get the singleton instance.

◆ _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: