Ogre::D3D11HardwareBuffer Class Reference

Base implementation of a D3D11 buffer, dealing with all the common aspects. More...

#include <OgreD3D11HardwareBuffer.h>

Inheritance diagram for Ogre::D3D11HardwareBuffer:

Public Types
enum	BufferType { VERTEX_BUFFER, INDEX_BUFFER, CONSTANT_BUFFER }
enum	LockOptions {   HBL_NORMAL, HBL_DISCARD, HBL_READ_ONLY, HBL_NO_OVERWRITE,   HBL_WRITE_ONLY }
	Locking options. More...
enum	Usage {   HBU_STATIC = 1, HBU_DYNAMIC = 2, HBU_WRITE_ONLY = 4, HBU_DISCARDABLE = 8,   HBU_STATIC_WRITE_ONLY = 5, HBU_DYNAMIC_WRITE_ONLY = 6, HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = 14 }
	Enums describing buffer usage; not mutually exclusive. More...

Public Member Functions
	D3D11HardwareBuffer (BufferType btype, size_t sizeBytes, HardwareBuffer::Usage usage, D3D11Device &device, bool useSystemMem, bool useShadowBuffer, bool streamOut)
	~D3D11HardwareBuffer ()
virtual void	_updateFromShadow (void)
	Updates the real buffer from the shadow buffer, if required. More...
virtual void	copyData (HardwareBuffer &srcBuffer)
	Copy all data from another buffer into this one. More...
void	copyData (HardwareBuffer &srcBuffer, size_t srcOffset, size_t dstOffset, size_t length, bool discardWholeBuffer=false)
	See HardwareBuffer. More...
ID3D11Buffer *	getD3DBuffer (void)
	Get the D3D-specific buffer. 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)
	Lock the entire buffer for (potentially) reading / writing. More...
virtual void *	lock (size_t offset, size_t length, LockOptions options)
	Lock the buffer for (potentially) reading / writing. More...
void	operator delete (void *ptr)
void	operator delete (void *ptr, const char *, int, const char *)
void	operator delete (void *ptr, void *)
void	operator delete[] (void *ptr)
void	operator delete[] (void *ptr, const char *, int, const char *)
void *	operator new (size_t sz)
void *	operator new (size_t sz, const char *file, int line, const char *func)
	operator new, with debug line info More...
void *	operator new (size_t sz, void *ptr)
	placement operator new More...
void *	operator new[] (size_t sz)
void *	operator new[] (size_t sz, const char *file, int line, const char *func)
	array operator new, with debug line info More...
void	readData (size_t offset, size_t length, void *pDest)
	See HardwareBuffer. More...
void	suppressHardwareUpdate (bool suppress)
	Pass true to suppress hardware upload of shadow buffer changes. More...
virtual void	unlock (void)
	Releases the lock on this buffer. More...
void	writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)
	See HardwareBuffer. More...

Protected Member Functions
void *	lockImpl (size_t offset, size_t length, LockOptions options)
	See HardwareBuffer. More...
void	unlockImpl (void)
	See HardwareBuffer. More...

Protected Attributes
BufferType	mBufferType
D3D11_BUFFER_DESC	mDesc
D3D11Device &	mDevice
bool	mIsLocked
size_t	mLockSize
size_t	mLockStart
ID3D11Buffer *	mlpD3DBuffer
D3D11HardwareBuffer *	mpTempStagingBuffer
HardwareBuffer *	mShadowBuffer
bool	mShadowUpdated
size_t	mSizeInBytes
bool	mStagingUploadNeeded
bool	mSuppressHardwareUpdate
bool	mSystemMemory
Usage	mUsage
bool	mUseShadowBuffer
bool	mUseTempStagingBuffer

Detailed Description

Base implementation of a D3D11 buffer, dealing with all the common aspects.

Definition at line 40 of file OgreD3D11HardwareBuffer.h.

Member Enumeration Documentation

BufferType

enum Ogre::D3D11HardwareBuffer::BufferType

