OGRE-Next  3.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::MetalBufferInterface Class Referencefinal

For Metal, all buffers can be treated with the same code. More...

#include <OgreMetalBufferInterface.h>

+ Inheritance diagram for Ogre::MetalBufferInterface:

Public Member Functions

 MetalBufferInterface (size_t vboPoolIdx, id< MTLBuffer > vboName, MetalDynamicBuffer *dynamicBuffer)
 
 ~MetalBufferInterface () override
 
void _firstUpload (const void *data, size_t elementStart, size_t elementCount)
 Only use this function for the first upload. More...
 
void _setVboPoolIndex (size_t newVboPool)
 
void advanceFrame () override
 
void copyTo (BufferInterface *dstBuffer, size_t dstOffsetBytes, size_t srcOffsetBytes, size_t sizeBytes) override
 
id< MTLBuffer > getVboName () const
 Use __unsafe_unretained when possible to avoid unnecessary ARC overhead. More...
 
size_t getVboPoolIndex ()
 
void *RESTRICT_ALIAS_RETURN map (size_t elementStart, size_t elementCount, MappingState prevMappingState, bool advanceFrame=true) override
 
void regressFrame () override
 
void unmap (UnmapOptions unmapOption, size_t flushStartElem=0, size_t flushSizeElem=0) override
 
- Public Member Functions inherited from Ogre::BufferInterface
 BufferInterface ()
 
virtual ~BufferInterface ()
 
virtual void _ensureDelayedImmutableBuffersAreReady ()
 
virtual void _notifyBuffer (BufferPacked *buffer)
 
BufferPackedgetBufferPacked ()
 
void upload (const void *data, size_t elementStart, size_t elementCount)
 

Detailed Description

For Metal, all buffers can be treated with the same code.

Hence most equivalent functionality is encapsulated here.

Constructor & Destructor Documentation

◆ MetalBufferInterface()

Ogre::MetalBufferInterface::MetalBufferInterface ( size_t  vboPoolIdx,
id< MTLBuffer >  vboName,
MetalDynamicBuffer dynamicBuffer 
)

◆ ~MetalBufferInterface()

Ogre::MetalBufferInterface::~MetalBufferInterface ( )
override

Member Function Documentation

◆ _firstUpload()

void Ogre::MetalBufferInterface::_firstUpload ( const void *  data,
size_t  elementStart,
size_t  elementCount 
)

Only use this function for the first upload.

◆ _setVboPoolIndex()

void Ogre::MetalBufferInterface::_setVboPoolIndex ( size_t  newVboPool)
inline

◆ advanceFrame()

void Ogre::MetalBufferInterface::advanceFrame ( )
overridevirtual

Implements Ogre::BufferInterface.

◆ copyTo()

void Ogre::MetalBufferInterface::copyTo ( BufferInterface dstBuffer,
size_t  dstOffsetBytes,
size_t  srcOffsetBytes,
size_t  sizeBytes 
)
overridevirtual

Implements Ogre::BufferInterface.

◆ getVboName()

id<MTLBuffer> Ogre::MetalBufferInterface::getVboName ( ) const
inline

Use __unsafe_unretained when possible to avoid unnecessary ARC overhead.

◆ getVboPoolIndex()

size_t Ogre::MetalBufferInterface::getVboPoolIndex ( )
inline

◆ map()

void* RESTRICT_ALIAS_RETURN Ogre::MetalBufferInterface::map ( size_t  elementStart,
size_t  elementCount,
MappingState  prevMappingState,
bool  advanceFrame = true 
)
overridevirtual

Implements Ogre::BufferInterface.

◆ regressFrame()

void Ogre::MetalBufferInterface::regressFrame ( )
overridevirtual

Implements Ogre::BufferInterface.

◆ unmap()

void Ogre::MetalBufferInterface::unmap ( UnmapOptions  unmapOption,
size_t  flushStartElem = 0,
size_t  flushSizeElem = 0 
)
overridevirtual

Implements Ogre::BufferInterface.


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