Specialisation of HardwareBuffer for a vertex buffer. More...
#include <OgreHardwareVertexBuffer.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 | |
HardwareVertexBuffer (HardwareBufferManagerBase *mgr, size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer) | |
Should be called by HardwareBufferManager. | |
~HardwareVertexBuffer () | |
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 | getInstanceDataStepRate () const |
Get the number of instances to draw using the same per-instance data before advancing in the buffer by one element. | |
HardwareBufferManagerBase * | getManager () const |
Return the manager of this buffer, if any. | |
size_t | getNumVertices (void) const |
Get the number of vertices in this buffer. | |
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. | |
size_t | getVertexSize (void) const |
Gets the size in bytes of a single vertex in this buffer. | |
bool | hasShadowBuffer (void) const |
Returns whether this buffer has a system memory shadow for quicker reading. | |
bool | isInstanceData () const |
Get if this vertex buffer is an "instance data" buffer (per instance) | |
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, const char *, int, const char *) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
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, void *ptr) |
placement operator new | |
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 | |
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 | 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. | |
void | setIsInstanceData (const bool val) |
Set if this vertex buffer is an "instance data" buffer (per instance) | |
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 bool | checkIfVertexInstanceDataIsSupported () |
Checks if vertex instance data is supported by the render system. | |
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() | |
Specialisation of HardwareBuffer for a vertex buffer.
Definition at line 48 of file OgreHardwareVertexBuffer.h.
|
inherited |
Locking options.
Definition at line 121 of file OgreHardwareBuffer.h.
|
inherited |
Enums describing buffer usage; not mutually exclusive.
Definition at line 79 of file OgreHardwareBuffer.h.
Ogre::HardwareVertexBuffer::HardwareVertexBuffer | ( | HardwareBufferManagerBase * | mgr, |
size_t | vertexSize, | ||
size_t | numVertices, | ||
HardwareBuffer::Usage | usage, | ||
bool | useSystemMemory, | ||
bool | useShadowBuffer | ||
) |
Should be called by HardwareBufferManager.
Ogre::HardwareVertexBuffer::~HardwareVertexBuffer | ( | ) |
Updates the real buffer from the shadow buffer, if required.
Definition at line 305 of file OgreHardwareBuffer.h.
References Ogre::HardwareBuffer::lockImpl(), and Ogre::HardwareBuffer::unlockImpl().
Checks if vertex instance data is supported by the render system.
|
virtualinherited |
Copy all data from another buffer into this one.
Definition at line 298 of file OgreHardwareBuffer.h.
|
virtualinherited |
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.
size_t Ogre::HardwareVertexBuffer::getInstanceDataStepRate | ( | ) | const |
Get the number of instances to draw using the same per-instance data before advancing in the buffer by one element.
HardwareBufferManagerBase * Ogre::HardwareVertexBuffer::getManager | ( | ) | const |
Return the manager of this buffer, if any.
Definition at line 66 of file OgreHardwareVertexBuffer.h.
Get the number of vertices in this buffer.
Definition at line 70 of file OgreHardwareVertexBuffer.h.
Returns the size of this buffer in bytes.
Definition at line 330 of file OgreHardwareBuffer.h.
Returns the Usage flags with which this buffer was created.
Definition at line 332 of file OgreHardwareBuffer.h.
Gets the size in bytes of a single vertex in this buffer.
Definition at line 68 of file OgreHardwareVertexBuffer.h.
Returns whether this buffer has a system memory shadow for quicker reading.
Definition at line 336 of file OgreHardwareBuffer.h.
bool Ogre::HardwareVertexBuffer::isInstanceData | ( | ) | const |
Get if this vertex buffer is an "instance data" buffer (per instance)
Definition at line 72 of file OgreHardwareVertexBuffer.h.
Returns whether or not this buffer is currently locked.
Definition at line 338 of file OgreHardwareBuffer.h.
References Ogre::HardwareBuffer::isLocked().
Referenced by Ogre::HardwareBuffer::isLocked(), and Ogre::HardwareBuffer::unlock().
Returns whether this buffer is held in system memory.
Definition at line 334 of file OgreHardwareBuffer.h.
|
inherited |
Lock the entire buffer for (potentially) reading / writing.
options | Locking options |
Definition at line 220 of file OgreHardwareBuffer.h.
|
virtualinherited |
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, Ogre::DefaultHardwareUniformBuffer, Ogre::DefaultHardwareCounterBuffer, Ogre::HardwarePixelBuffer, and Ogre::HardwarePixelBuffer.
Definition at line 183 of file OgreHardwareBuffer.h.
References Ogre::HardwareBuffer::lock(), and OGRE_EXCEPT.
Referenced by Ogre::HardwareBuffer::lock().
|
protectedpure virtualinherited |
Internal implementation of lock()
Implemented in Ogre::DefaultHardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::DefaultHardwareCounterBuffer, and Ogre::HardwarePixelBuffer.
Referenced by Ogre::HardwareBuffer::_updateFromShadow().
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
pure virtualinherited |
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, Ogre::DefaultHardwareUniformBuffer, Ogre::DefaultHardwareCounterBuffer, and Ogre::HardwarePixelBuffer.
Set the number of instances to draw using the same per-instance data before advancing in the buffer by one element.
Set if this vertex buffer is an "instance data" buffer (per instance)
Pass true to suppress hardware upload of shadow buffer changes.
Definition at line 342 of file OgreHardwareBuffer.h.
Releases the lock on this buffer.
Reimplemented in Ogre::DefaultHardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::DefaultHardwareUniformBuffer, and Ogre::DefaultHardwareCounterBuffer.
Definition at line 236 of file OgreHardwareBuffer.h.
References Ogre::HardwareBuffer::isLocked(), and Ogre::HardwareBuffer::unlock().
Referenced by Ogre::HardwareBuffer::unlock().
Internal implementation of unlock()
Implemented in Ogre::DefaultHardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::DefaultHardwareUniformBuffer, and Ogre::DefaultHardwareCounterBuffer.
Referenced by Ogre::HardwareBuffer::_updateFromShadow().
|
pure virtualinherited |
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, Ogre::DefaultHardwareUniformBuffer, Ogre::DefaultHardwareCounterBuffer, and Ogre::HardwarePixelBuffer.
|
protected |
Definition at line 56 of file OgreHardwareVertexBuffer.h.
|
protected |
Definition at line 55 of file OgreHardwareVertexBuffer.h.
|
protectedinherited |
Definition at line 145 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 147 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 146 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 52 of file OgreHardwareVertexBuffer.h.
|
protected |
Definition at line 53 of file OgreHardwareVertexBuffer.h.
|
protectedinherited |
Definition at line 150 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 151 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 143 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 152 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 148 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 144 of file OgreHardwareBuffer.h.
|
protectedinherited |
Definition at line 149 of file OgreHardwareBuffer.h.
|
protected |
Definition at line 54 of file OgreHardwareVertexBuffer.h.
Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.