OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::DefaultHardwareIndexBuffer Class Reference

Specialisation of HardwareIndexBuffer for emulation. More...

#include <OgreDefaultHardwareBufferManager.h>

+ Inheritance diagram for Ogre::DefaultHardwareIndexBuffer:

Public Member Functions

 DefaultHardwareIndexBuffer (IndexType idxType, size_t numIndexes, HardwareBuffer::Usage usage)
 
 ~DefaultHardwareIndexBuffer ()
 
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)
 See HardwareBuffer. More...
 
void unlock (void)
 Override HardwareBuffer to turn off all shadowing. More...
 
void writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)
 See HardwareBuffer. More...
 
- Public Member Functions inherited from Ogre::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 (void) const
 Get the size in bytes of each index. More...
 
HardwareBufferManagerBasegetManager () const
 Return the manager of this buffer, if any. More...
 
size_t getNumIndexes (void) const
 Get the number of indexes in this buffer. More...
 
IndexType getType (void) const
 Get the type of indexes used in this buffer. More...
 
- Public Member Functions inherited from Ogre::HardwareBuffer
 HardwareBuffer (Usage usage, bool systemMemory, bool useShadowBuffer)
 Constructor, to be called by HardwareBufferManager only. More...
 
virtual ~HardwareBuffer ()
 
virtual void _updateFromShadow (void)
 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...
 
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...
 
void suppressHardwareUpdate (bool suppress)
 Pass true to suppress hardware upload of shadow buffer changes. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::HardwareIndexBuffer
enum  IndexType { IT_16BIT, IT_32BIT }
 
- Public Types inherited from Ogre::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 = HBU_STATIC | HBU_WRITE_ONLY, HBU_DYNAMIC_WRITE_ONLY = HBU_DYNAMIC | HBU_WRITE_ONLY, HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = HBU_DYNAMIC_WRITE_ONLY | HBU_DISCARDABLE
}
 Enums describing buffer usage; not mutually exclusive. More...
 

Detailed Description

Specialisation of HardwareIndexBuffer for emulation.

Constructor & Destructor Documentation

◆ DefaultHardwareIndexBuffer()

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

◆ ~DefaultHardwareIndexBuffer()

Ogre::DefaultHardwareIndexBuffer::~DefaultHardwareIndexBuffer ( )

Member Function Documentation

◆ readData()

void Ogre::DefaultHardwareIndexBuffer::readData ( size_t  offset,
size_t  length,
void *  pDest 
)
virtual

◆ writeData()

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

◆ lock()

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

Override HardwareBuffer to turn off all shadowing.

Reimplemented from Ogre::HardwareBuffer.

◆ unlock()

void Ogre::DefaultHardwareIndexBuffer::unlock ( void  )
virtual

Override HardwareBuffer to turn off all shadowing.

Reimplemented from Ogre::HardwareBuffer.


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