Base implementation of a D3D11 buffer, dealing with all the common aspects. More...
#include <OgreD3D11HardwareBuffer.h>
Public Types | |
enum | BufferType { VERTEX_BUFFER, INDEX_BUFFER } |
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 | |
D3D11HardwareBuffer (BufferType btype, size_t sizeBytes, HardwareBuffer::Usage usage, D3D11Device &device, bool useSystemMem, bool useShadowBuffer, bool streamOut) | |
~D3D11HardwareBuffer () | |
void | readData (size_t offset, size_t length, void *pDest) |
See HardwareBuffer. | |
void | writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false) |
See HardwareBuffer. | |
void | copyData (HardwareBuffer &srcBuffer, size_t srcOffset, size_t dstOffset, size_t length, bool discardWholeBuffer=false) |
See HardwareBuffer. | |
ID3D11Buffer * | getD3DBuffer (void) |
Get the D3D-specific 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 | 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 | |
void * | lockImpl (size_t offset, size_t length, LockOptions options) |
See HardwareBuffer. | |
void | unlockImpl (void) |
See HardwareBuffer. | |
Protected Attributes | |
ID3D11Buffer * | mlpD3DBuffer |
bool | mUseTempStagingBuffer |
D3D11HardwareBuffer * | mpTempStagingBuffer |
bool | mStagingUploadNeeded |
BufferType | mBufferType |
D3D11Device & | mDevice |
D3D11_BUFFER_DESC | mDesc |
size_t | mSizeInBytes |
Usage | mUsage |
bool | mIsLocked |
size_t | mLockStart |
size_t | mLockSize |
bool | mSystemMemory |
bool | mUseShadowBuffer |
HardwareBuffer * | mShadowBuffer |
bool | mShadowUpdated |
bool | mSuppressHardwareUpdate |
Base implementation of a D3D11 buffer, dealing with all the common aspects.
Definition at line 40 of file OgreD3D11HardwareBuffer.h.
Definition at line 43 of file OgreD3D11HardwareBuffer.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::D3D11HardwareBuffer::D3D11HardwareBuffer | ( | BufferType | btype, |
size_t | sizeBytes, | ||
HardwareBuffer::Usage | usage, | ||
D3D11Device & | device, | ||
bool | useSystemMem, | ||
bool | useShadowBuffer, | ||
bool | streamOut | ||
) |
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.
void Ogre::D3D11HardwareBuffer::copyData | ( | HardwareBuffer & | srcBuffer, |
size_t | srcOffset, | ||
size_t | dstOffset, | ||
size_t | length, | ||
bool | discardWholeBuffer = false |
||
) | [virtual] |
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().
ID3D11Buffer* Ogre::D3D11HardwareBuffer::getD3DBuffer | ( | void | ) |
Get the D3D-specific buffer.
Definition at line 78 of file OgreD3D11HardwareBuffer.h.
References mlpD3DBuffer.
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.
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.
void* Ogre::D3D11HardwareBuffer::lockImpl | ( | size_t | offset, |
size_t | length, | ||
LockOptions | options | ||
) | [protected, virtual] |
See HardwareBuffer.
Implements Ogre::HardwareBuffer.
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.
void Ogre::D3D11HardwareBuffer::readData | ( | size_t | offset, |
size_t | length, | ||
void * | pDest | ||
) | [virtual] |
See HardwareBuffer.
Implements Ogre::HardwareBuffer.
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().
void Ogre::D3D11HardwareBuffer::unlockImpl | ( | void | ) | [protected, virtual] |
See HardwareBuffer.
Implements Ogre::HardwareBuffer.
void Ogre::D3D11HardwareBuffer::writeData | ( | size_t | offset, |
size_t | length, | ||
const void * | pSource, | ||
bool | discardWholeBuffer = false |
||
) | [virtual] |
See HardwareBuffer.
Implements Ogre::HardwareBuffer.
BufferType Ogre::D3D11HardwareBuffer::mBufferType [protected] |
Definition at line 53 of file OgreD3D11HardwareBuffer.h.
D3D11_BUFFER_DESC Ogre::D3D11HardwareBuffer::mDesc [protected] |
Definition at line 55 of file OgreD3D11HardwareBuffer.h.
D3D11Device& Ogre::D3D11HardwareBuffer::mDevice [protected] |
Definition at line 54 of file OgreD3D11HardwareBuffer.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.
ID3D11Buffer* Ogre::D3D11HardwareBuffer::mlpD3DBuffer [protected] |
Definition at line 49 of file OgreD3D11HardwareBuffer.h.
Referenced by getD3DBuffer().
Definition at line 51 of file OgreD3D11HardwareBuffer.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::D3D11HardwareBuffer::mStagingUploadNeeded [protected] |
Definition at line 52 of file OgreD3D11HardwareBuffer.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.
bool Ogre::D3D11HardwareBuffer::mUseTempStagingBuffer [protected] |
Definition at line 50 of file OgreD3D11HardwareBuffer.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:49:13