Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::D3D7HardwareBufferManager Class Reference

Specialisation of HardwareBufferManager for D3D7. More...

#include <OgreD3D7HardwareBufferManager.h>

Inheritance diagram for Ogre::D3D7HardwareBufferManager:

Inheritance graph
[legend]
List of all members.

Public Types

enum  BufferLicenseType { BLT_MANUAL_RELEASE, BLT_AUTOMATIC_RELEASE }

Public Methods

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

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

virtual VertexDeclarationcreateVertexDeclaration (void)
 Creates a vertex declaration, may be overridden by certain rendering APIs.

virtual void destroyVertexDeclaration (VertexDeclaration *decl)
 Destroys a vertex declaration, may be overridden by certain rendering APIs.

virtual VertexBufferBindingcreateVertexBufferBinding (void)
 Creates a new VertexBufferBinding.

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

virtual void registerVertexBufferSourceAndCopy (const HardwareVertexBufferSharedPtr &sourceBuffer, const HardwareVertexBufferSharedPtr &copy)
 Registers a vertex buffer as a copy of another.

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

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

virtual void _releaseBufferCopies (void)
 Internal method for releasing all temporary buffers which have been allocated using BLT_AUTOMATIC_RELEASE; is called by OGRE.

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


Static Public Methods

HardwareBufferManagergetSingleton (void)
 Override standard Singleton retrieval.

HardwareBufferManagergetSingletonPtr (void)
 Override standard Singleton retrieval.


Protected Types

typedef std::list< VertexDeclaration * > VertexDeclarationList
typedef std::list< VertexBufferBinding * > VertexBufferBindingList
typedef std::set< HardwareVertexBuffer * > VertexBufferList
typedef std::set< HardwareIndexBuffer * > IndexBufferList
typedef std::vector< HardwareVertexBufferSharedPtrFreeTemporaryVertexBufferList
 List of free temporary vertex buffers.

typedef std::map< HardwareVertexBuffer *,
FreeTemporaryVertexBufferList * > 
FreeTemporaryVertexBufferMap
 Map from original buffer to list of temporary buffers.

typedef std::vector< VertexBufferLicense > TemporaryVertexBufferLicenseList
 List of currently licensed temp buffers.


Protected Methods

void destroyVertexBuffer (HardwareVertexBuffer *buf)
 Destroy a hardware vertex buffer.

void destroyIndexBuffer (HardwareIndexBuffer *buf)
 Destroy a hardware index buffer.

virtual void destroyAllDeclarations (void)
virtual void destroyAllBindings (void)
HardwareVertexBufferSharedPtr makeBufferCopy (const HardwareVertexBufferSharedPtr &source, HardwareBuffer::Usage usage, bool useShadowBuffer)
 Creates a new buffer as a copy of the source, does not copy data.


Protected Attributes

VertexDeclarationList mVertexDeclarations
VertexBufferBindingList mVertexBufferBindings
VertexBufferList mVertexBuffers
IndexBufferList mIndexBuffers
FreeTemporaryVertexBufferMap mFreeTempVertexBufferMap
 Map of current available temp buffers.

TemporaryVertexBufferLicenseList mTempVertexBufferLicenses
 List of currently licensed temp buffers.


Static Protected Attributes

HardwareBufferManagerms_Singleton = 0

Detailed Description

Specialisation of HardwareBufferManager for D3D7.

Remarks:
This class uses the software emulated buffers because D3D7's hardware vertex buffers are far too primitive. The only reason we override this is because D3D7 only allows 16-bit indexes so we have to prevent 32-bit index buffers being created.

Definition at line 43 of file OgreD3D7HardwareBufferManager.h.


Member Typedef Documentation

typedef std::vector<HardwareVertexBufferSharedPtr> Ogre::HardwareBufferManager::FreeTemporaryVertexBufferList [protected, inherited]
 

List of free temporary vertex buffers.

Definition at line 138 of file OgreHardwareBufferManager.h.

Referenced by Ogre::HardwareBufferManager::allocateVertexBufferCopy(), and Ogre::HardwareBufferManager::registerVertexBufferSourceAndCopy().

typedef std::map<HardwareVertexBuffer*, FreeTemporaryVertexBufferList*> Ogre::HardwareBufferManager::FreeTemporaryVertexBufferMap [protected, inherited]
 

Map from original buffer to list of temporary buffers.

Definition at line 140 of file OgreHardwareBufferManager.h.

typedef std::set<HardwareIndexBuffer*> Ogre::HardwareBufferManager::IndexBufferList [protected, inherited]
 

