OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::DefaultHardwareVertexBuffer Class Reference

Specialisation of HardwareVertexBuffer for emulation. More...

#include <OgreDefaultHardwareBufferManager.h>

+ Inheritance diagram for Ogre::DefaultHardwareVertexBuffer:

Public Member Functions

 DefaultHardwareVertexBuffer (HardwareBufferManagerBase *mgr, size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage)
 
 DefaultHardwareVertexBuffer (size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage)
 
 ~DefaultHardwareVertexBuffer ()
 
void * lock (size_t offset, size_t length, LockOptions options)
 Override HardwareBuffer to turn off all shadowing. More...
 
void readData (size_t offset, size_t length, void *pDest)
 See HardwareBuffer. More...
 
void unlock (void)
 Override HardwareBuffer to turn off all shadowing. More...
 
void writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)
 See HardwareBuffer. More...
 
- Public Member Functions inherited from Ogre::HardwareVertexBuffer
 HardwareVertexBuffer (HardwareBufferManagerBase *mgr, size_t vertexSize, size_t numVertices, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer)
 Should be called by HardwareBufferManager. More...
 
 ~HardwareVertexBuffer ()
 
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. More...
 
HardwareBufferManagerBasegetManager () const
 Return the manager of this buffer, if any. More...
 
size_t getNumVertices (void) const
 Get the number of vertices in this buffer. More...
 
size_t getVertexSize (void) const
 Gets the size in bytes of a single vertex in this buffer. More...
 
bool isInstanceData () const
 Get if this vertex buffer is an "instance data" buffer (per instance) More...
 
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. More...
 
void setIsInstanceData (const bool val)
 Set if this vertex buffer is an "instance data" buffer (per instance) More...
 
- Public Member Functions inherited from Ogre::HardwareBuffer
 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)
 Copy all data from another buffer into this one. 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...
 
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...
 
void * lock (LockOptions options)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
void suppressHardwareUpdate (bool suppress)
 Pass true to suppress hardware upload of shadow buffer changes. More...
 

Additional Inherited Members

- Public Types inherited from Ogre::HardwareBuffer
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 = HBU_STATIC | HBU_WRITE_ONLY, HBU_DYNAMIC_WRITE_ONLY = HBU_DYNAMIC | HBU_WRITE_ONLY, HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = HBU_DYNAMIC_WRITE_ONLY | HBU_DISCARDABLE
}
 Enums describing buffer usage; not mutually exclusive. More...
 

Detailed Description

Specialisation of HardwareVertexBuffer for emulation.

Constructor & Destructor Documentation

◆ DefaultHardwareVertexBuffer() [1/2]

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

◆ DefaultHardwareVertexBuffer() [2/2]

Ogre::DefaultHardwareVertexBuffer::DefaultHardwareVertexBuffer ( HardwareBufferManagerBase mgr,
size_t  vertexSize,
size_t  numVertices,
HardwareBuffer::Usage  usage 
)

◆ ~DefaultHardwareVertexBuffer()

Ogre::DefaultHardwareVertexBuffer::~DefaultHardwareVertexBuffer ( )

Member Function Documentation

◆ readData()

void Ogre::DefaultHardwareVertexBuffer::readData ( size_t  offset,
size_t  length,
void *  pDest 
)
virtual

◆ writeData()

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

◆ lock()

void* Ogre::DefaultHardwareVertexBuffer::lock ( size_t  offset,
size_t  length,
LockOptions  options 
)
virtual

Override HardwareBuffer to turn off all shadowing.

Reimplemented from Ogre::HardwareBuffer.

◆ unlock()

void Ogre::DefaultHardwareVertexBuffer::unlock ( void  )
virtual

Override HardwareBuffer to turn off all shadowing.

Reimplemented from Ogre::HardwareBuffer.


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