OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::GLHardwareVertexBuffer Class Reference

Specialisation of HardwareVertexBuffer for OpenGL. More...

#include <OgreGLHardwareVertexBuffer.h>

+ Inheritance diagram for Ogre::GLHardwareVertexBuffer:
+ Collaboration diagram for Ogre::GLHardwareVertexBuffer:

Public Types

enum  LockOptions {
  HBL_NORMAL, HBL_DISCARD, HBL_READ_ONLY, HBL_NO_OVERWRITE,
  HBL_WRITE_ONLY
}
 Locking options. More...
 
enum  UploadOptions { HBU_DEFAULT = 0x0000, HBU_ON_DEMAND = 0x0001 }
 Device load options The following enum is used to controls how data is loaded to devices in a multi device environment This enum only works with the Direct3D 9 render system (5/2013). 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...
 

Public Member Functions

 GLHardwareVertexBuffer (HardwareBufferManagerBase *mgr, size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage, bool useShadowBuffer)
 
 ~GLHardwareVertexBuffer ()
 
void _updateFromShadow (void)
 See HardwareBuffer. 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 copyData (HardwareBuffer &srcBuffer)
 Copy all data from another buffer into this one. More...
 
GLuint getGLBufferId (void) const
 
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...
 
bool getIsInstanceData () const
 Get if this vertex buffer is an "instance data" buffer (per instance) 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 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...
 
size_t getVertexSize (void) const
 Gets the size in bytes of a single vertex in this buffer. 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...
 
virtual void * lock (size_t offset, size_t length, LockOptions options, UploadOptions uploadOpt=HBU_DEFAULT)
 Lock the buffer for (potentially) reading / writing. More...
 
void * lock (LockOptions options, UploadOptions uploadOpt=HBU_DEFAULT)
 Lock the entire buffer for (potentially) reading / writing. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
void readData (size_t offset, size_t length, void *pDest)
 See HardwareBuffer. 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...
 
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...
 
void writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)
 See HardwareBuffer. More...
 

Protected Member Functions

virtual bool checkIfVertexInstanceDataIsSupported ()
 Checks if vertex instance data is supported by the render system. More...
 
void * lockImpl (size_t offset, size_t length, LockOptions options)
 See HardwareBuffer. More...
 
void unlockImpl (void)
 See HardwareBuffer. More...
 

Protected Attributes

size_t mInstanceDataStepRate
 
bool mIsInstanceData
 
bool mIsLocked
 
size_t mLockSize
 
size_t mLockStart
 
UploadOptions mLockUploadOption
 
HardwareBufferManagerBasemMgr
 
size_t mNumVertices
 
HardwareBuffermShadowBuffer
 
bool mShadowUpdated
 
size_t mSizeInBytes
 
bool mSuppressHardwareUpdate
 
bool mSystemMemory
 
Usage mUsage
 
bool mUseShadowBuffer
 
size_t mVertexSize
 

Private Attributes

GLuint mBufferId
 
bool mLockedToScratch
 
size_t mScratchOffset
 
void * mScratchPtr
 
size_t mScratchSize
 
bool mScratchUploadOnUnlock
 

Detailed Description

Specialisation of HardwareVertexBuffer for OpenGL.

Definition at line 37 of file OgreGLHardwareVertexBuffer.h.

Member Enumeration Documentation

Locking options.

Enumerator
HBL_NORMAL 

Normal mode, ie allows read/write and contents are preserved.

HBL_DISCARD 

Discards the entire buffer while locking; this allows optimisation to be performed because synchronisation issues are relaxed.

Only allowed on buffers created with the HBU_DYNAMIC flag.

HBL_READ_ONLY 

Lock the buffer for reading only.

Not allowed in buffers which are created with HBU_WRITE_ONLY. Mandatory on static buffers, i.e. those created without the HBU_DYNAMIC flag.

HBL_NO_OVERWRITE 

As HBL_DISCARD, except the application guarantees not to overwrite any region of the buffer which has already been used in this frame, can allow some optimisation on some APIs.

HBL_WRITE_ONLY 

Lock the buffer for writing only.

Definition at line 121 of file OgreHardwareBuffer.h.

Device load options The following enum is used to controls how data is loaded to devices in a multi device environment This enum only works with the Direct3D 9 render system (5/2013).

Enumerator
HBU_DEFAULT 
HBU_ON_DEMAND 

Definition at line 146 of file OgreHardwareBuffer.h.

Enums describing buffer usage; not mutually exclusive.

Enumerator
HBU_STATIC 

Static buffer which the application rarely modifies once created.