Definition at line 93 of file OgreHardwareBufferManager.h.

typedef std::vector<VertexBufferLicense> Ogre::HardwareBufferManager::TemporaryVertexBufferLicenseList [protected, inherited]
 

List of currently licensed temp buffers.

Definition at line 144 of file OgreHardwareBufferManager.h.

typedef std::list<VertexBufferBinding*> Ogre::HardwareBufferManager::VertexBufferBindingList [protected, inherited]
 

Definition at line 91 of file OgreHardwareBufferManager.h.

typedef std::set<HardwareVertexBuffer*> Ogre::HardwareBufferManager::VertexBufferList [protected, inherited]
 

Definition at line 92 of file OgreHardwareBufferManager.h.

typedef std::list<VertexDeclaration*> Ogre::HardwareBufferManager::VertexDeclarationList [protected, inherited]
 

Definition at line 90 of file OgreHardwareBufferManager.h.


Member Enumeration Documentation

enum Ogre::HardwareBufferManager::BufferLicenseType [inherited]
 

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

Definition at line 111 of file OgreHardwareBufferManager.h.


Constructor & Destructor Documentation

Ogre::D3D7HardwareBufferManager::D3D7HardwareBufferManager  
 

Definition at line 46 of file OgreD3D7HardwareBufferManager.h.

Ogre::D3D7HardwareBufferManager::~D3D7HardwareBufferManager  
 

Definition at line 47 of file OgreD3D7HardwareBufferManager.h.


Member Function Documentation

void Ogre::HardwareBufferManager::_forceReleaseBufferCopies const HardwareVertexBufferSharedPtr   sourceBuffer [virtual, inherited]
 

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.

Definition at line 235 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::VertexBufferLicense::buffer, Ogre::SharedPtr< HardwareVertexBuffer >::get(), Ogre::HardwareBufferManager::VertexBufferLicense::licensee, Ogre::HardwareBufferLicensee::licenseExpired(), Ogre::HardwareBufferManager::mFreeTempVertexBufferMap, Ogre::HardwareBufferManager::mTempVertexBufferLicenses, and Ogre::HardwareBufferManager::VertexBufferLicense::originalBufferPtr.

void Ogre::HardwareBufferManager::_releaseBufferCopies void    [virtual, inherited]
 

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

Definition at line 208 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::BLT_AUTOMATIC_RELEASE, Ogre::HardwareBufferManager::VertexBufferLicense::buffer, Ogre::HardwareBufferManager::VertexBufferLicense::licenseType, Ogre::HardwareBufferManager::mFreeTempVertexBufferMap, Ogre::HardwareBufferManager::mTempVertexBufferLicenses, and Ogre::HardwareBufferManager::VertexBufferLicense::originalBufferPtr.

HardwareVertexBufferSharedPtr Ogre::HardwareBufferManager::allocateVertexBufferCopy const HardwareVertexBufferSharedPtr   sourceBuffer,
BufferLicenseType    licenseType,
HardwareBufferLicensee   licensee,
bool    copyData = false
[virtual, inherited]
 

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

Definition at line 136 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::FreeTemporaryVertexBufferList, Ogre::SharedPtr< HardwareVertexBuffer >::get(), Ogre::SharedPtr< HardwareVertexBuffer >::getPointer(), Ogre::HardwareBufferManager::makeBufferCopy(), Ogre::HardwareBufferManager::mFreeTempVertexBufferMap, and Ogre::HardwareBufferManager::mTempVertexBufferLicenses.

Referenced by Ogre::TempBlendedBufferInfo::checkoutTempCopies().

HardwareIndexBufferSharedPtr Ogre::D3D7HardwareBufferManager::createIndexBuffer HardwareIndexBuffer::IndexType    itype,
size_t    numIndexes,
HardwareBuffer::Usage    usage,
bool    useShadowBuffer = false
[virtual]
 

Create a hardware index buffer.

Reimplemented from Ogre::DefaultHardwareBufferManager.

Definition at line 50 of file OgreD3D7HardwareBufferManager.h.

References Except.

HardwareVertexBufferSharedPtr Ogre::DefaultHardwareBufferManager::createVertexBuffer size_t    vertexSize,
size_t    numVerts,
HardwareBuffer::Usage    usage,
bool    useShadowBuffer = false
[virtual, inherited]
 

Creates a vertex buffer.

Implements Ogre::HardwareBufferManager.

Definition at line 165 of file OgreDefaultHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::HardwareVertexBufferSharedPtr, and Ogre::HardwareBufferManager::mVertexBuffers.

