Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::DefaultHardwareVertexBuffer Class Reference

Specialisation of HardwareVertexBuffer for emulation. More...

#include <OgreDefaultHardwareBufferManager.h>

Inheritance diagram for Ogre::DefaultHardwareVertexBuffer:

Inheritance graph
[legend]
Collaboration diagram for Ogre::DefaultHardwareVertexBuffer:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Usage {
  HBU_STATIC = 1, HBU_DYNAMIC = 2, HBU_WRITE_ONLY = 4, HBU_STATIC_WRITE_ONLY = 5,
  HBU_DYNAMIC_WRITE_ONLY = 6
}
 Enums describing buffer usage; not mutually exclusive. More...

enum  LockOptions { HBL_NORMAL, HBL_DISCARD, HBL_READ_ONLY, HBL_NO_OVERWRITE }
 Locking options. More...


Public Methods

 DefaultHardwareVertexBuffer (size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage)
 ~DefaultHardwareVertexBuffer ()
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 * lock (size_t offset, size_t length, LockOptions options)
 Override HardwareBuffer to turn off all shadowing.

void unlock (void)
 Override HardwareBuffer to turn off all shadowing.

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.

void * lock (LockOptions options)
 Lock the entire buffer for (potentially) reading / writing.

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 _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 isLocked (void) const
 Returns whether or not this buffer is currently locked.


Protected Methods

void * lockImpl (size_t offset, size_t length, LockOptions options)
 See HardwareBuffer.

void unlockImpl (void)
 See HardwareBuffer.


Protected Attributes

unsigned char * mpData
size_t mNumVertices
size_t mVertexSize
size_t mSizeInBytes
Usage mUsage
bool mIsLocked
size_t mLockStart
size_t mLockSize
bool mSystemMemory
bool mUseShadowBuffer
HardwareBuffermpShadowBuffer
bool mShadowUpdated

Detailed Description

Specialisation of HardwareVertexBuffer for emulation.

Definition at line 37 of file OgreDefaultHardwareBufferManager.h.


Member Enumeration Documentation

enum Ogre::HardwareBuffer::LockOptions [inherited]
 

Locking options.

Enumeration values:
HBL_NORMAL  Normal mode, ie allows read/write and contents are preserved.
HBL_DISCARD  Discards the entire buffer while locking; this allows optimisation to be performed because synchronisation issues are relaxed.

Only allowed on buffers created with the HBU_DYNAMIC flag.

HBL_READ_ONLY  Lock the buffer for reading only.

Not allowed in buffers which are created with HBU_WRITE_ONLY. Mandatory on statuc buffers, ie those created without the HBU_DYNAMIC flag.

HBL_NO_OVERWRITE  As HBL_NORMAL, except the application guarantees not to overwrite any region of the buffer which has already been used in this frame, can allow some optimisation on some APIs.

Definition at line 96 of file OgreHardwareBuffer.h.

enum Ogre::HardwareBuffer::Usage [inherited]
 

Enums describing buffer usage; not mutually exclusive.

Enumeration values:
HBU_STATIC  Static buffer which the application rarely modifies once created.

Modifying the contents of this buffer will involve a performance hit.

HBU_DYNAMIC  Indicates the application would like to modify this buffer with the CPU fairly often.

Buffers created with this flag will typically end up in AGP memory rather than video memory.

HBU_WRITE_ONLY  Indicates the application will never read the contents of the buffer back, it will only ever write data.

Locking a buffer with this flag will ALWAYS return a pointer to new, blank memory rather than the memory associated with the contents of the buffer; this avoids DMA stalls because you can write to a new memory area while the previous one is being used

HBU_STATIC_WRITE_ONLY  Combination of HBU_STATIC and HBU_WRITE_ONLY.
HBU_DYNAMIC_WRITE_ONLY  Combination of HBU_DYNAMIC and HBU_WRITE_ONLY.

Definition at line 69 of file OgreHardwareBuffer.h.


Constructor & Destructor Documentation

Ogre::DefaultHardwareVertexBuffer::DefaultHardwareVertexBuffer size_t    vertexSize,
size_t    numVertices,
HardwareBuffer::Usage    usage
 

Definition at line 30 of file OgreDefaultHardwareBufferManager.cpp.

References mpData, and Ogre::HardwareBuffer::mSizeInBytes.

Ogre::DefaultHardwareVertexBuffer::~DefaultHardwareVertexBuffer  
 

