Ogre::D3D9HardwareBuffer Class Reference

Specialisation of HardwareVertexBuffer for D3D9. More...

#include <OgreD3D9HardwareBuffer.h>

Inheritance diagram for Ogre::D3D9HardwareBuffer:

Public Member Functions
	D3D9HardwareBuffer (D3DFORMAT type, size_t sizeInBytes, Usage usage, bool useShadowBuffer)
	~D3D9HardwareBuffer ()
void	createBuffer (IDirect3DDevice9 *d3d9Device, D3DPOOL ePool, bool updateNewBuffer)
IDirect3DResource9 *	getD3D9Resource (void)
	Get D3D9-specific resource. More...
virtual void	notifyOnDeviceCreate (IDirect3DDevice9 *d3d9Device)
virtual void	notifyOnDeviceDestroy (IDirect3DDevice9 *d3d9Device)
virtual void	notifyOnDeviceLost (IDirect3DDevice9 *d3d9Device)
virtual void	notifyOnDeviceReset (IDirect3DDevice9 *d3d9Device)
void	readData (size_t offset, size_t length, void *pDest)
	See HardwareBuffer. More...
void	writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)
	See HardwareBuffer. More...
Public Member Functions inherited from Ogre::HardwareBuffer
	HardwareBuffer (Usage usage, bool systemMemory, bool useShadowBuffer)
	Constructor, to be called by HardwareBufferManager only. More...
virtual	~HardwareBuffer ()
template<typename T >
T *	_getImpl ()
virtual void	_updateFromShadow (void)
	Updates the real buffer from the shadow buffer, if required. More...
void	copyData (HardwareBuffer &srcBuffer)
	Copy all data from another buffer into this one. More...
virtual void	copyData (HardwareBuffer &srcBuffer, size_t srcOffset, size_t dstOffset, size_t length, bool discardWholeBuffer=false)
	Copy data from another buffer into this one. More...
size_t	getSizeInBytes (void) const
	Returns the size of this buffer in bytes. More...
Usage	getUsage (void) const
	Returns the Usage flags with which this buffer was created. More...
bool	hasShadowBuffer (void) const
	Returns whether this buffer has a system memory shadow for quicker reading. More...
bool	isLocked (void) const
	Returns whether or not this buffer is currently locked. More...
bool	isSystemMemory (void) const
	Returns whether this buffer is held in system memory. More...
void *	lock (LockOptions options)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
virtual void *	lock (size_t offset, size_t length, LockOptions options)
	Lock the buffer for (potentially) reading / writing. More...
void	suppressHardwareUpdate (bool suppress)
	Pass true to suppress hardware upload of shadow buffer changes. More...
void	unlock (void)
	Releases the lock on this buffer. More...
Public Member Functions inherited from Ogre::D3D9Resource
	D3D9Resource ()
virtual	~D3D9Resource ()

Additional Inherited Members
Public Types inherited from Ogre::HardwareBuffer
enum	LockOptions : uint8 {   HBL_NORMAL , HBL_DISCARD , HBL_READ_ONLY , HBL_NO_OVERWRITE ,   HBL_WRITE_ONLY }
	Locking options. More...
typedef uint8	Usage
enum	UsageEnum {   HBU_STATIC = HBU_GPU_TO_CPU , HBU_DYNAMIC = HBU_CPU_ONLY , HBU_WRITE_ONLY = HBU_DETAIL_WRITE_ONLY , HBU_DISCARDABLE = 8 ,   HBU_STATIC_WRITE_ONLY = HBU_GPU_ONLY , HBU_DYNAMIC_WRITE_ONLY = HBU_CPU_TO_GPU , HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = HBU_CPU_TO_GPU }
	Rather use HardwareBufferUsage. More...
Static Public Member Functions inherited from Ogre::D3D9Resource
static void	lockDeviceAccess ()
static void	unlockDeviceAccess ()

Detailed Description

Specialisation of HardwareVertexBuffer for D3D9.

Constructor & Destructor Documentation

D3D9HardwareBuffer()

Ogre::D3D9HardwareBuffer::D3D9HardwareBuffer	(	D3DFORMAT	type,
		size_t	sizeInBytes,
		Usage	usage,
		bool	useShadowBuffer
	)

~D3D9HardwareBuffer()

Ogre::D3D9HardwareBuffer::~D3D9HardwareBuffer

(

)

Member Function Documentation

readData()

void Ogre::D3D9HardwareBuffer::readData ( size_t  offset, size_t  length, void *  pDest  )

virtual

See HardwareBuffer.

Reimplemented from Ogre::HardwareBuffer.

writeData()

void Ogre::D3D9HardwareBuffer::writeData ( size_t  offset, size_t  length, const void *  pSource, bool  discardWholeBuffer = false  )

virtual

See HardwareBuffer.

Reimplemented from Ogre::HardwareBuffer.

notifyOnDeviceCreate()

virtual void Ogre::D3D9HardwareBuffer::notifyOnDeviceCreate ( IDirect3DDevice9 *  d3d9Device )

virtual

Reimplemented from Ogre::D3D9Resource.

notifyOnDeviceDestroy()

virtual void Ogre::D3D9HardwareBuffer::notifyOnDeviceDestroy ( IDirect3DDevice9 *  d3d9Device )

virtual

Reimplemented from Ogre::D3D9Resource.

notifyOnDeviceLost()

virtual void Ogre::D3D9HardwareBuffer::notifyOnDeviceLost ( IDirect3DDevice9 *  d3d9Device )

virtual

Reimplemented from Ogre::D3D9Resource.

notifyOnDeviceReset()

virtual void Ogre::D3D9HardwareBuffer::notifyOnDeviceReset ( IDirect3DDevice9 *  d3d9Device )

virtual

Reimplemented from Ogre::D3D9Resource.

createBuffer()

void Ogre::D3D9HardwareBuffer::createBuffer	(	IDirect3DDevice9 *	d3d9Device,
		D3DPOOL	ePool,
		bool	updateNewBuffer
	)

getD3D9Resource()

IDirect3DResource9* Ogre::D3D9HardwareBuffer::getD3D9Resource

(

void

)

Get D3D9-specific resource.

---

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

• OgreD3D9HardwareBuffer.h