|
OGRE
1.9.0
|
Abstract class defining common features of hardware buffers. More...
#include <OgreHardwareBuffer.h>

Public Types | |
| enum | LockOptions { HBL_NORMAL , HBL_DISCARD , HBL_READ_ONLY , HBL_NO_OVERWRITE , HBL_WRITE_ONLY } |
| Locking options. 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 | |
| HardwareBuffer (Usage usage, bool systemMemory, bool useShadowBuffer) | |
| Constructor, to be called by HardwareBufferManager only. | |
| virtual | ~HardwareBuffer () |
| virtual void | _updateFromShadow (void) |
| Updates the real buffer from the shadow buffer, if required. | |
| virtual void | copyData (HardwareBuffer &srcBuffer) |
| Copy all data from another buffer into this one. | |
| 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. | |
| 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 | 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. | |
| bool | isSystemMemory (void) const |
| Returns whether this buffer is held in system memory. | |
| void * | lock (LockOptions options) |
| Lock the entire buffer for (potentially) reading / writing. | |
| virtual void * | lock (size_t offset, size_t length, LockOptions options) |
| Lock the buffer for (potentially) reading / writing. | |
| void | operator delete (void *ptr) |
| void | operator delete (void *ptr) |
| void | operator delete (void *ptr, const char *, int, const char *) |
| void | operator delete (void *ptr, const char *, int, const char *) |
| void | operator delete (void *ptr, void *) |
| void | operator delete (void *ptr, void *) |
| void | operator delete[] (void *ptr) |
| void | operator delete[] (void *ptr) |
| void | operator delete[] (void *ptr, const char *, int, const char *) |
| void | operator delete[] (void *ptr, const char *, int, const char *) |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz) |
| void * | operator new (size_t sz, const char *file, int line, const char *func) |
| operator new, with debug line info | |
| void * | operator new (size_t sz, const char *file, int line, const char *func) |
| operator new, with debug line info | |
| void * | operator new (size_t sz, void *ptr) |
| placement operator new | |
| void * | operator new (size_t sz, void *ptr) |
| placement operator new | |
| void * | operator new[] (size_t sz) |
| void * | operator new[] (size_t sz) |
| void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
| array operator new, with debug line info | |
| void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
| array operator new, with debug line info | |
| 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. | |
| void | suppressHardwareUpdate (bool suppress) |
| Pass true to suppress hardware upload of shadow buffer changes. | |
| virtual void | unlock (void) |
| Releases the lock on this buffer. | |
| 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. | |
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 | |
| bool | mIsLocked |
| size_t | mLockSize |
| size_t | mLockStart |
| HardwareBuffer * | mShadowBuffer |
| bool | mShadowUpdated |
| size_t | mSizeInBytes |
| bool | mSuppressHardwareUpdate |
| bool | mSystemMemory |
| Usage | mUsage |
| bool | mUseShadowBuffer |
Abstract class defining common features of hardware buffers.
Definition at line 74 of file OgreHardwareBuffer.h.
Locking options.
Definition at line 121 of file OgreHardwareBuffer.h.
Enums describing buffer usage; not mutually exclusive.
Definition at line 79 of file OgreHardwareBuffer.h.
| Ogre::HardwareBuffer::HardwareBuffer | ( | Usage | usage, |
| bool | systemMemory, | ||
| bool | useShadowBuffer ) |
Constructor, to be called by HardwareBufferManager only.
Definition at line 161 of file OgreHardwareBuffer.h.
References HBU_DYNAMIC, HBU_DYNAMIC_WRITE_ONLY, HBU_STATIC, HBU_STATIC_WRITE_ONLY, mIsLocked, mLockSize, mLockStart, mShadowBuffer, mShadowUpdated, mSuppressHardwareUpdate, mSystemMemory, mUsage, and mUseShadowBuffer.
Referenced by copyData(), and copyData().
|
virtual |
Definition at line 176 of file OgreHardwareBuffer.h.
|
virtual |
Updates the real buffer from the shadow buffer, if required.
Definition at line 305 of file OgreHardwareBuffer.h.
References HBL_DISCARD, HBL_NORMAL, HBL_READ_ONLY, lockImpl(), mLockSize, mLockStart, mShadowBuffer, mShadowUpdated, mSizeInBytes, mSuppressHardwareUpdate, mUseShadowBuffer, and unlockImpl().
Referenced by suppressHardwareUpdate(), and unlock().
|
virtual |
Copy all data from another buffer into this one.
Definition at line 298 of file OgreHardwareBuffer.h.
References HardwareBuffer(), copyData(), and getSizeInBytes().
|
virtual |
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 284 of file OgreHardwareBuffer.h.
References HardwareBuffer(), HBL_READ_ONLY, lock(), unlock(), and writeData().
Referenced by copyData().
| size_t Ogre::HardwareBuffer::getSizeInBytes | ( | void | ) | const |
Returns the size of this buffer in bytes.
Definition at line 330 of file OgreHardwareBuffer.h.
References mSizeInBytes.
Referenced by copyData().
| Usage Ogre::HardwareBuffer::getUsage | ( | void | ) | const |
Returns the Usage flags with which this buffer was created.
Definition at line 332 of file OgreHardwareBuffer.h.
References mUsage.
| bool Ogre::HardwareBuffer::hasShadowBuffer | ( | void | ) | const |
Returns whether this buffer has a system memory shadow for quicker reading.
Definition at line 336 of file OgreHardwareBuffer.h.
References mUseShadowBuffer.
| bool Ogre::HardwareBuffer::isLocked | ( | void | ) | const |
Returns whether or not this buffer is currently locked.
Definition at line 338 of file OgreHardwareBuffer.h.
References mIsLocked, mShadowBuffer, and mUseShadowBuffer.
| bool Ogre::HardwareBuffer::isSystemMemory | ( | void | ) | const |
Returns whether this buffer is held in system memory.
Definition at line 334 of file OgreHardwareBuffer.h.
References mSystemMemory.
| void * Ogre::HardwareBuffer::lock | ( | LockOptions | options | ) |
Lock the entire buffer for (potentially) reading / writing.
| options | Locking options |
Definition at line 220 of file OgreHardwareBuffer.h.
References lock(), and mSizeInBytes.
|
virtual |
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::DefaultHardwareCounterBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::DefaultHardwareVertexBuffer, and Ogre::HardwarePixelBuffer.
Definition at line 183 of file OgreHardwareBuffer.h.
References Ogre::Exception::ERR_INVALIDPARAMS, HBL_READ_ONLY, isLocked(), lockImpl(), mIsLocked, mLockSize, mLockStart, mShadowBuffer, mShadowUpdated, mSizeInBytes, mUseShadowBuffer, and OGRE_EXCEPT.
Referenced by Ogre::HardwarePixelBuffer::~HardwarePixelBuffer(), copyData(), and lock().
|
protectedpure virtual |
Internal implementation of lock()
Implemented in Ogre::DefaultHardwareCounterBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::DefaultHardwareVertexBuffer, and Ogre::HardwarePixelBuffer.
Referenced by _updateFromShadow(), and lock().
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
pure virtual |
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::DefaultHardwareCounterBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::DefaultHardwareVertexBuffer, and Ogre::HardwarePixelBuffer.
| void Ogre::HardwareBuffer::suppressHardwareUpdate | ( | bool | suppress | ) |
Pass true to suppress hardware upload of shadow buffer changes.
Definition at line 342 of file OgreHardwareBuffer.h.
References _updateFromShadow(), and mSuppressHardwareUpdate.
|
virtual |
Releases the lock on this buffer.
Reimplemented in Ogre::DefaultHardwareCounterBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::DefaultHardwareUniformBuffer, and Ogre::DefaultHardwareVertexBuffer.
Definition at line 236 of file OgreHardwareBuffer.h.
References _updateFromShadow(), isLocked(), mIsLocked, mShadowBuffer, mUseShadowBuffer, and unlockImpl().
Referenced by copyData().
|
protectedpure virtual |
Internal implementation of unlock()
Implemented in Ogre::DefaultHardwareCounterBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::DefaultHardwareUniformBuffer, and Ogre::DefaultHardwareVertexBuffer.
Referenced by _updateFromShadow(), and unlock().
|
pure virtual |
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::DefaultHardwareCounterBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::DefaultHardwareVertexBuffer, and Ogre::HardwarePixelBuffer.
Referenced by copyData().
|
protected |
Definition at line 145 of file OgreHardwareBuffer.h.
Referenced by HardwareBuffer(), isLocked(), lock(), and unlock().
|
protected |
Definition at line 147 of file OgreHardwareBuffer.h.
Referenced by HardwareBuffer(), _updateFromShadow(), and lock().
|
protected |
Definition at line 146 of file OgreHardwareBuffer.h.
Referenced by HardwareBuffer(), _updateFromShadow(), and lock().
|
protected |
Definition at line 150 of file OgreHardwareBuffer.h.
Referenced by HardwareBuffer(), _updateFromShadow(), isLocked(), lock(), and unlock().
|
protected |
Definition at line 151 of file OgreHardwareBuffer.h.
Referenced by HardwareBuffer(), _updateFromShadow(), and lock().
|
protected |
Definition at line 143 of file OgreHardwareBuffer.h.
Referenced by _updateFromShadow(), getSizeInBytes(), lock(), and lock().
|
protected |
Definition at line 152 of file OgreHardwareBuffer.h.
Referenced by HardwareBuffer(), _updateFromShadow(), and suppressHardwareUpdate().
|
protected |
Definition at line 148 of file OgreHardwareBuffer.h.
Referenced by HardwareBuffer(), and isSystemMemory().
|
protected |
Definition at line 144 of file OgreHardwareBuffer.h.
Referenced by HardwareBuffer(), and getUsage().
|
protected |
Definition at line 149 of file OgreHardwareBuffer.h.
Referenced by HardwareBuffer(), _updateFromShadow(), hasShadowBuffer(), isLocked(), lock(), and unlock().
1.13.2