Definition at line 37 of file OgreDefaultHardwareBufferManager.cpp.

References mpData.


Member Function Documentation

virtual void Ogre::HardwareBuffer::_updateFromShadow void    [virtual, inherited]
 

Updates the real buffer from the shadow buffer, if required.

Definition at line 247 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::lockImpl(), and Ogre::HardwareBuffer::unlockImpl().

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.

Remarks:
Note that the source buffer must not be created with the usage HBU_WRITE_ONLY otherwise this will fail.
Parameters:
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 237 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::lock(), and Ogre::HardwareBuffer::unlock().

size_t Ogre::HardwareVertexBuffer::getNumVertices void    const [inherited]
 

Get the number of vertices in this buffer.

Definition at line 51 of file OgreHardwareVertexBuffer.h.

size_t Ogre::HardwareBuffer::getSizeInBytes void    const [inherited]
 

Returns the size of this buffer in bytes.

Definition at line 272 of file OgreHardwareBuffer.h.

Usage Ogre::HardwareBuffer::getUsage void    const [inherited]
 

Returns the Usage flags with which this buffer was created.

Definition at line 274 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareVertexBuffer::getVertexSize void    const [inherited]
 

Gets the size in bytes of a single vertex in this buffer.

Definition at line 49 of file OgreHardwareVertexBuffer.h.

Referenced by Ogre::D3D9RenderSystem::setVertexBufferBinding().

bool Ogre::HardwareBuffer::isLocked void    const [inherited]
 

Returns whether or not this buffer is currently locked.

Definition at line 278 of file OgreHardwareBuffer.h.

Referenced by Ogre::HardwareBuffer::unlock().

bool Ogre::HardwareBuffer::isSystemMemory void    const [inherited]
 

Returns whether this buffer is held in system memory.

Definition at line 276 of file OgreHardwareBuffer.h.

void* Ogre::HardwareBuffer::lock LockOptions    options [inherited]
 

Lock the entire buffer for (potentially) reading / writing.

Parameters:
options  Locking options
Returns:
Pointer to the locked memory

Definition at line 173 of file OgreHardwareBuffer.h.

void * Ogre::DefaultHardwareVertexBuffer::lock size_t    offset,
size_t    length,
LockOptions    options
[virtual]
 

Override HardwareBuffer to turn off all shadowing.

Reimplemented from Ogre::HardwareBuffer.

Definition at line 53 of file OgreDefaultHardwareBufferManager.cpp.

References Ogre::HardwareBuffer::mIsLocked, and mpData.

void * Ogre::DefaultHardwareVertexBuffer::lockImpl size_t    offset,
size_t    length,
LockOptions    options
[protected, virtual]
 

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

Definition at line 42 of file OgreDefaultHardwareBufferManager.cpp.

References mpData.

void Ogre::DefaultHardwareVertexBuffer::readData size_t    offset,
size_t    length,
void *    pDest
[virtual]
 

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

Definition at line 65 of file OgreDefaultHardwareBufferManager.cpp.

References mpData, and Ogre::HardwareBuffer::mSizeInBytes.

void Ogre::DefaultHardwareVertexBuffer::unlock void    [virtual]
 

Override HardwareBuffer to turn off all shadowing.

Reimplemented from Ogre::HardwareBuffer.

Definition at line 59 of file OgreDefaultHardwareBufferManager.cpp.

References Ogre::HardwareBuffer::mIsLocked.

void Ogre::DefaultHardwareVertexBuffer::unlockImpl void    [protected, virtual]
 

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

Definition at line 48 of file OgreDefaultHardwareBufferManager.cpp.

void Ogre::DefaultHardwareVertexBuffer::writeData size_t    offset,
size_t    length,
const void *    pSource,
bool    discardWholeBuffer = false
[virtual]
 

See HardwareBuffer.

Implements Ogre::HardwareBuffer.

Definition at line 71 of file OgreDefaultHardwareBufferManager.cpp.

References mpData, and Ogre::HardwareBuffer::mSizeInBytes.


Member Data Documentation

bool Ogre::HardwareBuffer::mIsLocked [protected, inherited]
 

Definition at line 118 of file OgreHardwareBuffer.h.