Enumerator
VERTEX_BUFFER
INDEX_BUFFER
CONSTANT_BUFFER

Definition at line 43 of file OgreD3D11HardwareBuffer.h.

LockOptions

enum Ogre::HardwareBuffer::LockOptions

inherited

Locking options.

Enumerator
HBL_NORMAL	Normal mode, ie allows read/write and contents are preserved.
HBL_DISCARD	Discards the entire buffer while locking; this allows optimisation to be performed because synchronisation issues are relaxed. Only allowed on buffers created with the HBU_DYNAMIC flag.
HBL_READ_ONLY	Lock the buffer for reading only. Not allowed in buffers which are created with HBU_WRITE_ONLY. Mandatory on static buffers, i.e. those created without the HBU_DYNAMIC flag.
HBL_NO_OVERWRITE	As HBL_DISCARD, except the application guarantees not to overwrite any region of the buffer which has already been used in this frame, can allow some optimisation on some APIs.
HBL_WRITE_ONLY	Lock the buffer for writing only.

Definition at line 121 of file OgreHardwareBuffer.h.

Usage

enum Ogre::HardwareBuffer::Usage

inherited

Enums describing buffer usage; not mutually exclusive.

Enumerator
HBU_STATIC	Static buffer which the application rarely modifies once created. Modifying the contents of this buffer will involve a performance hit.
HBU_DYNAMIC	Indicates the application would like to modify this buffer with the CPU fairly often. Buffers created with this flag will typically end up in AGP memory rather than video memory.
HBU_WRITE_ONLY	Indicates the application will never read the contents of the buffer back, it will only ever write data. Locking a buffer with this flag will ALWAYS return a pointer to new, blank memory rather than the memory associated with the contents of the buffer; this avoids DMA stalls because you can write to a new memory area while the previous one is being used.
HBU_DISCARDABLE	Indicates that the application will be refilling the contents of the buffer regularly (not just updating, but generating the contents from scratch), and therefore does not mind if the contents of the buffer are lost somehow and need to be recreated. This allows and additional level of optimisation on the buffer. This option only really makes sense when combined with HBU_DYNAMIC_WRITE_ONLY.
HBU_STATIC_WRITE_ONLY	Combination of HBU_STATIC and HBU_WRITE_ONLY.
HBU_DYNAMIC_WRITE_ONLY	Combination of HBU_DYNAMIC and HBU_WRITE_ONLY. If you use this, strongly consider using HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE instead if you update the entire contents of the buffer very regularly.
HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE	Combination of HBU_DYNAMIC, HBU_WRITE_ONLY and HBU_DISCARDABLE.

Definition at line 79 of file OgreHardwareBuffer.h.

Constructor & Destructor Documentation

D3D11HardwareBuffer()

Ogre::D3D11HardwareBuffer::D3D11HardwareBuffer	(	BufferType	btype,
		size_t	sizeBytes,
		HardwareBuffer::Usage	usage,
		D3D11Device &	device,
		bool	useSystemMem,
		bool	useShadowBuffer,
		bool	streamOut
	)

~D3D11HardwareBuffer()

Ogre::D3D11HardwareBuffer::~D3D11HardwareBuffer

(

)

Member Function Documentation

_updateFromShadow()

virtual void Ogre::HardwareBuffer::_updateFromShadow ( void  )

virtualinherited

Updates the real buffer from the shadow buffer, if required.

Reimplemented in Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLHardwareVertexBuffer, and Ogre::GLHardwareIndexBuffer.

Definition at line 305 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::lockImpl(), and Ogre::HardwareBuffer::unlockImpl().

copyData() [1/2]

virtual void Ogre::HardwareBuffer::copyData ( HardwareBuffer &  srcBuffer )

virtualinherited

Copy all data from another buffer into this one.

Remarks

Normally these buffers should be of identical size, but if they're not, the routine will use the smallest of the two sizes.

Definition at line 298 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::getSizeInBytes().

copyData() [2/2]

