#include <OgreHardwareVertexBuffer.h>
Public Types | |
| 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... | |
| enum | LockOptions { HBL_NORMAL, HBL_DISCARD, HBL_READ_ONLY, HBL_NO_OVERWRITE } |
| Locking options. More... | |
Public Member Functions | |
| HardwareVertexBuffer (size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer) | |
| Should be called by HardwareBufferManager. | |
| ~HardwareVertexBuffer () | |
| size_t | getVertexSize (void) const |
| Gets the size in bytes of a single vertex in this buffer. | |
| size_t | getNumVertices (void) const |
| Get the number of vertices in this buffer. | |
| 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 | 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. | |
| 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. | |
| 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 | hasShadowBuffer (void) const |
| Returns whether this buffer has a system memory shadow for quicker reading. | |
| bool | isLocked (void) const |
| Returns whether or not this buffer is currently locked. | |
| void | suppressHardwareUpdate (bool suppress) |
| Pass true to suppress hardware upload of shadow buffer changes. | |
Protected Member Functions | |
| virtual void * | lockImpl (size_t offset, size_t length, LockOptions options)=0 |
| Internal implementation of lock(). | |
| virtual void | unlockImpl (void)=0 |
| Internal implementation of unlock(). | |
Protected Attributes | |
| size_t | mNumVertices |
| size_t | mVertexSize |
| size_t | mSizeInBytes |
| Usage | mUsage |
| bool | mIsLocked |
| size_t | mLockStart |
| size_t | mLockSize |
| bool | mSystemMemory |
| bool | mUseShadowBuffer |
| HardwareBuffer * | mpShadowBuffer |
| bool | mShadowUpdated |
| bool | mSuppressHardwareUpdate |
Definition at line 40 of file OgreHardwareVertexBuffer.h.
enum Ogre::HardwareBuffer::Usage [inherited] |
Enums describing buffer usage; not mutually exclusive.
Definition at line 73 of file OgreHardwareBuffer.h.
enum Ogre::HardwareBuffer::LockOptions [inherited] |
Locking options.
Definition at line 115 of file OgreHardwareBuffer.h.
| Ogre::HardwareVertexBuffer::HardwareVertexBuffer | ( | size_t | vertexSize, | |
| size_t | numVertices, | |||
| HardwareBuffer::Usage | usage, | |||
| bool | useSystemMemory, | |||
| bool | useShadowBuffer | |||
| ) |
Should be called by HardwareBufferManager.
| Ogre::HardwareVertexBuffer::~HardwareVertexBuffer | ( | ) |
| size_t Ogre::HardwareVertexBuffer::getVertexSize | ( | void | ) | const |
Gets the size in bytes of a single vertex in this buffer.
Definition at line 53 of file OgreHardwareVertexBuffer.h.
| size_t Ogre::HardwareVertexBuffer::getNumVertices | ( | void | ) | const |
Get the number of vertices in this buffer.
Definition at line 55 of file OgreHardwareVertexBuffer.h.
| virtual void* Ogre::HardwareBuffer::lockImpl | ( | size_t | offset, | |
| size_t | length, | |||
| LockOptions | options | |||
| ) | [protected, pure virtual, inherited] |
Internal implementation of lock().
Implemented in Ogre::DefaultHardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, and Ogre::HardwarePixelBuffer.
| virtual void Ogre::HardwareBuffer::unlockImpl | ( | void | ) | [protected, pure virtual, inherited] |
Internal implementation of unlock().
Implemented in Ogre::DefaultHardwareVertexBuffer, and Ogre::DefaultHardwareIndexBuffer.
| virtual void* Ogre::HardwareBuffer::lock | ( | size_t | offset, | |
| size_t | length, | |||
| LockOptions | options | |||
| ) | [virtual, inherited] |
Lock the buffer for (potentially) reading / writing.
| 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 |
Reimplemented in Ogre::DefaultHardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, and Ogre::HardwarePixelBuffer.
Definition at line 175 of file OgreHardwareBuffer.h.
Referenced by Ogre::HardwareBuffer::copyData().
| void* Ogre::HardwareBuffer::lock | ( | LockOptions | options | ) | [inherited] |
Lock the entire buffer for (potentially) reading / writing.
| options | Locking options |
Definition at line 205 of file OgreHardwareBuffer.h.
| virtual void Ogre::HardwareBuffer::unlock | ( | void | ) | [virtual, inherited] |
Releases the lock on this buffer.
Reimplemented in Ogre::DefaultHardwareVertexBuffer, and Ogre::DefaultHardwareIndexBuffer.
Definition at line 221 of file OgreHardwareBuffer.h.
Referenced by Ogre::HardwareBuffer::copyData().
| virtual void Ogre::HardwareBuffer::readData | ( | size_t | offset, | |
| size_t | length, | |||
| void * | pDest | |||
| ) | [pure virtual, inherited] |
Reads data from the buffer and places it in the memory pointed to by pDest.
| offset | The byte offset from the start of the buffer to read | |
| length | The size of the area to read, in bytes | |
| pDest | The area of memory in which to place the data, must be large enough to accommodate the data! |
Implemented in Ogre::DefaultHardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, and Ogre::HardwarePixelBuffer.
| virtual void Ogre::HardwareBuffer::writeData | ( | size_t | offset, | |
| size_t | length, | |||
| const void * | pSource, | |||
| bool | discardWholeBuffer = false | |||
| ) | [pure virtual, inherited] |
Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough.
| offset | The byte offset from the start of the buffer to start writing | |
| length | The size of the data to write to, in bytes | |
| pSource | The source of the data to be written | |
| discardWholeBuffer | If true, this allows the driver to discard the entire buffer when writing, such that DMA stalls can be avoided; use if you can. |
Implemented in Ogre::DefaultHardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, and Ogre::HardwarePixelBuffer.
| 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.
| 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 269 of file OgreHardwareBuffer.h.
References Ogre::HardwareBuffer::lock(), and Ogre::HardwareBuffer::unlock().
| virtual void Ogre::HardwareBuffer::_updateFromShadow | ( | void | ) | [virtual, inherited] |
Updates the real buffer from the shadow buffer, if required.
Definition at line 279 of file OgreHardwareBuffer.h.
| size_t Ogre::HardwareBuffer::getSizeInBytes | ( | void | ) | const [inherited] |
| Usage Ogre::HardwareBuffer::getUsage | ( | void | ) | const [inherited] |
Returns the Usage flags with which this buffer was created.
Definition at line 306 of file OgreHardwareBuffer.h.
| bool Ogre::HardwareBuffer::isSystemMemory | ( | void | ) | const [inherited] |
Returns whether this buffer is held in system memory.
Definition at line 308 of file OgreHardwareBuffer.h.
| bool Ogre::HardwareBuffer::hasShadowBuffer | ( | void | ) | const [inherited] |
Returns whether this buffer has a system memory shadow for quicker reading.
Definition at line 310 of file OgreHardwareBuffer.h.
| bool Ogre::HardwareBuffer::isLocked | ( | void | ) | const [inherited] |
Returns whether or not this buffer is currently locked.
Definition at line 312 of file OgreHardwareBuffer.h.
| void Ogre::HardwareBuffer::suppressHardwareUpdate | ( | bool | suppress | ) | [inherited] |
Pass true to suppress hardware upload of shadow buffer changes.
Definition at line 316 of file OgreHardwareBuffer.h.
size_t Ogre::HardwareVertexBuffer::mNumVertices [protected] |
Definition at line 44 of file OgreHardwareVertexBuffer.h.
size_t Ogre::HardwareVertexBuffer::mVertexSize [protected] |
Definition at line 45 of file OgreHardwareVertexBuffer.h.
size_t Ogre::HardwareBuffer::mSizeInBytes [protected, inherited] |
Definition at line 135 of file OgreHardwareBuffer.h.
Usage Ogre::HardwareBuffer::mUsage [protected, inherited] |
Definition at line 136 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::mIsLocked [protected, inherited] |
Definition at line 137 of file OgreHardwareBuffer.h.
size_t Ogre::HardwareBuffer::mLockStart [protected, inherited] |
Definition at line 138 of file OgreHardwareBuffer.h.
size_t Ogre::HardwareBuffer::mLockSize [protected, inherited] |
Definition at line 139 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::mSystemMemory [protected, inherited] |
Definition at line 140 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::mUseShadowBuffer [protected, inherited] |
Definition at line 141 of file OgreHardwareBuffer.h.
HardwareBuffer* Ogre::HardwareBuffer::mpShadowBuffer [protected, inherited] |
Definition at line 142 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::mShadowUpdated [protected, inherited] |
Definition at line 143 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::mSuppressHardwareUpdate [protected, inherited] |
Definition at line 144 of file OgreHardwareBuffer.h.
Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Mon Jun 16 12:49:58 2008