Modifying the contents of this buffer will involve a performance hit.

HBU_DYNAMIC 

Indicates the application would like to modify this buffer with the CPU fairly often.

Buffers created with this flag will typically end up in AGP memory rather than video memory.

HBU_WRITE_ONLY 

Indicates the application will never read the contents of the buffer back, it will only ever write data.

Locking a buffer with this flag will ALWAYS return a pointer to new, blank memory rather than the memory associated with the contents of the buffer; this avoids DMA stalls because you can write to a new memory area while the previous one is being used.

HBU_DISCARDABLE 

Indicates that the application will be refilling the contents of the buffer regularly (not just updating, but generating the contents from scratch), and therefore does not mind if the contents of the buffer are lost somehow and need to be recreated.

This allows and additional level of optimisation on the buffer. This option only really makes sense when combined with HBU_DYNAMIC_WRITE_ONLY.

HBU_STATIC_WRITE_ONLY 

Combination of HBU_STATIC and HBU_WRITE_ONLY.

HBU_DYNAMIC_WRITE_ONLY 

Combination of HBU_DYNAMIC and HBU_WRITE_ONLY.

If you use this, strongly consider using HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE instead if you update the entire contents of the buffer very regularly.

HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE 

Combination of HBU_DYNAMIC, HBU_WRITE_ONLY and HBU_DISCARDABLE.

Definition at line 79 of file OgreHardwareBuffer.h.

Constructor & Destructor Documentation

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

Member Function Documentation

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

See HardwareBuffer.

Reimplemented from Ogre::HardwareBuffer.

virtual bool Ogre::HardwareVertexBuffer::checkIfVertexInstanceDataIsSupported ( )
protectedvirtualinherited

Checks if vertex instance data is supported by the render system.

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

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 in Ogre::D3D11HardwareBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GL3PlusHardwareShaderStorageBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.

Definition at line 303 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::lock(), and Ogre::HardwareBuffer::unlock().

virtual void Ogre::HardwareBuffer::copyData ( HardwareBuffer srcBuffer)
inlinevirtualinherited

Copy all data from another buffer into this one.

Remarks
Normally these buffers should be of identical size, but if they're not, the routine will use the smallest of the two sizes.

Definition at line 317 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::getSizeInBytes(), and Ogre::min().

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

Definition at line 65 of file OgreGLHardwareVertexBuffer.h.

size_t Ogre::HardwareVertexBuffer::getInstanceDataStepRate ( ) const
inherited

Get the number of instances to draw using the same per-instance data before advancing in the buffer by one element.

bool Ogre::HardwareVertexBuffer::getIsInstanceData ( ) const
inlineinherited

Get if this vertex buffer is an "instance data" buffer (per instance)

Definition at line 72 of file OgreHardwareVertexBuffer.h.

HardwareBufferManagerBase* Ogre::HardwareVertexBuffer::getManager ( ) const
inlineinherited

Return the manager of this buffer, if any.

Definition at line 66 of file OgreHardwareVertexBuffer.h.

size_t Ogre::HardwareVertexBuffer::getNumVertices ( void  ) const
inlineinherited

Get the number of vertices in this buffer.

Definition at line 70 of file OgreHardwareVertexBuffer.h.

size_t Ogre::HardwareBuffer::getSizeInBytes ( void  ) const
inlineinherited

Returns the size of this buffer in bytes.

Definition at line 349 of file OgreHardwareBuffer.h.

Referenced by Ogre::HardwareBuffer::copyData().

Usage Ogre::HardwareBuffer::getUsage ( void  ) const
inlineinherited

Returns the Usage flags with which this buffer was created.

Definition at line 351 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareVertexBuffer::getVertexSize ( void  ) const
inlineinherited

Gets the size in bytes of a single vertex in this buffer.

Definition at line 68 of file OgreHardwareVertexBuffer.h.

bool Ogre::HardwareBuffer::hasShadowBuffer ( void  ) const
inlineinherited

Returns whether this buffer has a system memory shadow for quicker reading.

Definition at line 355 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::isLocked ( void  ) const
inlineinherited

Returns whether or not this buffer is currently locked.

Definition at line 357 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::isSystemMemory ( void  ) const
inlineinherited

Returns whether this buffer is held in system memory.

Definition at line 353 of file OgreHardwareBuffer.h.

void* Ogre::HardwareBuffer::lock ( LockOptions  options,
UploadOptions  uploadOpt = HBU_DEFAULT 
)
inlineinherited

Lock the entire buffer for (potentially) reading / writing.

Parameters
optionsLocking options
Returns
Pointer to the locked memory

