OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::HardwareIndexBuffer Class Reference

Specialisation of HardwareBuffer for vertex index buffers, still abstract. More...

#include <OgreHardwareIndexBuffer.h>

+ Inheritance diagram for Ogre::HardwareIndexBuffer:

Public Types

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...
 
typedef int Usage
 
enum  UsageEnum {
  HBU_STATIC = HBU_GPU_TO_CPU, HBU_DYNAMIC = HBU_CPU_ONLY, HBU_WRITE_ONLY = HBU_DETAIL_WRITE_ONLY, HBU_DISCARDABLE = 8,
  HBU_STATIC_WRITE_ONLY = HBU_GPU_ONLY, HBU_DYNAMIC_WRITE_ONLY = HBU_CPU_TO_GPU, HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = HBU_CPU_TO_GPU
}
 Rather use HardwareBufferUsage. More...
 

Public Member Functions

 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...
 
virtual void * lock (size_t offset, size_t length, LockOptions options)
 Lock the buffer for (potentially) reading / writing. More...
 
virtual void readData (size_t offset, size_t length, void *pDest)=0
 Reads data from the buffer and places it in the memory pointed to by pDest. More...
 
void suppressHardwareUpdate (bool suppress)
 Pass true to suppress hardware upload of shadow buffer changes. More...
 
virtual void unlock (void)
 Releases the lock on this buffer. More...
 
virtual void writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)=0
 Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough. More...
 

Detailed Description

Specialisation of HardwareBuffer for vertex index buffers, still abstract.

Member Enumeration Documentation

◆ IndexType

Enumerator
IT_16BIT 
IT_32BIT 

Constructor & Destructor Documentation

◆ HardwareIndexBuffer()

Ogre::HardwareIndexBuffer::HardwareIndexBuffer ( HardwareBufferManagerBase mgr,
IndexType  idxType,
size_t  numIndexes,
HardwareBuffer::Usage  usage,
bool  useSystemMemory,
bool  useShadowBuffer 
)

Should be called by HardwareBufferManager.

◆ ~HardwareIndexBuffer()

Ogre::HardwareIndexBuffer::~HardwareIndexBuffer ( )

Member Function Documentation

◆ getManager()

HardwareBufferManagerBase* Ogre::HardwareIndexBuffer::getManager ( ) const
inline

Return the manager of this buffer, if any.

◆ getType()

IndexType Ogre::HardwareIndexBuffer::getType ( void  ) const
inline

Get the type of indexes used in this buffer.

◆ getNumIndexes()

size_t Ogre::HardwareIndexBuffer::getNumIndexes ( void  ) const
inline

Get the number of indexes in this buffer.

◆ getIndexSize()

size_t Ogre::HardwareIndexBuffer::getIndexSize ( void  ) const
inline

Get the size in bytes of each index.


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