VertexBufferBinding * Ogre::HardwareBufferManager::createVertexBufferBinding void    [virtual, inherited]
 

Creates a new VertexBufferBinding.

Definition at line 77 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::mVertexBufferBindings.

VertexDeclaration * Ogre::HardwareBufferManager::createVertexDeclaration void    [virtual, inherited]
 

Creates a vertex declaration, may be overridden by certain rendering APIs.

Reimplemented in Ogre::D3D9HardwareBufferManager, and Ogre::GLHardwareBufferManager.

Definition at line 63 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::mVertexDeclarations.

void Ogre::HardwareBufferManager::destroyAllBindings void    [protected, virtual, inherited]
 

Definition at line 101 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::mVertexBufferBindings.

Referenced by Ogre::D3D9HardwareBufferManager::~D3D9HardwareBufferManager(), Ogre::DefaultHardwareBufferManager::~DefaultHardwareBufferManager(), Ogre::GLDefaultHardwareBufferManager::~GLDefaultHardwareBufferManager(), Ogre::GLHardwareBufferManager::~GLHardwareBufferManager(), and Ogre::HardwareBufferManager::~HardwareBufferManager().

void Ogre::HardwareBufferManager::destroyAllDeclarations void    [protected, virtual, inherited]
 

Reimplemented in Ogre::D3D9HardwareBufferManager.

Definition at line 90 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::mVertexDeclarations.

Referenced by Ogre::DefaultHardwareBufferManager::~DefaultHardwareBufferManager(), Ogre::GLDefaultHardwareBufferManager::~GLDefaultHardwareBufferManager(), Ogre::GLHardwareBufferManager::~GLHardwareBufferManager(), and Ogre::HardwareBufferManager::~HardwareBufferManager().

void Ogre::DefaultHardwareBufferManager::destroyIndexBuffer HardwareIndexBuffer   buf [protected, virtual, inherited]
 

Destroy a hardware index buffer.

Implements Ogre::HardwareBufferManager.

Definition at line 144 of file OgreDefaultHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::mIndexBuffers.

void Ogre::DefaultHardwareBufferManager::destroyVertexBuffer HardwareVertexBuffer   buf [protected, virtual, inherited]
 

Destroy a hardware vertex buffer.

Implements Ogre::HardwareBufferManager.

Definition at line 134 of file OgreDefaultHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::mVertexBuffers.

void Ogre::HardwareBufferManager::destroyVertexBufferBinding VertexBufferBinding   binding [virtual, inherited]
 

Destroys a VertexBufferBinding.

Definition at line 84 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::mVertexBufferBindings.

void Ogre::HardwareBufferManager::destroyVertexDeclaration VertexDeclaration   decl [virtual, inherited]
 

Destroys a vertex declaration, may be overridden by certain rendering APIs.

Reimplemented in Ogre::D3D9HardwareBufferManager, and Ogre::GLHardwareBufferManager.

Definition at line 71 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::mVertexDeclarations.

HardwareBufferManager & Ogre::HardwareBufferManager::getSingleton void    [static, inherited]
 

Override standard Singleton retrieval.

Remarks:
Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< HardwareBufferManager >.

Definition at line 38 of file OgreHardwareBufferManager.cpp.

References Ogre::Singleton< HardwareBufferManager >::ms_Singleton.

HardwareBufferManager * Ogre::HardwareBufferManager::getSingletonPtr void    [static, inherited]
 

Override standard Singleton retrieval.

Remarks:
Why do we do this? Well, it's because the Singleton implementation is in a .h file, which means it gets compiled into anybody who includes it. This is needed for the Singleton template to work, but we actually only want it compiled into the implementation of the class based on the Singleton, not all of them. If we don't change this, we get link errors when trying to use the Singleton-based class from an outside dll.

This method just delegates to the template version anyway, but the implementation stays in this single compilation unit, preventing link errors.

Reimplemented from Ogre::Singleton< HardwareBufferManager >.

Definition at line 34 of file OgreHardwareBufferManager.cpp.

References Ogre::Singleton< HardwareBufferManager >::ms_Singleton.

HardwareVertexBufferSharedPtr Ogre::HardwareBufferManager::makeBufferCopy const HardwareVertexBufferSharedPtr   source,
HardwareBuffer::Usage    usage,
bool    useShadowBuffer
[protected, inherited]
 

Creates a new buffer as a copy of the source, does not copy data.

Definition at line 276 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::createVertexBuffer().

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

