OGRE  1.12.12
Object-Oriented Graphics Rendering Engine
Ogre::GL3PlusHardwareBuffer Class Reference

#include <OgreGL3PlusHardwareBuffer.h>

+ Inheritance diagram for Ogre::GL3PlusHardwareBuffer:

Public Member Functions

 GL3PlusHardwareBuffer (GLenum target, size_t sizeInBytes, uint32 usage, bool useShadowBuffer=false)
 
 ~GL3PlusHardwareBuffer ()
 
void _updateFromShadow () override
 Updates the real buffer from the shadow buffer, if required. More...
 
void copyData (HardwareBuffer &srcBuffer, size_t srcOffset, size_t dstOffset, size_t length, bool discardWholeBuffer) override
 Copy data from another buffer into this one. More...
 
GLint getGLBufferBinding (void) const
 
GLuint getGLBufferId (void) const
 
GLenum getTarget () const
 
void * lockImpl (size_t offset, size_t length, LockOptions options) override
 Internal implementation of lock() More...
 
void readData (size_t offset, size_t length, void *pDest) override
 Reads data from the buffer and places it in the memory pointed to by pDest. More...
 
void setGLBufferBinding (GLint binding)
 
void unlockImpl () override
 Internal implementation of unlock() More...
 
void writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer) override
 Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough. 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 ()
 
template<typename T >
T * _getImpl ()
 
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...
 
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...
 

Constructor & Destructor Documentation

◆ GL3PlusHardwareBuffer()

Ogre::GL3PlusHardwareBuffer::GL3PlusHardwareBuffer ( GLenum  target,
size_t  sizeInBytes,
uint32  usage,
bool  useShadowBuffer = false 
)

◆ ~GL3PlusHardwareBuffer()

Ogre::GL3PlusHardwareBuffer::~GL3PlusHardwareBuffer ( )

Member Function Documentation

◆ lockImpl()

void* Ogre::GL3PlusHardwareBuffer::lockImpl ( size_t  offset,
size_t  length,
LockOptions  options 
)
overridevirtual

Internal implementation of lock()

Reimplemented from Ogre::HardwareBuffer.

◆ unlockImpl()

void Ogre::GL3PlusHardwareBuffer::unlockImpl ( )
overridevirtual

Internal implementation of unlock()

Reimplemented from Ogre::HardwareBuffer.

◆ readData()

void Ogre::GL3PlusHardwareBuffer::readData ( size_t  offset,
size_t  length,
void *  pDest 
)
overridevirtual

Reads data from the buffer and places it in the memory pointed to by pDest.

Parameters
offsetThe byte offset from the start of the buffer to read
lengthThe size of the area to read, in bytes
pDestThe area of memory in which to place the data, must be large enough to accommodate the data!

Reimplemented from Ogre::HardwareBuffer.

◆ writeData()

void Ogre::GL3PlusHardwareBuffer::writeData ( size_t  offset,
size_t  length,
const void *  pSource,
bool  discardWholeBuffer 
)
overridevirtual

Writes data to the buffer from an area of system memory; note that you must ensure that your buffer is big enough.

Parameters
offsetThe byte offset from the start of the buffer to start writing
lengthThe size of the data to write to, in bytes
pSourceThe source of the data to be written
discardWholeBufferIf true, this allows the driver to discard the entire buffer when writing, such that DMA stalls can be avoided; use if you can.

Reimplemented from Ogre::HardwareBuffer.

◆ copyData()

void Ogre::GL3PlusHardwareBuffer::copyData ( HardwareBuffer srcBuffer,
size_t  srcOffset,
size_t  dstOffset,
size_t  length,
bool  discardWholeBuffer 
)
overridevirtual

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
srcBufferThe buffer from which to read the copied data
srcOffsetOffset in the source buffer at which to start reading
dstOffsetOffset in the destination buffer to start writing
lengthLength of the data to copy, in bytes.
discardWholeBufferIf true, will discard the entire contents of this buffer before copying

Reimplemented from Ogre::HardwareBuffer.

◆ _updateFromShadow()

void Ogre::GL3PlusHardwareBuffer::_updateFromShadow ( )
overridevirtual

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

Reimplemented from Ogre::HardwareBuffer.

◆ getGLBufferId()

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

◆ getTarget()

GLenum Ogre::GL3PlusHardwareBuffer::getTarget ( ) const
inline

◆ setGLBufferBinding()

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

◆ getGLBufferBinding()

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

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