Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::GLHardwareIndexBuffer Class Reference

#include <OgreGLHardwareIndexBuffer.h>

Inheritance diagram for Ogre::GLHardwareIndexBuffer:

Inheritance graph
[legend]
Collaboration diagram for Ogre::GLHardwareIndexBuffer:

Collaboration graph
[legend]
List of all members.

Public Types

enum  IndexType { IT_16BIT, IT_32BIT }
enum  Usage {
  HBU_STATIC = 1, HBU_DYNAMIC = 2, HBU_WRITE_ONLY = 4, HBU_STATIC_WRITE_ONLY = 5,
  HBU_DYNAMIC_WRITE_ONLY = 6
}
 Enums describing buffer usage; not mutually exclusive. More...

enum  LockOptions { HBL_NORMAL, HBL_DISCARD, HBL_READ_ONLY, HBL_NO_OVERWRITE }
 Locking options. More...


Public Methods

 GLHardwareIndexBuffer (IndexType idxType, size_t numIndexes, HardwareBuffer::Usage usage, bool useShadowBuffer)
 ~GLHardwareIndexBuffer ()
void readData (size_t offset, size_t length, void *pDest)
 See HardwareBuffer.

void writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)
 See HardwareBuffer.

GLuint getGLBufferId (void) const
IndexType getType (void) const
 Get the type of indexes used in this buffer.

size_t getNumIndexes (void) const
 Get the number of indexes in this buffer.

size_t getIndexSize (void) const
 Get the size in bytes of each index.

virtual void * lock (size_t offset, size_t length, LockOptions options)
 Lock the buffer for (potentially) reading / writing.

void * lock (LockOptions options)
 Lock the entire buffer for (potentially) reading / writing.

virtual void unlock (void)
 Releases the lock on this buffer.

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.

virtual void _updateFromShadow (void)
 Updates the real buffer from the shadow buffer, if required.

size_t getSizeInBytes (void) const
 Returns the size of this buffer in bytes.

Usage getUsage (void) const
 Returns the Usage flags with which this buffer was created.

bool isSystemMemory (void) const
 Returns whether this buffer is held in system memory.

bool isLocked (void) const
 Returns whether or not this buffer is currently locked.


Protected Methods

void * lockImpl (size_t offset, size_t length, LockOptions options)
 See HardwareBuffer.

void unlockImpl (void)
 See HardwareBuffer.


Protected Attributes

IndexType mIndexType
size_t mNumIndexes
size_t mIndexSize
size_t mSizeInBytes
Usage mUsage
bool mIsLocked
size_t mLockStart
size_t mLockSize
bool mSystemMemory
bool mUseShadowBuffer
HardwareBuffermpShadowBuffer
bool mShadowUpdated

Private Attributes

GLuint mBufferId

Member Enumeration Documentation

enum Ogre::HardwareIndexBuffer::IndexType [inherited]
 

Enumeration values:
IT_16BIT 
IT_32BIT 

Definition at line 39 of file OgreHardwareIndexBuffer.h.

enum Ogre::HardwareBuffer::LockOptions [inherited]
 

Locking options.

Enumeration values:
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 statuc buffers, ie those created without the HBU_DYNAMIC flag.

HBL_NO_OVERWRITE  As HBL_NORMAL, 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.

Definition at line 96 of file OgreHardwareBuffer.h.

enum Ogre::HardwareBuffer::Usage [inherited]
 

Enums describing buffer usage; not mutually exclusive.

Enumeration values:
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_STATIC_WRITE_ONLY  Combination of HBU_STATIC and HBU_WRITE_ONLY.
HBU_DYNAMIC_WRITE_ONLY  Combination of HBU_DYNAMIC and HBU_WRITE_ONLY.

Definition at line 69 of file OgreHardwareBuffer.h.


Constructor & Destructor Documentation

