OGRE-Next  4.0.0unstable
Object-Oriented Graphics Rendering Engine
Ogre::v1::GLES2DefaultHardwareIndexBuffer Class Reference

Specialisation of HardwareIndexBuffer for emulation. More...

#include <OgreGLES2DefaultHardwareBufferManager.h>

+ Inheritance diagram for Ogre::v1::GLES2DefaultHardwareIndexBuffer:

Public Member Functions

 GLES2DefaultHardwareIndexBuffer (IndexType idxType, size_t numIndexes, HardwareBuffer::Usage usage)
 
virtual ~GLES2DefaultHardwareIndexBuffer ()
 
void * getDataPtr (size_t offset) const
 
void * lock (size_t offset, size_t length, LockOptions options)
 Override HardwareBuffer to turn off all shadowing. More...
 
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. More...
 
void unlock ()
 Override HardwareBuffer to turn off all shadowing. More...
 
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. More...
 
- Public Member Functions inherited from Ogre::v1::HardwareIndexBuffer
 HardwareIndexBuffer (HardwareBufferManagerBase *mgr, IndexType idxType, size_t numIndexes, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer)
 Should be called by HardwareBufferManager. More...
 
 ~HardwareIndexBuffer ()
 
size_t getIndexSize () const
 Get the size in bytes of each index. More...
 
HardwareBufferManagerBasegetManager () const
 Return the manager of this buffer, if any. More...
 
size_t getNumIndexes () const
 Get the number of indexes in this buffer. More...
 
IndexType getType () const
 Get the type of indexes used in this buffer. More...
 
- Public Member Functions inherited from Ogre::v1::HardwareBuffer
 HardwareBuffer (Usage usage, bool systemMemory, bool useShadowBuffer)
 Constructor, to be called by HardwareBufferManager only. More...
 
virtual ~HardwareBuffer ()
 
virtual void _updateFromShadow ()
 Updates the real buffer from the shadow buffer, if required. More...
 
virtual void copyData (HardwareBuffer &srcBuffer)
 Copy all data from another buffer into this one. More...
 
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. More...
 
virtual void * getRenderSystemData ()
 An internal function that should be used only by a render system for internal use. More...
 
size_t getSizeInBytes () const
 Returns the size of this buffer in bytes. More...
 
Usage getUsage () const
 Returns the Usage flags with which this buffer was created. More...
 
bool hasShadowBuffer () const
 Returns whether this buffer has a system memory shadow for quicker reading. More...
 
bool isLocked () const
 Returns whether or not this buffer is currently locked. More...
 
bool isSystemMemory () const
 Returns whether this buffer is held in system memory. More...
 
void * lock (LockOptions options)
 Lock the entire buffer for (potentially) reading / writing. More...
 
void suppressHardwareUpdate (bool suppress)
 Pass true to suppress hardware upload of shadow buffer changes. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::v1::HardwareIndexBuffer
typedef Ogre::IndexType IndexType
 
- Public Types inherited from Ogre::v1::HardwareBuffer
enum  LockOptions {
  HBL_NORMAL , HBL_DISCARD , HBL_READ_ONLY , HBL_NO_OVERWRITE ,
  HBL_WRITE_ONLY
}
 Locking options. More...
 
enum  Usage {
  HBU_STATIC = 1 , HBU_DYNAMIC = 2 , HBU_WRITE_ONLY = 4 , HBU_DISCARDABLE = 8 ,
  HBU_STATIC_WRITE_ONLY = 5 , HBU_DYNAMIC_WRITE_ONLY = 6 , HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = 14
}
 Enums describing buffer usage; not mutually exclusive. More...
 
- Static Public Attributes inherited from Ogre::v1::HardwareIndexBuffer
static const IndexType IT_16BIT = Ogre::IT_16BIT
 
static const IndexType IT_32BIT = Ogre::IT_32BIT
 

Detailed Description

Specialisation of HardwareIndexBuffer for emulation.

Constructor & Destructor Documentation

◆ GLES2DefaultHardwareIndexBuffer()

Ogre::v1::GLES2DefaultHardwareIndexBuffer::GLES2DefaultHardwareIndexBuffer ( IndexType  idxType,
size_t  numIndexes,
HardwareBuffer::Usage  usage 
)

◆ ~GLES2DefaultHardwareIndexBuffer()

virtual Ogre::v1::GLES2DefaultHardwareIndexBuffer::~GLES2DefaultHardwareIndexBuffer ( )
virtual

Member Function Documentation

◆ getDataPtr()

void* Ogre::v1::GLES2DefaultHardwareIndexBuffer::getDataPtr ( size_t  offset) const
inline

◆ lock()

void* Ogre::v1::GLES2DefaultHardwareIndexBuffer::lock ( size_t  offset,
size_t  length,
LockOptions  options 
)
virtual

Override HardwareBuffer to turn off all shadowing.

Reimplemented from Ogre::v1::HardwareBuffer.

◆ readData()

void Ogre::v1::GLES2DefaultHardwareIndexBuffer::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
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!

Implements Ogre::v1::HardwareBuffer.

◆ unlock()

void Ogre::v1::GLES2DefaultHardwareIndexBuffer::unlock ( )
virtual

Override HardwareBuffer to turn off all shadowing.

Reimplemented from Ogre::v1::HardwareBuffer.

◆ writeData()

void Ogre::v1::GLES2DefaultHardwareIndexBuffer::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
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.

Implements Ogre::v1::HardwareBuffer.


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