void Ogre::HardwareBufferManager::registerVertexBufferSourceAndCopy const HardwareVertexBufferSharedPtr   sourceBuffer,
const HardwareVertexBufferSharedPtr   copy
[virtual, inherited]
 

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.

Definition at line 111 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::FreeTemporaryVertexBufferList, Ogre::SharedPtr< HardwareVertexBuffer >::getPointer(), and Ogre::HardwareBufferManager::mFreeTempVertexBufferMap.

void Ogre::HardwareBufferManager::releaseVertexBufferCopy const HardwareVertexBufferSharedPtr   bufferCopy [virtual, inherited]
 

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.

Definition at line 184 of file OgreHardwareBufferManager.cpp.

References Ogre::HardwareBufferManager::VertexBufferLicense::buffer, Ogre::SharedPtr< HardwareVertexBuffer >::getPointer(), Ogre::HardwareBufferManager::mFreeTempVertexBufferMap, Ogre::HardwareBufferManager::mTempVertexBufferLicenses, and Ogre::HardwareBufferManager::VertexBufferLicense::originalBufferPtr.


Member Data Documentation

FreeTemporaryVertexBufferMap Ogre::HardwareBufferManager::mFreeTempVertexBufferMap [protected, inherited]
 

Map of current available temp buffers.

Definition at line 142 of file OgreHardwareBufferManager.h.

Referenced by Ogre::HardwareBufferManager::_forceReleaseBufferCopies(), Ogre::HardwareBufferManager::_releaseBufferCopies(), Ogre::HardwareBufferManager::allocateVertexBufferCopy(), Ogre::HardwareBufferManager::registerVertexBufferSourceAndCopy(), Ogre::HardwareBufferManager::releaseVertexBufferCopy(), and Ogre::HardwareBufferManager::~HardwareBufferManager().

IndexBufferList Ogre::HardwareBufferManager::mIndexBuffers [protected, inherited]
 

Definition at line 98 of file OgreHardwareBufferManager.h.

Referenced by Ogre::DefaultHardwareBufferManager::createIndexBuffer(), and Ogre::DefaultHardwareBufferManager::destroyIndexBuffer().

HardwareBufferManager * Ogre::Singleton< HardwareBufferManager >::ms_Singleton = 0 [static, protected, inherited]
 

Definition at line 33 of file OgreHardwareBufferManager.cpp.

Referenced by Ogre::HardwareBufferManager::getSingleton(), and Ogre::HardwareBufferManager::getSingletonPtr().

TemporaryVertexBufferLicenseList Ogre::HardwareBufferManager::mTempVertexBufferLicenses [protected, inherited]
 

List of currently licensed temp buffers.

Definition at line 146 of file OgreHardwareBufferManager.h.

Referenced by Ogre::HardwareBufferManager::_forceReleaseBufferCopies(), Ogre::HardwareBufferManager::_releaseBufferCopies(), Ogre::HardwareBufferManager::allocateVertexBufferCopy(), and Ogre::HardwareBufferManager::releaseVertexBufferCopy().

VertexBufferBindingList Ogre::HardwareBufferManager::mVertexBufferBindings [protected, inherited]
 

Definition at line 96 of file OgreHardwareBufferManager.h.

Referenced by Ogre::HardwareBufferManager::createVertexBufferBinding(), Ogre::HardwareBufferManager::destroyAllBindings(), and Ogre::HardwareBufferManager::destroyVertexBufferBinding().

VertexBufferList Ogre::HardwareBufferManager::mVertexBuffers [protected, inherited]
 

Definition at line 97 of file OgreHardwareBufferManager.h.

Referenced by Ogre::DefaultHardwareBufferManager::createVertexBuffer(), and Ogre::DefaultHardwareBufferManager::destroyVertexBuffer().

VertexDeclarationList Ogre::HardwareBufferManager::mVertexDeclarations [protected, inherited]
 

Definition at line 95 of file OgreHardwareBufferManager.h.

Referenced by Ogre::HardwareBufferManager::createVertexDeclaration(), Ogre::GLHardwareBufferManager::createVertexDeclaration(), Ogre::D3D9HardwareBufferManager::createVertexDeclaration(), Ogre::HardwareBufferManager::destroyAllDeclarations(), Ogre::D3D9HardwareBufferManager::destroyAllDeclarations(), Ogre::HardwareBufferManager::destroyVertexDeclaration(), Ogre::GLHardwareBufferManager::destroyVertexDeclaration(), and Ogre::D3D9HardwareBufferManager::destroyVertexDeclaration().


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

Copyright © 2002-2003 by The OGRE Team
Last modified Fri May 14 23:23:44 2004