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

Public Member Functions
	D3D11HardwareBuffer (BufferType btype, size_t sizeBytes, HardwareBuffer::Usage usage, D3D11Device &device, bool useShadowBuffer, bool streamOut)
	~D3D11HardwareBuffer ()
void	_updateFromShadow (void) override
	Updates the real buffer from the shadow buffer, if required. More...
void	copyData (HardwareBuffer &srcBuffer, size_t srcOffset, size_t dstOffset, size_t length, bool discardWholeBuffer=false) override
	See HardwareBuffer. More...
void	copyDataImpl (HardwareBuffer &srcBuffer, size_t srcOffset, size_t dstOffset, size_t length, bool discardWholeBuffer=false)
ID3D11Buffer *	getD3DBuffer (void) const
	Get the D3D-specific buffer. More...
void	readData (size_t offset, size_t length, void *pDest) override
	See HardwareBuffer. More...
void	writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false) override
	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 ()
void	copyData (HardwareBuffer &srcBuffer)
	Copy all 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...

Detailed Description

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

Member Enumeration Documentation

BufferType

enum Ogre::D3D11HardwareBuffer::BufferType

Enumerator
VERTEX_BUFFER
INDEX_BUFFER
CONSTANT_BUFFER

Constructor & Destructor Documentation

D3D11HardwareBuffer()

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

~D3D11HardwareBuffer()

Ogre::D3D11HardwareBuffer::~D3D11HardwareBuffer

(

)

Member Function Documentation

readData()

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

overridevirtual

See HardwareBuffer.

Reimplemented from Ogre::HardwareBuffer.

writeData()

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

overridevirtual

See HardwareBuffer.

Reimplemented from Ogre::HardwareBuffer.

copyData()

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

overridevirtual

See HardwareBuffer.

We perform a hardware copy here.

Reimplemented from Ogre::HardwareBuffer.

copyDataImpl()

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

_updateFromShadow()

void Ogre::D3D11HardwareBuffer::_updateFromShadow ( void  )

overridevirtual

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

Reimplemented from Ogre::HardwareBuffer.

getD3DBuffer()

ID3D11Buffer* Ogre::D3D11HardwareBuffer::getD3DBuffer ( void  ) const

inline

Get the D3D-specific buffer.

References Ogre::ComPtr< T >::Get().

---

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

• OgreD3D11HardwareBuffer.h