OGRE  1.12.12
Object-Oriented Graphics Rendering Engine
Ogre::GLHardwareVertexBuffer Class Reference

Specialisation of HardwareVertexBuffer for OpenGL. More...

#include <OgreGLHardwareBuffer.h>

+ Inheritance diagram for Ogre::GLHardwareVertexBuffer:

Public Member Functions

 GLHardwareVertexBuffer (GLenum target, size_t sizeInBytes, Usage usage, bool useShadowBuffer)
 
 ~GLHardwareVertexBuffer ()
 
void _updateFromShadow (void)
 See HardwareBuffer. More...
 
GLuint getGLBufferId (void) const
 
void readData (size_t offset, size_t length, void *pDest)
 See HardwareBuffer. More...
 
void writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)
 See HardwareBuffer. 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 ()
 
template<typename T >
T * _getImpl ()
 
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...
 
void suppressHardwareUpdate (bool suppress)
 Pass true to suppress hardware upload of shadow buffer changes. More...
 
void unlock (void)
 Releases the lock on this buffer. More...
 

Additional Inherited Members

- 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...
 

Detailed Description

Specialisation of HardwareVertexBuffer for OpenGL.

Constructor & Destructor Documentation

◆ GLHardwareVertexBuffer()

Ogre::GLHardwareVertexBuffer::GLHardwareVertexBuffer ( GLenum  target,
size_t  sizeInBytes,
Usage  usage,
bool  useShadowBuffer 
)

◆ ~GLHardwareVertexBuffer()

Ogre::GLHardwareVertexBuffer::~GLHardwareVertexBuffer ( )

Member Function Documentation

◆ readData()

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

See HardwareBuffer.

Reimplemented from Ogre::HardwareBuffer.

◆ writeData()

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

See HardwareBuffer.

Reimplemented from Ogre::HardwareBuffer.

◆ _updateFromShadow()

void Ogre::GLHardwareVertexBuffer::_updateFromShadow ( void  )
virtual

See HardwareBuffer.

Reimplemented from Ogre::HardwareBuffer.

◆ getGLBufferId()

GLuint Ogre::GLHardwareVertexBuffer::getGLBufferId ( void  ) const
inline

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