OGRE: Ogre::BufferInterface Class Reference

| OGRE 2.2.4 Object-Oriented Graphics Rendering Engine

Public Member Functions | List of all members
Ogre::BufferInterface Class Referenceabstract

Most (if not all) buffers, can be treated with the same code. More...

`#include <OgreBufferInterface.h>`

Inheritance diagram for Ogre::BufferInterface:
[legend]

## Public Member Functions
| BufferInterface ()
virtual | ~BufferInterface ()
virtual void | _ensureDelayedImmutableBuffersAreReady (void)
virtual void | _notifyBuffer (BufferPacked *buffer)
virtual void | advanceFrame (void)=0
virtual void | copyTo (BufferInterface *dstBuffer, size_t dstOffsetBytes, size_t srcOffsetBytes, size_t sizeBytes)=0
BufferPacked * | getBufferPacked (void)
virtual void *RESTRICT_ALIAS_RETURN | map (size_t elementStart, size_t elementCount, MappingState prevMappingState, bool advanceFrame=true)=0
virtual void | regressFrame (void)=0
virtual void | unmap (UnmapOptions unmapOption, size_t flushStartElem=0, size_t flushSizeElem=0)=0
void | upload (const void *data, size_t elementStart, size_t elementCount)

## Detailed Description

Most (if not all) buffers, can be treated with the same code.

Hence most equivalent functionality is encapsulated here.

## Constructor & Destructor Documentation

## ◆ BufferInterface()

Ogre::BufferInterface::BufferInterface | ( |  | ) |

## ◆ ~BufferInterface()

virtual Ogre::BufferInterface::~BufferInterface | ( |  | ) |
| inlinevirtual

## Member Function Documentation

## ◆ _ensureDelayedImmutableBuffersAreReady()

virtual void Ogre::BufferInterface::_ensureDelayedImmutableBuffersAreReady | ( | void |  | ) |
| virtual

Reimplemented in Ogre::D3D11BufferInterfaceBase.

## ◆ _notifyBuffer()

virtual void Ogre::BufferInterface::_notifyBuffer | ( | BufferPacked * | buffer | ) |
| inlinevirtual

Reimplemented in Ogre::NULLBufferInterface.

## ◆ advanceFrame()

virtual void Ogre::BufferInterface::advanceFrame | ( | void |  | ) |
| pure virtual

Implemented in Ogre::NULLBufferInterface, Ogre::MetalBufferInterface, Ogre::GLES2BufferInterface, Ogre::GL3PlusBufferInterface, Ogre::D3D11CompatBufferInterface, and Ogre::D3D11BufferInterface.

## ◆ copyTo()

virtual void Ogre::BufferInterface::copyTo | ( | BufferInterface * | dstBuffer,
|  | size_t | dstOffsetBytes,
|  | size_t | srcOffsetBytes,
|  | size_t | sizeBytes
| ) |  |
| pure virtual

Implemented in Ogre::NULLBufferInterface, Ogre::MetalBufferInterface, Ogre::GL3PlusBufferInterface, and Ogre::D3D11BufferInterfaceBase.

## ◆ getBufferPacked()

BufferPacked* Ogre::BufferInterface::getBufferPacked | ( | void |  | ) |
| inline

## ◆ map()

virtual void* RESTRICT_ALIAS_RETURN Ogre::BufferInterface::map | ( | size_t | elementStart,
|  | size_t | elementCount,
|  | MappingState | prevMappingState,
|  | bool | advanceFrame = `true`
| ) |  |
| pure virtual

Implemented in Ogre::NULLBufferInterface, Ogre::MetalBufferInterface, Ogre::GLES2BufferInterface, Ogre::GL3PlusBufferInterface, Ogre::D3D11CompatBufferInterface, and Ogre::D3D11BufferInterface.

## ◆ regressFrame()

virtual void Ogre::BufferInterface::regressFrame | ( | void |  | ) |
| pure virtual

Implemented in Ogre::NULLBufferInterface, Ogre::MetalBufferInterface, Ogre::GLES2BufferInterface, Ogre::GL3PlusBufferInterface, Ogre::D3D11CompatBufferInterface, and Ogre::D3D11BufferInterface.

## ◆ unmap()

virtual void Ogre::BufferInterface::unmap | ( | UnmapOptions | unmapOption,
|  | size_t | flushStartElem = `0`,
|  | size_t | flushSizeElem = `0`
| ) |  |
| pure virtual

Implemented in Ogre::NULLBufferInterface, Ogre::MetalBufferInterface, Ogre::GLES2BufferInterface, Ogre::GL3PlusBufferInterface, Ogre::D3D11CompatBufferInterface, and Ogre::D3D11BufferInterface.

## ◆ upload()

void Ogre::BufferInterface::upload | ( | const void * | data,
|  | size_t | elementStart,
|  | size_t | elementCount
| ) |  |

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

- OgreBufferInterface.h