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

Specialisation of HardwareVertexBuffer for OpenGL ES. More...

#include <OgreGLES2HardwareVertexBuffer.h>

+ Inheritance diagram for Ogre::GLES2HardwareVertexBuffer:

Public Member Functions

 GLES2HardwareVertexBuffer (HardwareBufferManagerBase *mgr, size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage, bool useShadowBuffer)
 
void _updateFromShadow (void)
 Updates the real buffer from the shadow buffer, if required. More...
 
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...
 
GLuint getGLBufferId (void) const
 
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 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::HardwareVertexBuffer
 HardwareVertexBuffer (HardwareBufferManagerBase *mgr, size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer)
 Should be called by HardwareBufferManager. More...
 
 ~HardwareVertexBuffer ()
 
size_t getInstanceDataStepRate () const
 Get the number of instances to draw using the same per-instance data before advancing in the buffer by one element. More...
 
HardwareBufferManagerBasegetManager () const
 Return the manager of this buffer, if any. More...
 
size_t getNumVertices (void) const
 Get the number of vertices in this buffer. More...
 
size_t getVertexSize (void) const
 Gets the size in bytes of a single vertex in this buffer. More...
 
bool isInstanceData () const
 Get if this vertex buffer is an "instance data" buffer (per instance) More...
 
void setInstanceDataStepRate (const size_t val)
 Set the number of instances to draw using the same per-instance data before advancing in the buffer by one element. More...
 
void setIsInstanceData (const bool val)
 Set if this vertex buffer is an "instance data" buffer (per instance) 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 copyData (HardwareBuffer &srcBuffer)
 Copy all 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...
 
virtual 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 ES.

Constructor & Destructor Documentation

◆ GLES2HardwareVertexBuffer()

Ogre::GLES2HardwareVertexBuffer::GLES2HardwareVertexBuffer ( HardwareBufferManagerBase mgr,
size_t  vertexSize,
size_t  numVertices,
HardwareBuffer::Usage  usage,
bool  useShadowBuffer 
)

Member Function Documentation

◆ readData()

void Ogre::GLES2HardwareVertexBuffer::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::HardwareBuffer.

◆ writeData()

void Ogre::GLES2HardwareVertexBuffer::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::HardwareBuffer.

◆ copyData()

void Ogre::GLES2HardwareVertexBuffer::copyData ( HardwareBuffer srcBuffer,
size_t  srcOffset,
size_t  dstOffset,
size_t  length,
bool  discardWholeBuffer = false 
)
virtual

Copy data from another buffer into this one.

Remarks
Note that the source buffer must not be created with the usage HBU_WRITE_ONLY otherwise this will fail.
Parameters
srcBufferThe buffer from which to read the copied data
srcOffsetOffset in the source buffer at which to start reading
dstOffsetOffset in the destination buffer to start writing
lengthLength of the data to copy, in bytes.
discardWholeBufferIf true, will discard the entire contents of this buffer before copying

Reimplemented from Ogre::HardwareBuffer.

◆ _updateFromShadow()

void Ogre::GLES2HardwareVertexBuffer::_updateFromShadow ( void  )
virtual

Updates the real buffer from the shadow buffer, if required.

Reimplemented from Ogre::HardwareBuffer.

◆ getGLBufferId()

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

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