OGRE  1.12.12
Object-Oriented Graphics Rendering Engine
Ogre::MetalDiscardBuffer Class Reference

#include <OgreMetalDiscardBufferManager.h>

+ Inheritance diagram for Ogre::MetalDiscardBuffer:

Public Member Functions

 MetalDiscardBuffer (size_t bufferSize, uint16 alignment, MetalDiscardBufferManager *owner)
 
uint16 getAlignment (void) const
 
size_t getBlockSize (void) const
 
size_t getBlockStart (void) const
 For internal use by MetalDiscardBufferManager. 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...
 
size_t getOffset (void) const
 
MetalDiscardBufferManagergetOwner (void)
 
size_t getSizeBytes (void) const
 Size of the buffer, may be bigger than requested due to 4-byte alignment required by Metal. More...
 
void * map (bool noOverwrite)
 Returns a pointer that maps to the beginning of this buffer to begin writing. More...
 
void unmap (void)
 

Constructor & Destructor Documentation

◆ MetalDiscardBuffer()

Ogre::MetalDiscardBuffer::MetalDiscardBuffer ( size_t  bufferSize,
uint16  alignment,
MetalDiscardBufferManager owner 
)

Member Function Documentation

◆ map()

void* Ogre::MetalDiscardBuffer::map ( bool  noOverwrite)

Returns a pointer that maps to the beginning of this buffer to begin writing.

Parameters
noOverwriteWhen true, noOverwrite is slow
Returns

◆ unmap()

void Ogre::MetalDiscardBuffer::unmap ( void  )

◆ getAlignment()

uint16 Ogre::MetalDiscardBuffer::getAlignment ( void  ) const
inline

◆ getSizeBytes()

size_t Ogre::MetalDiscardBuffer::getSizeBytes ( void  ) const
inline

Size of the buffer, may be bigger than requested due to 4-byte alignment required by Metal.

◆ getOffset()

size_t Ogre::MetalDiscardBuffer::getOffset ( void  ) const
inline

◆ getBufferName()

id<MTLBuffer> Ogre::MetalDiscardBuffer::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 to point to the start of our data in the internal ring buffer we've allocated.
Returns
The MTLBuffer in question.

◆ getBlockStart()

size_t Ogre::MetalDiscardBuffer::getBlockStart ( void  ) const
inline

For internal use by MetalDiscardBufferManager.

◆ getBlockSize()

size_t Ogre::MetalDiscardBuffer::getBlockSize ( void  ) const
inline

◆ getOwner()

MetalDiscardBufferManager* Ogre::MetalDiscardBuffer::getOwner ( void  )
inline

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