OGRE  1.12.13
Object-Oriented Graphics Rendering Engine
Ogre::DefaultHardwareUniformBuffer Class Reference

Specialisation of HardwareUniformBuffer for emulation. More...

#include <OgreDefaultHardwareBufferManager.h>

+ Inheritance diagram for Ogre::DefaultHardwareUniformBuffer:

Public Member Functions

 DefaultHardwareUniformBuffer (HardwareBufferManagerBase *mgr, size_t sizeBytes, Usage usage, bool useShadowBuffer=false, const String &name="")
 
- Public Member Functions inherited from Ogre::HardwareUniformBuffer
 HardwareUniformBuffer (HardwareBufferManagerBase *mgr, HardwareBuffer *delegate)
 
 HardwareUniformBuffer (HardwareBufferManagerBase *mgr, size_t sizeBytes, HardwareBuffer::Usage usage, bool useShadowBuffer=false, const String &name="")
 Should be called by HardwareBufferManager. More...
 
 ~HardwareUniformBuffer ()
 
HardwareBufferManagerBasegetManager () const
 
const StringgetName () const
 
- Public Member Functions inherited from Ogre::HardwareBuffer
 HardwareBuffer (Usage usage, bool systemMemory, bool useShadowBuffer)
 Constructor, to be called by HardwareBufferManager only. More...
 
virtual ~HardwareBuffer ()
 
template<typename T >
T * _getImpl ()
 
virtual void _updateFromShadow (void)
 Updates the real buffer from the shadow buffer, if required. More...
 
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...
 
virtual void * lock (size_t offset, size_t length, LockOptions options)
 Lock the buffer for (potentially) reading / writing. More...
 
virtual void readData (size_t offset, size_t length, void *pDest)
 Reads data from the buffer and places it in the memory pointed to by pDest. More...
 
void suppressHardwareUpdate (bool suppress)
 Pass true to suppress hardware upload of shadow buffer changes. More...
 
void unlock (void)
 Releases the lock on this buffer. More...
 
virtual void writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)
 Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough. 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...
 
typedef int Usage
 
enum  UsageEnum {
  HBU_STATIC = HBU_GPU_TO_CPU, HBU_DYNAMIC = HBU_CPU_ONLY, HBU_WRITE_ONLY = HBU_DETAIL_WRITE_ONLY, HBU_DISCARDABLE = 8,
  HBU_STATIC_WRITE_ONLY = HBU_GPU_ONLY, HBU_DYNAMIC_WRITE_ONLY = HBU_CPU_TO_GPU, HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = HBU_CPU_TO_GPU
}
 Rather use HardwareBufferUsage. More...
 

Detailed Description

Specialisation of HardwareUniformBuffer for emulation.

Constructor & Destructor Documentation

◆ DefaultHardwareUniformBuffer()

Ogre::DefaultHardwareUniformBuffer::DefaultHardwareUniformBuffer ( HardwareBufferManagerBase mgr,
size_t  sizeBytes,
Usage  usage,
bool  useShadowBuffer = false,
const String name = "" 
)
inline

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