OGRE  13.6
Object-Oriented Graphics Rendering Engine
Ogre::MetalHardwareBufferCommon Class Reference

Common buffer operations for most v1 buffer interfaces used in Metal This implementation treats: Ignores STATIC and DYNAMIC bit in buffers Lack of WRITE_ONLY and DISCARDABLE buffer puts it in slowest path. More...

#include <OgreMetalHardwareBufferCommon.h>

+ Inheritance diagram for Ogre::MetalHardwareBufferCommon:

Public Member Functions

 MetalHardwareBufferCommon (size_t sizeBytes, Usage usage, bool useShadowBuffer, uint16 alignment, MetalDevice *device)
 
virtual ~MetalHardwareBufferCommon ()
 
void _notifyDeviceStalled ()
 
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
 Copy data from another buffer into this one. More...
 
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. More...
 
void * lockImpl (size_t offset, size_t length, LockOptions options) override
 Internal implementation of lock() More...
 
void readData (size_t offset, size_t length, void *pDest) override
 Reads data from the buffer and places it in the memory pointed to by pDest. More...
 
void unlockImpl () override
 Internal implementation of unlock() More...
 
void writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false) override
 Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough. More...
 
void writeDataImpl (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer)
 
- 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...
 

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

Detailed Description

Common buffer operations for most v1 buffer interfaces used in Metal This implementation treats: Ignores STATIC and DYNAMIC bit in buffers Lack of WRITE_ONLY and DISCARDABLE buffer puts it in slowest path.

Puts WRITE_ONLY in device memory and uses staging buffers to avoid blocking. Use WRITE_ONLY when possible.

Constructor & Destructor Documentation

◆ MetalHardwareBufferCommon()

Ogre::MetalHardwareBufferCommon::MetalHardwareBufferCommon ( size_t  sizeBytes,
Usage  usage,
bool  useShadowBuffer,
uint16  alignment,
MetalDevice device 
)

◆ ~MetalHardwareBufferCommon()

virtual Ogre::MetalHardwareBufferCommon::~MetalHardwareBufferCommon ( )
virtual

Member Function Documentation

◆ _notifyDeviceStalled()

void Ogre::MetalHardwareBufferCommon::_notifyDeviceStalled ( )
inline

◆ getBufferName()

id<MTLBuffer> Ogre::MetalHardwareBufferCommon::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
outOffsetOut. 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.

◆ lockImpl()

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

Internal implementation of lock()

Reimplemented from Ogre::HardwareBuffer.

◆ unlockImpl()

void Ogre::MetalHardwareBufferCommon::unlockImpl ( void  )
overridevirtual

Internal implementation of unlock()

Reimplemented from Ogre::HardwareBuffer.

◆ readData()

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

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

Parameters
offsetThe byte offset from the start of the buffer to read
lengthThe size of the area to read, in bytes
pDestThe area of memory in which to place the data, must be large enough to accommodate the data!

Reimplemented from Ogre::HardwareBuffer.

◆ writeData()

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

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

Parameters
offsetThe byte offset from the start of the buffer to start writing
lengthThe size of the data to write to, in bytes
pSourceThe source of the data to be written
discardWholeBufferIf true, this allows the driver to discard the entire buffer when writing, such that DMA stalls can be avoided; use if you can.

Reimplemented from Ogre::HardwareBuffer.

◆ writeDataImpl()

void Ogre::MetalHardwareBufferCommon::writeDataImpl ( size_t  offset,
size_t  length,
const void *  pSource,
bool  discardWholeBuffer 
)

◆ copyData()

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

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
srcBufferThe buffer from which to read the copied data
srcOffsetOffset in the source buffer at which to start reading
dstOffsetOffset in the destination buffer to start writing
lengthLength of the data to copy, in bytes.
discardWholeBufferIf true, will discard the entire contents of this buffer before copying

Reimplemented from Ogre::HardwareBuffer.

◆ _updateFromShadow()

void Ogre::MetalHardwareBufferCommon::_updateFromShadow ( void  )
overridevirtual

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

Reimplemented from Ogre::HardwareBuffer.


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