Ogre::MetalHardwareVertexBuffer Class Reference

Specialisation of HardwareVertexBuffer for Metal. More...

#include <OgreMetalHardwareVertexBuffer.h>

Inheritance diagram for Ogre::MetalHardwareVertexBuffer:

Public Member Functions
	MetalHardwareVertexBuffer (MetalHardwareBufferManager *mgr, size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage, bool useShadowBuffer)
virtual	~MetalHardwareVertexBuffer ()
void	_notifyDeviceStalled (void)
virtual void	_updateFromShadow (void)
	Updates the real buffer from the shadow buffer, if required.
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.
id< MTLBuffer >	getBufferName (size_t &outOffset)
	Returns the actual API buffer, but first sets mLastFrameUsed as we assume you're calling this function to use the buffer in the GPU.
id< MTLBuffer >	getBufferNameForGpuWrite (void)
MetalHardwareBufferCommon *	getRenderSystemData (void)
virtual void	readData (size_t offset, size_t length, void *pDest)
	Reads data from the buffer and places it in the memory pointed to by pDest.
virtual void	writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)
	Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough.
Public Member Functions inherited from Ogre::HardwareVertexBuffer
	HardwareVertexBuffer (HardwareBufferManagerBase *mgr, size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer)
	Should be called by HardwareBufferManager.
	~HardwareVertexBuffer ()
size_t	getInstanceDataStepRate () const
	Get the number of instances to draw using the same per-instance data before advancing in the buffer by one element.
HardwareBufferManagerBase *	getManager () const
	Return the manager of this buffer, if any.
size_t	getNumVertices (void) const
	Get the number of vertices in this buffer.
size_t	getVertexSize (void) const
	Gets the size in bytes of a single vertex in this buffer.
bool	isInstanceData () const
	Get if this vertex buffer is an "instance data" buffer (per instance).
void	setInstanceDataStepRate (const size_t val)
	Set the number of instances to draw using the same per-instance data before advancing in the buffer by one element.
void	setIsInstanceData (const bool val)
	Set if this vertex buffer is an "instance data" buffer (per instance).
Public Member Functions inherited from Ogre::HardwareBuffer
	HardwareBuffer (Usage usage, bool systemMemory, bool useShadowBuffer)
	Constructor, to be called by HardwareBufferManager only.
virtual	~HardwareBuffer ()
virtual void	copyData (HardwareBuffer &srcBuffer)
	Copy all data from another buffer into this one.
size_t	getSizeInBytes (void) const
	Returns the size of this buffer in bytes.
Usage	getUsage (void) const
	Returns the Usage flags with which this buffer was created.
bool	hasShadowBuffer (void) const
	Returns whether this buffer has a system memory shadow for quicker reading.
bool	isLocked (void) const
	Returns whether or not this buffer is currently locked.
bool	isSystemMemory (void) const
	Returns whether this buffer is held in system memory.
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.
virtual void *	lock (size_t offset, size_t length, LockOptions options)
	Lock the buffer for (potentially) reading / writing.
void	suppressHardwareUpdate (bool suppress)
	Pass true to suppress hardware upload of shadow buffer changes.
virtual void	unlock (void)
	Releases the lock on this buffer.

Additional Inherited Members
Public Types inherited from Ogre::HardwareBuffer
enum	LockOptions {   HBL_NORMAL , HBL_DISCARD , HBL_READ_ONLY , HBL_NO_OVERWRITE ,   HBL_WRITE_ONLY }
	Locking options. More...
typedef int	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...

Detailed Description

Specialisation of HardwareVertexBuffer for Metal.

Constructor & Destructor Documentation

MetalHardwareVertexBuffer()

Ogre::MetalHardwareVertexBuffer::MetalHardwareVertexBuffer	(	MetalHardwareBufferManager *	mgr,
		size_t	vertexSize,
		size_t	numVertices,
		HardwareBuffer::Usage	usage,
		bool	useShadowBuffer )

~MetalHardwareVertexBuffer()

virtual Ogre::MetalHardwareVertexBuffer::~MetalHardwareVertexBuffer ( )

virtual

Member Function Documentation

_notifyDeviceStalled()

void Ogre::MetalHardwareVertexBuffer::_notifyDeviceStalled

(

void

)

getBufferName()

id< MTLBuffer > Ogre::MetalHardwareVertexBuffer::getBufferName

(

size_t &

outOffset

)

Returns the actual API buffer, but first sets mLastFrameUsed as we assume you're calling this function to use the buffer in the GPU.

Parameters

outOffset

Out. Guaranteed to be written. Used by HBU_DISCARDABLE buffers which need an offset to the internal ring buffer we've allocated.

Returns

The MTLBuffer in question.

getBufferNameForGpuWrite()

id< MTLBuffer > Ogre::MetalHardwareVertexBuffer::getBufferNameForGpuWrite

(

void

)

readData()

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

virtual

Reads data from the buffer and places it in the memory pointed to by pDest.

Parameters

offset	The byte offset from the start of the buffer to read
length	The size of the area to read, in bytes
pDest	The area of memory in which to place the data, must be large enough to accommodate the data!

Implements Ogre::HardwareBuffer.

writeData()

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

virtual

Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough.

Parameters

offset	The byte offset from the start of the buffer to start writing
length	The size of the data to write to, in bytes
pSource	The source of the data to be written
discardWholeBuffer	If true, this allows the driver to discard the entire buffer when writing, such that DMA stalls can be avoided; use if you can.

Implements Ogre::HardwareBuffer.

copyData()

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

virtual

Copy data from another buffer into this one.

Remarks

Note that the source buffer must not be created with the usage HBU_WRITE_ONLY otherwise this will fail.

Parameters

srcBuffer	The buffer from which to read the copied data
srcOffset	Offset in the source buffer at which to start reading
dstOffset	Offset in the destination buffer to start writing
length	Length of the data to copy, in bytes.
discardWholeBuffer	If true, will discard the entire contents of this buffer before copying

Reimplemented from Ogre::HardwareBuffer.

_updateFromShadow()

virtual void Ogre::MetalHardwareVertexBuffer::_updateFromShadow ( void )

virtual

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

Reimplemented from Ogre::HardwareBuffer.

getRenderSystemData()

MetalHardwareBufferCommon * Ogre::MetalHardwareVertexBuffer::getRenderSystemData

(

void

)

---

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

• OgreMetalHardwareVertexBuffer.h