void Ogre::D3D11HardwareBuffer::copyData ( HardwareBuffer &  srcBuffer, size_t  srcOffset, size_t  dstOffset, size_t  length, bool  discardWholeBuffer = false  )

virtual

See HardwareBuffer.

We perform a hardware copy here.

Reimplemented from Ogre::HardwareBuffer.

getD3DBuffer()

ID3D11Buffer* Ogre::D3D11HardwareBuffer::getD3DBuffer

(

void

)

Get the D3D-specific buffer.

Definition at line 79 of file OgreD3D11HardwareBuffer.h.

References mlpD3DBuffer.

getSizeInBytes()

size_t Ogre::HardwareBuffer::getSizeInBytes ( void  ) const

inherited

Returns the size of this buffer in bytes.

Definition at line 330 of file OgreHardwareBuffer.h.

Referenced by Ogre::HardwareBuffer::copyData().

getUsage()

Usage Ogre::HardwareBuffer::getUsage ( void  ) const

inherited

Returns the Usage flags with which this buffer was created.

Definition at line 332 of file OgreHardwareBuffer.h.

hasShadowBuffer()

bool Ogre::HardwareBuffer::hasShadowBuffer ( void  ) const

inherited

Returns whether this buffer has a system memory shadow for quicker reading.

Definition at line 336 of file OgreHardwareBuffer.h.

isLocked()

bool Ogre::HardwareBuffer::isLocked ( void  ) const

inherited

Returns whether or not this buffer is currently locked.

Definition at line 338 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::isLocked().

Referenced by Ogre::HardwareBuffer::isLocked(), and Ogre::HardwareBuffer::unlock().

isSystemMemory()

bool Ogre::HardwareBuffer::isSystemMemory ( void  ) const

inherited

Returns whether this buffer is held in system memory.

Definition at line 334 of file OgreHardwareBuffer.h.

lock() [1/2]

void* Ogre::HardwareBuffer::lock ( LockOptions  options )

inherited

Lock the entire buffer for (potentially) reading / writing.

Parameters

options

Locking options

Returns

Pointer to the locked memory

Definition at line 220 of file OgreHardwareBuffer.h.

lock() [2/2]

virtual void* Ogre::HardwareBuffer::lock ( size_t  offset, size_t  length, LockOptions  options  )

virtualinherited

Lock the buffer for (potentially) reading / writing.

Parameters

offset	The byte offset from the start of the buffer to lock
length	The size of the area to lock, in bytes
options	Locking options

Returns

Pointer to the locked memory

Reimplemented in Ogre::DefaultHardwareCounterBuffer, Ogre::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::HardwarePixelBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.

Definition at line 183 of file OgreHardwareBuffer.h.

References Ogre::Exception::ERR_INVALIDPARAMS, Ogre::HardwareBuffer::lock(), and OGRE_EXCEPT.

Referenced by Ogre::HardwareBuffer::copyData(), and Ogre::HardwareBuffer::lock().

lockImpl()

void* Ogre::D3D11HardwareBuffer::lockImpl ( size_t  offset, size_t  length, LockOptions  options  )

protectedvirtual

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

operator delete() [1/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr )

inherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

operator delete() [2/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, const char *  , int  , const char *    )

inherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

operator delete() [3/3]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr, void *    )

inherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

operator delete[]() [1/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr )

inherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

operator delete[]() [2/2]

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr, const char *  , int  , const char *    )

inherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

operator new() [1/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz )

inherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

operator new() [2/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, const char *  file, int  line, const char *  func  )

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

operator new() [3/3]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz, void *  ptr  )

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

operator new[]() [1/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz )

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

operator new[]() [2/2]

template<class Alloc >

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz, const char *  file, int  line, const char *  func  )

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

readData()

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

virtual

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

suppressHardwareUpdate()

void Ogre::HardwareBuffer::suppressHardwareUpdate ( bool  suppress )

inherited

Pass true to suppress hardware upload of shadow buffer changes.

Definition at line 342 of file OgreHardwareBuffer.h.

unlock()

virtual void Ogre::HardwareBuffer::unlock ( void  )

virtualinherited