Ogre::GLHardwareIndexBuffer::GLHardwareIndexBuffer IndexType    idxType,
size_t    numIndexes,
HardwareBuffer::Usage    usage,
bool    useShadowBuffer
 

Definition at line 32 of file OgreGLHardwareIndexBuffer.cpp.

References Except, glBindBufferARB_ptr, glBufferDataARB_ptr, glGenBuffersARB_ptr, mBufferId, and Ogre::HardwareBuffer::mSizeInBytes.

Ogre::GLHardwareIndexBuffer::~GLHardwareIndexBuffer  
 

Definition at line 54 of file OgreGLHardwareIndexBuffer.cpp.

References glDeleteBuffersARB_ptr, and mBufferId.


Member Function Documentation

virtual void Ogre::HardwareBuffer::_updateFromShadow void    [virtual, inherited]
 

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

Definition at line 247 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::lockImpl(), and Ogre::HardwareBuffer::unlockImpl().

virtual void Ogre::HardwareBuffer::copyData HardwareBuffer   srcBuffer,
size_t    srcOffset,
size_t    dstOffset,
size_t    length,
bool    discardWholeBuffer = false
[virtual, inherited]
 

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:
srcBuffer  The buffer from which to read the copied data
srcOffset  Offset in the source buffer at which to start reading
dstOffset  Offset in the destination buffer to start writing
length  Length of the data to copy, in bytes.
discardWholeBuffer  If true, will discard the entire contents of this buffer before copying

Definition at line 237 of file OgreHardwareBuffer.h.

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

GLuint Ogre::GLHardwareIndexBuffer::getGLBufferId void    const
 

Definition at line 53 of file OgreGLHardwareIndexBuffer.h.

References mBufferId.

size_t Ogre::HardwareIndexBuffer::getIndexSize void    const [inherited]
 

Get the size in bytes of each index.

Definition at line 59 of file OgreHardwareIndexBuffer.h.

size_t Ogre::HardwareIndexBuffer::getNumIndexes void    const [inherited]
 

Get the number of indexes in this buffer.

Definition at line 57 of file OgreHardwareIndexBuffer.h.

size_t Ogre::HardwareBuffer::getSizeInBytes void    const [inherited]
 

Returns the size of this buffer in bytes.

Definition at line 272 of file OgreHardwareBuffer.h.

IndexType Ogre::HardwareIndexBuffer::getType void    const [inherited]
 

Get the type of indexes used in this buffer.

Definition at line 55 of file OgreHardwareIndexBuffer.h.

Usage Ogre::HardwareBuffer::getUsage void    const [inherited]
 

Returns the Usage flags with which this buffer was created.

Definition at line 274 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::isLocked void    const [inherited]
 

Returns whether or not this buffer is currently locked.

Definition at line 278 of file OgreHardwareBuffer.h.

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

bool Ogre::HardwareBuffer::isSystemMemory void    const [inherited]
 

Returns whether this buffer is held in system memory.

Definition at line 276 of file OgreHardwareBuffer.h.

void* Ogre::HardwareBuffer::lock LockOptions    options [inherited]
 

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

Parameters:
options  Locking options
Returns:
Pointer to the locked memory

Definition at line 173 of file OgreHardwareBuffer.h.

virtual void* Ogre::HardwareBuffer::lock size_t    offset,
size_t    length,
LockOptions    options
[virtual, inherited]
 

Lock the buffer for (potentially) reading / writing.

Parameters:
offset  The byte offset from the start of the buffer to lock
length  The size of the area to lock, in bytes
options  Locking options
Returns:
Pointer to the locked memory

Reimplemented in Ogre::DefaultHardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareVertexBuffer, and Ogre::GLDefaultHardwareIndexBuffer.

Definition at line 143 of file OgreHardwareBuffer.h.