Referenced by Ogre::GLDefaultHardwareIndexBuffer::lock(), Ogre::GLDefaultHardwareVertexBuffer::lock(), Ogre::DefaultHardwareIndexBuffer::lock(), lock(), Ogre::GLHardwareVertexBuffer::lockImpl(), Ogre::GLHardwareIndexBuffer::lockImpl(), Ogre::GLDefaultHardwareIndexBuffer::unlock(), Ogre::GLDefaultHardwareVertexBuffer::unlock(), Ogre::DefaultHardwareIndexBuffer::unlock(), unlock(), Ogre::GLHardwareVertexBuffer::unlockImpl(), and Ogre::GLHardwareIndexBuffer::unlockImpl().

size_t Ogre::HardwareBuffer::mLockSize [protected, inherited]
 

Definition at line 120 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareBuffer::mLockStart [protected, inherited]
 

Definition at line 119 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareVertexBuffer::mNumVertices [protected, inherited]
 

Definition at line 40 of file OgreHardwareVertexBuffer.h.

Referenced by Ogre::HardwareVertexBuffer::HardwareVertexBuffer().

unsigned char* Ogre::DefaultHardwareVertexBuffer::mpData [protected]
 

Definition at line 40 of file OgreDefaultHardwareBufferManager.h.

Referenced by DefaultHardwareVertexBuffer(), lock(), lockImpl(), readData(), writeData(), and ~DefaultHardwareVertexBuffer().

HardwareBuffer* Ogre::HardwareBuffer::mpShadowBuffer [protected, inherited]
 

Definition at line 123 of file OgreHardwareBuffer.h.

Referenced by Ogre::HardwareIndexBuffer::HardwareIndexBuffer(), Ogre::HardwareVertexBuffer::HardwareVertexBuffer(), Ogre::HardwareIndexBuffer::~HardwareIndexBuffer(), and Ogre::HardwareVertexBuffer::~HardwareVertexBuffer().

bool Ogre::HardwareBuffer::mShadowUpdated [protected, inherited]
 

Definition at line 124 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareBuffer::mSizeInBytes [protected, inherited]
 

Definition at line 116 of file OgreHardwareBuffer.h.

Referenced by Ogre::D3D9HardwareVertexBuffer::D3D9HardwareVertexBuffer(), Ogre::DefaultHardwareIndexBuffer::DefaultHardwareIndexBuffer(), DefaultHardwareVertexBuffer(), Ogre::GLDefaultHardwareIndexBuffer::GLDefaultHardwareIndexBuffer(), Ogre::GLDefaultHardwareVertexBuffer::GLDefaultHardwareVertexBuffer(), Ogre::GLHardwareIndexBuffer::GLHardwareIndexBuffer(), Ogre::GLHardwareVertexBuffer::GLHardwareVertexBuffer(), Ogre::HardwareIndexBuffer::HardwareIndexBuffer(), Ogre::HardwareVertexBuffer::HardwareVertexBuffer(), Ogre::GLDefaultHardwareIndexBuffer::readData(), Ogre::GLDefaultHardwareVertexBuffer::readData(), Ogre::DefaultHardwareIndexBuffer::readData(), readData(), Ogre::GLHardwareVertexBuffer::writeData(), Ogre::GLHardwareIndexBuffer::writeData(), Ogre::GLDefaultHardwareIndexBuffer::writeData(), Ogre::GLDefaultHardwareVertexBuffer::writeData(), Ogre::DefaultHardwareIndexBuffer::writeData(), and writeData().

bool Ogre::HardwareBuffer::mSystemMemory [protected, inherited]
 

Definition at line 121 of file OgreHardwareBuffer.h.

Usage Ogre::HardwareBuffer::mUsage [protected, inherited]
 

Definition at line 117 of file OgreHardwareBuffer.h.

Referenced by Ogre::GLHardwareVertexBuffer::lockImpl(), Ogre::GLHardwareIndexBuffer::lockImpl(), Ogre::D3D9HardwareVertexBuffer::lockImpl(), Ogre::D3D9HardwareIndexBuffer::lockImpl(), Ogre::GLHardwareVertexBuffer::writeData(), and Ogre::GLHardwareIndexBuffer::writeData().

bool Ogre::HardwareBuffer::mUseShadowBuffer [protected, inherited]
 

Definition at line 122 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareVertexBuffer::mVertexSize [protected, inherited]
 

Definition at line 41 of file OgreHardwareVertexBuffer.h.

Referenced by Ogre::HardwareVertexBuffer::HardwareVertexBuffer().


The documentation for this class was generated from the following files:

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:17:11 2004