Releases the lock on this buffer.

Remarks

Locking and unlocking a buffer can, in some rare circumstances such as switching video modes whilst the buffer is locked, corrupt the contents of a buffer. This is pretty rare, but if it occurs, this method will throw an exception, meaning you must re-upload the data.

Note that using the 'read' and 'write' forms of updating the buffer does not suffer from this problem, so if you want to be 100% sure your data will not be lost, use the 'read' and 'write' forms instead.

Reimplemented in Ogre::DefaultHardwareCounterBuffer, Ogre::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.

Definition at line 236 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::isLocked(), and Ogre::HardwareBuffer::unlock().

Referenced by Ogre::HardwareBuffer::copyData(), and Ogre::HardwareBuffer::unlock().

unlockImpl()

void Ogre::D3D11HardwareBuffer::unlockImpl ( void  )

protectedvirtual

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

writeData()

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

virtual

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

Member Data Documentation

mBufferType

BufferType Ogre::D3D11HardwareBuffer::mBufferType

protected

Definition at line 54 of file OgreD3D11HardwareBuffer.h.

mDesc

D3D11_BUFFER_DESC Ogre::D3D11HardwareBuffer::mDesc

protected

Definition at line 56 of file OgreD3D11HardwareBuffer.h.

mDevice

D3D11Device& Ogre::D3D11HardwareBuffer::mDevice

protected

Definition at line 55 of file OgreD3D11HardwareBuffer.h.

mIsLocked

bool Ogre::HardwareBuffer::mIsLocked

protectedinherited

Definition at line 145 of file OgreHardwareBuffer.h.

mLockSize

size_t Ogre::HardwareBuffer::mLockSize

protectedinherited

Definition at line 147 of file OgreHardwareBuffer.h.

mLockStart

size_t Ogre::HardwareBuffer::mLockStart

protectedinherited

Definition at line 146 of file OgreHardwareBuffer.h.

mlpD3DBuffer

ID3D11Buffer* Ogre::D3D11HardwareBuffer::mlpD3DBuffer

protected

Definition at line 50 of file OgreD3D11HardwareBuffer.h.

Referenced by getD3DBuffer().

mpTempStagingBuffer

D3D11HardwareBuffer* Ogre::D3D11HardwareBuffer::mpTempStagingBuffer

protected

Definition at line 52 of file OgreD3D11HardwareBuffer.h.

mShadowBuffer

HardwareBuffer* Ogre::HardwareBuffer::mShadowBuffer

protectedinherited

Definition at line 150 of file OgreHardwareBuffer.h.

mShadowUpdated

bool Ogre::HardwareBuffer::mShadowUpdated

protectedinherited

Definition at line 151 of file OgreHardwareBuffer.h.

mSizeInBytes

size_t Ogre::HardwareBuffer::mSizeInBytes

protectedinherited

Definition at line 143 of file OgreHardwareBuffer.h.

mStagingUploadNeeded

bool Ogre::D3D11HardwareBuffer::mStagingUploadNeeded

protected

Definition at line 53 of file OgreD3D11HardwareBuffer.h.

mSuppressHardwareUpdate

bool Ogre::HardwareBuffer::mSuppressHardwareUpdate

protectedinherited

Definition at line 152 of file OgreHardwareBuffer.h.

mSystemMemory

bool Ogre::HardwareBuffer::mSystemMemory

protectedinherited

Definition at line 148 of file OgreHardwareBuffer.h.

mUsage

Usage Ogre::HardwareBuffer::mUsage

protectedinherited

Definition at line 144 of file OgreHardwareBuffer.h.

mUseShadowBuffer

bool Ogre::HardwareBuffer::mUseShadowBuffer

protectedinherited

Definition at line 149 of file OgreHardwareBuffer.h.

mUseTempStagingBuffer

bool Ogre::D3D11HardwareBuffer::mUseTempStagingBuffer

protected

Definition at line 51 of file OgreD3D11HardwareBuffer.h.

---

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

• OgreD3D11HardwareBuffer.h