Referenced by Ogre::HardwareBuffer::copyData(), Ogre::D3D9HardwareVertexBuffer::readData(), Ogre::D3D9HardwareIndexBuffer::readData(), Ogre::D3D9HardwareVertexBuffer::writeData(), and Ogre::D3D9HardwareIndexBuffer::writeData().

void * Ogre::GLHardwareIndexBuffer::lockImpl size_t    offset,
size_t    length,
LockOptions    options
[protected, virtual]
 

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

Definition at line 59 of file OgreGLHardwareIndexBuffer.cpp.

References Except, glBindBufferARB_ptr, glMapBufferARB_ptr, Ogre::HardwareBuffer::HBL_DISCARD, Ogre::HardwareBuffer::HBL_NO_OVERWRITE, Ogre::HardwareBuffer::HBL_NORMAL, Ogre::HardwareBuffer::HBL_READ_ONLY, Ogre::HardwareBuffer::HBU_DYNAMIC, Ogre::HardwareBuffer::HBU_WRITE_ONLY, mBufferId, Ogre::HardwareBuffer::mIsLocked, and Ogre::HardwareBuffer::mUsage.

void Ogre::GLHardwareIndexBuffer::readData size_t    offset,
size_t    length,
void *    pDest
[virtual]
 

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

Definition at line 132 of file OgreGLHardwareIndexBuffer.cpp.

References glBindBufferARB_ptr, glGetBufferSubDataARB_ptr, and mBufferId.

virtual void Ogre::HardwareBuffer::unlock void    [virtual, inherited]
 

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::DefaultHardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareVertexBuffer, and Ogre::GLDefaultHardwareIndexBuffer.

Definition at line 189 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::isLocked().

Referenced by Ogre::HardwareBuffer::copyData(), Ogre::D3D9HardwareVertexBuffer::readData(), Ogre::D3D9HardwareIndexBuffer::readData(), Ogre::D3D9HardwareVertexBuffer::writeData(), and Ogre::D3D9HardwareIndexBuffer::writeData().

void Ogre::GLHardwareIndexBuffer::unlockImpl void    [protected, virtual]
 

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

Definition at line 118 of file OgreGLHardwareIndexBuffer.cpp.

References Except, glBindBufferARB_ptr, glUnmapBufferARB_ptr, mBufferId, and Ogre::HardwareBuffer::mIsLocked.

void Ogre::GLHardwareIndexBuffer::writeData size_t    offset,
size_t    length,
const void *    pSource,
bool    discardWholeBuffer = false
[virtual]
 

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

Definition at line 139 of file OgreGLHardwareIndexBuffer.cpp.

References glBindBufferARB_ptr, glBufferDataARB_ptr, glBufferSubDataARB_ptr, mBufferId, Ogre::HardwareBuffer::mSizeInBytes, and Ogre::HardwareBuffer::mUsage.


Member Data Documentation

GLuint Ogre::GLHardwareIndexBuffer::mBufferId [private]
 

Definition at line 37 of file OgreGLHardwareIndexBuffer.h.

Referenced by getGLBufferId(), GLHardwareIndexBuffer(), lockImpl(), readData(), unlockImpl(), writeData(), and ~GLHardwareIndexBuffer().

size_t Ogre::HardwareIndexBuffer::mIndexSize [protected, inherited]
 

Definition at line 47 of file OgreHardwareIndexBuffer.h.

Referenced by Ogre::HardwareIndexBuffer::HardwareIndexBuffer().

IndexType Ogre::HardwareIndexBuffer::mIndexType [protected, inherited]
 

Definition at line 45 of file OgreHardwareIndexBuffer.h.

Referenced by Ogre::HardwareIndexBuffer::HardwareIndexBuffer().

bool Ogre::HardwareBuffer::mIsLocked [protected, inherited]
 

Definition at line 118 of file OgreHardwareBuffer.h.

