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. More... | |
virtual | ~HardwareBuffer () |
virtual void | _updateFromShadow (void) |
Updates the real buffer from the shadow buffer, if required. 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... | |
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... | |
virtual void * | lock (size_t offset, size_t length, LockOptions options) |
Lock the buffer for (potentially) reading / writing. More... | |
void * | lock (LockOptions options) |
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) |
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. 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... | |
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. More... | |
Protected Member Functions | |
virtual void * | lockImpl (size_t offset, size_t length, LockOptions options)=0 |
Internal implementation of lock() More... | |
virtual void | unlockImpl (void)=0 |
Internal implementation of unlock() More... | |
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.
|
inline |
Constructor, to be called by HardwareBufferManager only.
Definition at line 161 of file OgreHardwareBuffer.h.
|
inlinevirtual |
Definition at line 176 of file OgreHardwareBuffer.h.
|
inlinevirtual |
Updates the real buffer from the shadow buffer, if required.
Reimplemented in Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLHardwareVertexBuffer, and Ogre::GLHardwareIndexBuffer.
Definition at line 305 of file OgreHardwareBuffer.h.
|
inlinevirtual |
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 |
Reimplemented in Ogre::D3D11HardwareBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.
Definition at line 284 of file OgreHardwareBuffer.h.
|
inlinevirtual |
Copy all data from another buffer into this one.
Definition at line 298 of file OgreHardwareBuffer.h.
References getSizeInBytes().
|
inline |
Returns the size of this buffer in bytes.
Definition at line 330 of file OgreHardwareBuffer.h.
Referenced by copyData().
|
inline |
Returns the Usage flags with which this buffer was created.
Definition at line 332 of file OgreHardwareBuffer.h.
|
inline |
Returns whether this buffer has a system memory shadow for quicker reading.
Definition at line 336 of file OgreHardwareBuffer.h.
|
inline |
Returns whether or not this buffer is currently locked.
Definition at line 338 of file OgreHardwareBuffer.h.
|
inline |
Returns whether this buffer is held in system memory.
Definition at line 334 of file OgreHardwareBuffer.h.
|
inlinevirtual |
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::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::HardwarePixelBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.
Definition at line 183 of file OgreHardwareBuffer.h.
References Ogre::Exception::ERR_INVALIDPARAMS, and OGRE_EXCEPT.
Referenced by copyData().
|
inline |
Lock the entire buffer for (potentially) reading / writing.
options | Locking options |
Definition at line 220 of file OgreHardwareBuffer.h.
|
protectedpure virtual |
Internal implementation of lock()
Implemented in Ogre::DefaultHardwareCounterBuffer, Ogre::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::D3D9HardwareIndexBuffer, Ogre::D3D9HardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::HardwarePixelBuffer, Ogre::D3D11HardwareBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLHardwareVertexBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GLHardwareIndexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 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::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::HardwarePixelBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::D3D11HardwareBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLHardwareVertexBuffer, Ogre::GLHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, Ogre::D3D11HardwareVertexBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::D3D9HardwareIndexBuffer, and Ogre::D3D9HardwareVertexBuffer.
|
inline |
Pass true to suppress hardware upload of shadow buffer changes.
Definition at line 342 of file OgreHardwareBuffer.h.
|
inlinevirtual |
Releases the lock on this buffer.
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::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.
Definition at line 236 of file OgreHardwareBuffer.h.
Referenced by copyData().
|
protectedpure virtual |
Internal implementation of unlock()
Implemented in Ogre::DefaultHardwareCounterBuffer, Ogre::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::D3D9HardwarePixelBuffer, Ogre::D3D9HardwareIndexBuffer, Ogre::D3D9HardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::D3D11HardwareBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLHardwareVertexBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GLHardwareIndexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, Ogre::GLESHardwarePixelBuffer, Ogre::D3D11HardwareVertexBuffer, Ogre::GL3PlusHardwarePixelBuffer, Ogre::GLES2HardwarePixelBuffer, and Ogre::GLHardwarePixelBuffer.
|
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::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::HardwarePixelBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::D3D11HardwareBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLHardwareVertexBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GLHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, Ogre::D3D11HardwareVertexBuffer, Ogre::D3D9HardwareIndexBuffer, and Ogre::D3D9HardwareVertexBuffer.
|
protected |
Definition at line 145 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 147 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 146 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 150 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 151 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 143 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 152 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 148 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 144 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 149 of file OgreHardwareBuffer.h.