Definition at line 239 of file OgreHardwareBuffer.h.

void* Ogre::GLHardwareVertexBuffer::lockImpl ( size_t  offset,
size_t  length,
LockOptions  options 
)
protectedvirtual
template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

void Ogre::GLHardwareVertexBuffer::readData ( size_t  offset,
size_t  length,
void *  pDest 
)
virtual
void Ogre::HardwareVertexBuffer::setInstanceDataStepRate ( const size_t  val)
inherited

Set the number of instances to draw using the same per-instance data before advancing in the buffer by one element.

void Ogre::HardwareVertexBuffer::setIsInstanceData ( const bool  val)
inherited

Set if this vertex buffer is an "instance data" buffer (per instance)

void Ogre::HardwareBuffer::suppressHardwareUpdate ( bool  suppress)
inlineinherited

Pass true to suppress hardware upload of shadow buffer changes.

Definition at line 361 of file OgreHardwareBuffer.h.

virtual void Ogre::HardwareBuffer::unlock ( void  )
inlinevirtualinherited

Releases the lock on this buffer.

Remarks
Locking and unlocking a buffer can, in some rare circumstances such as switching video modes whilst the buffer is locked, corrupt the contents of a buffer. This is pretty rare, but if it occurs, this method will throw an exception, meaning you must re-upload the data.
Note that using the 'read' and 'write' forms of updating the buffer does not suffer from this problem, so if you want to be 100% sure your data will not be lost, use the 'read' and 'write' forms instead.

Reimplemented in Ogre::DefaultHardwareCounterBuffer, Ogre::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.

Definition at line 255 of file OgreHardwareBuffer.h.

Referenced by Ogre::HardwareBuffer::copyData().

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

Member Data Documentation

GLuint Ogre::GLHardwareVertexBuffer::mBufferId
private

Definition at line 40 of file OgreGLHardwareVertexBuffer.h.

size_t Ogre::HardwareVertexBuffer::mInstanceDataStepRate
protectedinherited

Definition at line 56 of file OgreHardwareVertexBuffer.h.

bool Ogre::HardwareVertexBuffer::mIsInstanceData
protectedinherited

Definition at line 55 of file OgreHardwareVertexBuffer.h.

bool Ogre::HardwareBuffer::mIsLocked
protectedinherited

Definition at line 162 of file OgreHardwareBuffer.h.

bool Ogre::GLHardwareVertexBuffer::mLockedToScratch
private

Definition at line 42 of file OgreGLHardwareVertexBuffer.h.

size_t Ogre::HardwareBuffer::mLockSize
protectedinherited

Definition at line 164 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareBuffer::mLockStart
protectedinherited

Definition at line 163 of file OgreHardwareBuffer.h.

UploadOptions Ogre::HardwareBuffer::mLockUploadOption
protectedinherited

Definition at line 165 of file OgreHardwareBuffer.h.

HardwareBufferManagerBase* Ogre::HardwareVertexBuffer::mMgr
protectedinherited

Definition at line 52 of file OgreHardwareVertexBuffer.h.

size_t Ogre::HardwareVertexBuffer::mNumVertices
protectedinherited

Definition at line 53 of file OgreHardwareVertexBuffer.h.

size_t Ogre::GLHardwareVertexBuffer::mScratchOffset
private

Definition at line 43 of file OgreGLHardwareVertexBuffer.h.

void* Ogre::GLHardwareVertexBuffer::mScratchPtr
private

Definition at line 45 of file OgreGLHardwareVertexBuffer.h.

size_t Ogre::GLHardwareVertexBuffer::mScratchSize
private

Definition at line 44 of file OgreGLHardwareVertexBuffer.h.

bool Ogre::GLHardwareVertexBuffer::mScratchUploadOnUnlock
private

Definition at line 46 of file OgreGLHardwareVertexBuffer.h.

HardwareBuffer* Ogre::HardwareBuffer::mShadowBuffer
protectedinherited

Definition at line 168 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::mShadowUpdated
protectedinherited

Definition at line 169 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareBuffer::mSizeInBytes
protectedinherited

Definition at line 160 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::mSuppressHardwareUpdate
protectedinherited

Definition at line 170 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::mSystemMemory
protectedinherited

Definition at line 166 of file OgreHardwareBuffer.h.

Usage Ogre::HardwareBuffer::mUsage
protectedinherited

Definition at line 161 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::mUseShadowBuffer
protectedinherited

Definition at line 167 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareVertexBuffer::mVertexSize
protectedinherited

Definition at line 54 of file OgreHardwareVertexBuffer.h.


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