Referenced by Ogre::GLDefaultHardwareIndexBuffer::lock(), Ogre::GLDefaultHardwareVertexBuffer::lock(), Ogre::DefaultHardwareIndexBuffer::lock(), Ogre::DefaultHardwareVertexBuffer::lock(), Ogre::GLHardwareVertexBuffer::lockImpl(), lockImpl(), Ogre::GLDefaultHardwareIndexBuffer::unlock(), Ogre::GLDefaultHardwareVertexBuffer::unlock(), Ogre::DefaultHardwareIndexBuffer::unlock(), Ogre::DefaultHardwareVertexBuffer::unlock(), Ogre::GLHardwareVertexBuffer::unlockImpl(), and unlockImpl().

size_t Ogre::HardwareBuffer::mLockSize [protected, inherited]
 

Definition at line 120 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareBuffer::mLockStart [protected, inherited]
 

Definition at line 119 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareIndexBuffer::mNumIndexes [protected, inherited]
 

Definition at line 46 of file OgreHardwareIndexBuffer.h.

Referenced by Ogre::HardwareIndexBuffer::HardwareIndexBuffer().

HardwareBuffer* Ogre::HardwareBuffer::mpShadowBuffer [protected, inherited]
 

Definition at line 123 of file OgreHardwareBuffer.h.

Referenced by Ogre::HardwareIndexBuffer::HardwareIndexBuffer(), Ogre::HardwareVertexBuffer::HardwareVertexBuffer(), Ogre::HardwareIndexBuffer::~HardwareIndexBuffer(), and Ogre::HardwareVertexBuffer::~HardwareVertexBuffer().

bool Ogre::HardwareBuffer::mShadowUpdated [protected, inherited]
 

Definition at line 124 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareBuffer::mSizeInBytes [protected, inherited]
 

Definition at line 116 of file OgreHardwareBuffer.h.

Referenced by Ogre::D3D9HardwareVertexBuffer::D3D9HardwareVertexBuffer(), Ogre::DefaultHardwareIndexBuffer::DefaultHardwareIndexBuffer(), Ogre::DefaultHardwareVertexBuffer::DefaultHardwareVertexBuffer(), Ogre::GLDefaultHardwareIndexBuffer::GLDefaultHardwareIndexBuffer(), Ogre::GLDefaultHardwareVertexBuffer::GLDefaultHardwareVertexBuffer(), GLHardwareIndexBuffer(), Ogre::GLHardwareVertexBuffer::GLHardwareVertexBuffer(), Ogre::HardwareIndexBuffer::HardwareIndexBuffer(), Ogre::HardwareVertexBuffer::HardwareVertexBuffer(), Ogre::GLDefaultHardwareIndexBuffer::readData(), Ogre::GLDefaultHardwareVertexBuffer::readData(), Ogre::DefaultHardwareIndexBuffer::readData(), Ogre::DefaultHardwareVertexBuffer::readData(), Ogre::GLHardwareVertexBuffer::writeData(), writeData(), Ogre::GLDefaultHardwareIndexBuffer::writeData(), Ogre::GLDefaultHardwareVertexBuffer::writeData(), Ogre::DefaultHardwareIndexBuffer::writeData(), and Ogre::DefaultHardwareVertexBuffer::writeData().

bool Ogre::HardwareBuffer::mSystemMemory [protected, inherited]
 

Definition at line 121 of file OgreHardwareBuffer.h.

Usage Ogre::HardwareBuffer::mUsage [protected, inherited]
 

Definition at line 117 of file OgreHardwareBuffer.h.

Referenced by Ogre::GLHardwareVertexBuffer::lockImpl(), lockImpl(), Ogre::D3D9HardwareVertexBuffer::lockImpl(), Ogre::D3D9HardwareIndexBuffer::lockImpl(), Ogre::GLHardwareVertexBuffer::writeData(), and writeData().

bool Ogre::HardwareBuffer::mUseShadowBuffer [protected, inherited]
 

Definition at line 122 of file OgreHardwareBuffer.h.


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

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:12:34 2004