Specialisation of HardwareBuffer for a vertex buffer. More...
#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 (HardwareBufferManagerBase *mgr, size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer) | |
Should be called by HardwareBufferManager. | |
~HardwareVertexBuffer () | |
HardwareBufferManagerBase * | getManager () const |
Return the manager of this buffer, if any. | |
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. | |
bool | getIsInstanceData () const |
Get if this vertex buffer is an "instance data" buffer (per instance) | |
void | setIsInstanceData (const bool val) |
Set if this vertex buffer is an "instance data" buffer (per instance) | |
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. | |
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. | |
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 | copyData (HardwareBuffer &srcBuffer) |
Copy all 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. | |
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 * | operator new (size_t sz, void *ptr) |
placement operator new | |
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) |
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 *) |
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() | |
Protected Attributes | |
HardwareBufferManagerBase * | mMgr |
size_t | mNumVertices |
size_t | mVertexSize |
bool | mIsInstanceData |
size_t | mInstanceDataStepRate |
size_t | mSizeInBytes |
Usage | mUsage |
bool | mIsLocked |
size_t | mLockStart |
size_t | mLockSize |
bool | mSystemMemory |
bool | mUseShadowBuffer |
HardwareBuffer * | mShadowBuffer |
bool | mShadowUpdated |
bool | mSuppressHardwareUpdate |
Specialisation of HardwareBuffer for a vertex buffer.
Definition at line 47 of file OgreHardwareVertexBuffer.h.
enum Ogre::HardwareBuffer::LockOptions [inherited] |
Locking options.
Definition at line 121 of file OgreHardwareBuffer.h.
enum Ogre::HardwareBuffer::Usage [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.
virtual void Ogre::HardwareBuffer::_updateFromShadow | ( | void | ) | [virtual, inherited] |
Updates the real buffer from the shadow buffer, if required.
Reimplemented in Ogre::GLESHardwareVertexBuffer, Ogre::GLES2HardwareVertexBuffer, Ogre::GLESHardwareIndexBuffer, Ogre::GLES2HardwareIndexBuffer, Ogre::GLHardwareVertexBuffer, and Ogre::GLHardwareIndexBuffer.
Definition at line 303 of file OgreHardwareBuffer.h.
virtual bool Ogre::HardwareVertexBuffer::checkIfVertexInstanceDataIsSupported | ( | ) | [protected, virtual] |
Checks if vertex instance data is supported by the render system.
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 |
Reimplemented in Ogre::D3D11HardwareBuffer, Ogre::D3D11HardwareIndexBuffer, and Ogre::D3D11HardwareVertexBuffer.
Definition at line 282 of file OgreHardwareBuffer.h.
References Ogre::HardwareBuffer::lock(), and Ogre::HardwareBuffer::unlock().
virtual void Ogre::HardwareBuffer::copyData | ( | HardwareBuffer & | srcBuffer | ) | [virtual, inherited] |
Copy all data from another buffer into this one.
Definition at line 296 of file OgreHardwareBuffer.h.
References Ogre::HardwareBuffer::getSizeInBytes().
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.
bool Ogre::HardwareVertexBuffer::getIsInstanceData | ( | ) | const |
Get if this vertex buffer is an "instance data" buffer (per instance)
Definition at line 71 of file OgreHardwareVertexBuffer.h.
Return the manager of this buffer, if any.
Definition at line 65 of file OgreHardwareVertexBuffer.h.
size_t Ogre::HardwareVertexBuffer::getNumVertices | ( | void | ) | const |
Get the number of vertices in this buffer.
Definition at line 69 of file OgreHardwareVertexBuffer.h.
size_t Ogre::HardwareBuffer::getSizeInBytes | ( | void | ) | const [inherited] |
Returns the size of this buffer in bytes.
Definition at line 328 of file OgreHardwareBuffer.h.
Referenced by Ogre::HardwareBuffer::copyData().
Usage Ogre::HardwareBuffer::getUsage | ( | void | ) | const [inherited] |
Returns the Usage flags with which this buffer was created.
Definition at line 330 of file OgreHardwareBuffer.h.
size_t Ogre::HardwareVertexBuffer::getVertexSize | ( | void | ) | const |
Gets the size in bytes of a single vertex in this buffer.
Definition at line 67 of file OgreHardwareVertexBuffer.h.
bool Ogre::HardwareBuffer::hasShadowBuffer | ( | void | ) | const [inherited] |
Returns whether this buffer has a system memory shadow for quicker reading.
Definition at line 334 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::isLocked | ( | void | ) | const [inherited] |
Returns whether or not this buffer is currently locked.
Reimplemented in Ogre::D3D11HardwareIndexBuffer, and Ogre::D3D11HardwareVertexBuffer.
Definition at line 336 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::isSystemMemory | ( | void | ) | const [inherited] |
Returns whether this buffer is held in system memory.
Definition at line 332 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.
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::HardwarePixelBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, and Ogre::D3D11HardwareVertexBuffer.
Definition at line 181 of file OgreHardwareBuffer.h.
References Ogre::Exception::ERR_INVALIDPARAMS.
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 218 of file OgreHardwareBuffer.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::D3D9HardwareIndexBuffer, Ogre::D3D9HardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::HardwarePixelBuffer, Ogre::D3D11HardwareBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLESHardwareVertexBuffer, Ogre::GLHardwareVertexBuffer, Ogre::GLESHardwareIndexBuffer, Ogre::GLES2HardwareVertexBuffer, Ogre::GLHardwareIndexBuffer, Ogre::GLES2HardwareIndexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, and Ogre::D3D11HardwareVertexBuffer.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr | ) | [inherited] |
Definition at line 95 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
void * | |||
) | [inherited] |
Definition at line 101 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete | ( | void * | ptr, |
const char * | , | ||
int | , | ||
const char * | |||
) | [inherited] |
Definition at line 107 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr | ) | [inherited] |
Definition at line 112 of file OgreMemoryAllocatedObject.h.
void Ogre::AllocatedObject< Alloc >::operator delete[] | ( | void * | ptr, |
const char * | , | ||
int | , | ||
const char * | |||
) | [inherited] |
Definition at line 118 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, |
const char * | file, | ||
int | line, | ||
const char * | func | ||
) | [inherited] |
operator new, with debug line info
Definition at line 67 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz | ) | [inherited] |
Definition at line 72 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new | ( | size_t | sz, |
void * | ptr | ||
) | [inherited] |
placement operator new
Definition at line 78 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz, |
const char * | file, | ||
int | line, | ||
const char * | func | ||
) | [inherited] |
array operator new, with debug line info
Definition at line 85 of file OgreMemoryAllocatedObject.h.
void* Ogre::AllocatedObject< Alloc >::operator new[] | ( | size_t | sz | ) | [inherited] |
Definition at line 90 of file OgreMemoryAllocatedObject.h.
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::HardwarePixelBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::D3D11HardwareBuffer, Ogre::GLESHardwareVertexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLESHardwareIndexBuffer, Ogre::GLES2HardwareVertexBuffer, Ogre::GLES2HardwareIndexBuffer, Ogre::GLHardwareVertexBuffer, Ogre::GLHardwareIndexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareVertexBuffer, Ogre::D3D9HardwareIndexBuffer, and Ogre::D3D9HardwareVertexBuffer.
void Ogre::HardwareVertexBuffer::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 Ogre::HardwareVertexBuffer::setIsInstanceData | ( | const bool | val | ) |
Set if this vertex buffer is an "instance data" buffer (per instance)
void Ogre::HardwareBuffer::suppressHardwareUpdate | ( | bool | suppress | ) | [inherited] |
Pass true to suppress hardware upload of shadow buffer changes.
Definition at line 340 of file OgreHardwareBuffer.h.
virtual void Ogre::HardwareBuffer::unlock | ( | void | ) | [virtual, inherited] |
Releases the lock on this buffer.
Reimplemented in Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, and Ogre::D3D11HardwareVertexBuffer.
Definition at line 234 of file OgreHardwareBuffer.h.
Referenced by Ogre::HardwareBuffer::copyData().
virtual void Ogre::HardwareBuffer::unlockImpl | ( | void | ) | [protected, pure virtual, inherited] |
Internal implementation of unlock()
Implemented in Ogre::D3D9HardwareIndexBuffer, Ogre::D3D9HardwarePixelBuffer, Ogre::D3D9HardwareVertexBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::D3D11HardwareBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLESHardwareVertexBuffer, Ogre::GLHardwareVertexBuffer, Ogre::GLESHardwareIndexBuffer, Ogre::GLES2HardwareVertexBuffer, Ogre::GLHardwareIndexBuffer, Ogre::GLES2HardwareIndexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::GLESHardwarePixelBuffer, Ogre::D3D11HardwareVertexBuffer, Ogre::GLES2HardwarePixelBuffer, and Ogre::GLHardwarePixelBuffer.
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::HardwarePixelBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::D3D11HardwareBuffer, Ogre::GLESHardwareVertexBuffer, Ogre::GLES2HardwareVertexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLESHardwareIndexBuffer, Ogre::GLES2HardwareIndexBuffer, Ogre::GLHardwareVertexBuffer, Ogre::GLHardwareIndexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareVertexBuffer, Ogre::D3D9HardwareIndexBuffer, and Ogre::D3D9HardwareVertexBuffer.
size_t Ogre::HardwareVertexBuffer::mInstanceDataStepRate [protected] |
Definition at line 55 of file OgreHardwareVertexBuffer.h.
bool Ogre::HardwareVertexBuffer::mIsInstanceData [protected] |
Definition at line 54 of file OgreHardwareVertexBuffer.h.
bool Ogre::HardwareBuffer::mIsLocked [protected, inherited] |
Definition at line 143 of file OgreHardwareBuffer.h.
size_t Ogre::HardwareBuffer::mLockSize [protected, inherited] |
Definition at line 145 of file OgreHardwareBuffer.h.
size_t Ogre::HardwareBuffer::mLockStart [protected, inherited] |
Definition at line 144 of file OgreHardwareBuffer.h.
Definition at line 51 of file OgreHardwareVertexBuffer.h.
size_t Ogre::HardwareVertexBuffer::mNumVertices [protected] |
Definition at line 52 of file OgreHardwareVertexBuffer.h.
HardwareBuffer* Ogre::HardwareBuffer::mShadowBuffer [protected, inherited] |
Definition at line 148 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::mShadowUpdated [protected, inherited] |
Definition at line 149 of file OgreHardwareBuffer.h.
size_t Ogre::HardwareBuffer::mSizeInBytes [protected, inherited] |
Definition at line 141 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::mSuppressHardwareUpdate [protected, inherited] |
Definition at line 150 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::mSystemMemory [protected, inherited] |
Definition at line 146 of file OgreHardwareBuffer.h.
Usage Ogre::HardwareBuffer::mUsage [protected, inherited] |
Definition at line 142 of file OgreHardwareBuffer.h.
bool Ogre::HardwareBuffer::mUseShadowBuffer [protected, inherited] |
Definition at line 147 of file OgreHardwareBuffer.h.
size_t Ogre::HardwareVertexBuffer::mVertexSize [protected] |
Definition at line 53 of file OgreHardwareVertexBuffer.h.
Copyright © 2012 Torus Knot Software Ltd
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.
Last modified Fri May 25 2012 21:48:57