OGRE  1.12.9
Object-Oriented Graphics Rendering Engine
Ogre::GL3PlusHardwareUniformBuffer Class Reference

Specialisation of HardwareUniformBuffer for OpenGL. More...

#include <OgreGL3PlusHardwareUniformBuffer.h>

+ Inheritance diagram for Ogre::GL3PlusHardwareUniformBuffer:

Public Member Functions

 GL3PlusHardwareUniformBuffer (HardwareBufferManagerBase *mgr, size_t bufferSize, HardwareBuffer::Usage usage, bool useShadowBuffer, const String &name, GLenum target)
 
void copyData (HardwareBuffer &srcBuffer, size_t srcOffset, size_t dstOffset, size_t length, bool discardWholeBuffer=false)
 See HardwareBuffer. More...
 
GLint getGLBufferBinding (void) const
 
GLuint getGLBufferId (void) const
 
void readData (size_t offset, size_t length, void *pDest)
 See HardwareBuffer. More...
 
void setGLBufferBinding (GLint binding)
 
void writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false)
 See HardwareBuffer. More...
 
- Public Member Functions inherited from Ogre::HardwareUniformBuffer
 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 ()
 
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...
 
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...
 
void suppressHardwareUpdate (bool suppress)
 Pass true to suppress hardware upload of shadow buffer changes. More...
 
virtual void unlock (void)
 Releases the lock on this buffer. 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 OpenGL.

Constructor & Destructor Documentation

◆ GL3PlusHardwareUniformBuffer()

Ogre::GL3PlusHardwareUniformBuffer::GL3PlusHardwareUniformBuffer ( HardwareBufferManagerBase mgr,
size_t  bufferSize,
HardwareBuffer::Usage  usage,
bool  useShadowBuffer,
const String name,
GLenum  target 
)

Member Function Documentation

◆ readData()

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

◆ writeData()

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

◆ copyData()

void Ogre::GL3PlusHardwareUniformBuffer::copyData ( HardwareBuffer srcBuffer,
size_t  srcOffset,
size_t  dstOffset,
size_t  length,
bool  discardWholeBuffer = false 
)
virtual

See HardwareBuffer.

Reimplemented from Ogre::HardwareBuffer.

◆ getGLBufferId()

GLuint Ogre::GL3PlusHardwareUniformBuffer::getGLBufferId ( void  ) const
inline

◆ setGLBufferBinding()

void Ogre::GL3PlusHardwareUniformBuffer::setGLBufferBinding ( GLint  binding)

◆ getGLBufferBinding()

GLint Ogre::GL3PlusHardwareUniformBuffer::getGLBufferBinding ( void  ) const
inline

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