OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::GLRenderBuffer Class Reference

Renderbuffer surface. More...

#include <OgreGLHardwarePixelBuffer.h>

+ Inheritance diagram for Ogre::GLRenderBuffer:
+ Collaboration diagram for Ogre::GLRenderBuffer:

Public Types

enum  LockOptions {
  HBL_NORMAL, HBL_DISCARD, HBL_READ_ONLY, HBL_NO_OVERWRITE,
  HBL_WRITE_ONLY
}
 Locking options. More...
 
enum  UploadOptions { HBU_DEFAULT = 0x0000, HBU_ON_DEMAND = 0x0001 }
 Device load options The following enum is used to controls how data is loaded to devices in a multi device environment This enum only works with the Direct3D 9 render system (5/2013). More...
 
enum  Usage {
  HBU_STATIC = 1, HBU_DYNAMIC = 2, HBU_WRITE_ONLY = 4, HBU_DISCARDABLE = 8,
  HBU_STATIC_WRITE_ONLY = 5, HBU_DYNAMIC_WRITE_ONLY = 6, HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = 14
}
 Enums describing buffer usage; not mutually exclusive. More...
 

Public Member Functions

 GLRenderBuffer (GLenum format, uint32 width, uint32 height, GLsizei numSamples)
 
 ~GLRenderBuffer ()
 
virtual void _updateFromShadow (void)
 Updates the real buffer from the shadow buffer, if required. More...
 
virtual void bindToFramebuffer (GLenum attachment, uint32 zoffset)
 Bind surface to frame buffer. More...
 
virtual void blit (const HardwarePixelBufferSharedPtr &src, const Image::Box &srcBox, const Image::Box &dstBox)
 Copies a box from another PixelBuffer to a region of the this PixelBuffer. More...
 
void blit (const HardwarePixelBufferSharedPtr &src)
 Convenience function that blits the entire source pixel buffer to this buffer. More...
 
void blitFromMemory (const PixelBox &src, const Image::Box &dstBox)
 Copies a region from normal memory to a region of this pixelbuffer. More...
 
void blitFromMemory (const PixelBox &src)
 Convenience function that blits a pixelbox from memory to the entire buffer. More...
 
void blitToMemory (const Image::Box &srcBox, const PixelBox &dst)
 Copies a region of this pixelbuffer to normal memory. More...
 
void blitToMemory (const PixelBox &dst)
 Convenience function that blits this entire buffer to a pixelbox. 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...
 
virtual void copyData (HardwareBuffer &srcBuffer)
 Copy all data from another buffer into this one. More...
 
const PixelBoxgetCurrentLock ()
 Get the current locked region. More...
 
uint32 getDepth () const
 Gets the depth of this buffer. More...
 
PixelFormat getFormat () const
 Gets the native pixel format of this buffer. More...
 
GLenum getGLFormat ()
 
uint32 getHeight () const
 Gets the height of this buffer. More...
 
virtual RenderTexturegetRenderTarget (size_t slice=0)
 Get a render target for this PixelBuffer, or a slice of it. 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...
 
uint32 getWidth () const
 Gets the width of this buffer. 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...
 
virtual const PixelBoxlock (const Image::Box &lockBox, LockOptions options)
 Lock the buffer for (potentially) reading / writing. More...
 
virtual void * lock (size_t offset, size_t length, LockOptions options, UploadOptions uploadOpt=HBU_DEFAULT)
 Lock the buffer for (potentially) reading / writing. More...
 
void * lock (LockOptions options, UploadOptions uploadOpt=HBU_DEFAULT)
 Lock the entire buffer for (potentially) reading / writing. More...
 
void operator delete (void *ptr)
 
void operator delete (void *ptr, void *)
 
void operator delete (void *ptr, const char *, int, const char *)
 
void operator delete[] (void *ptr)
 
void operator delete[] (void *ptr, const char *, int, const char *)
 
void * operator new (size_t sz, const char *file, int line, const char *func)
 operator new, with debug line info More...
 
void * operator new (size_t sz)
 
void * operator new (size_t sz, void *ptr)
 placement operator new More...
 
void * operator new[] (size_t sz, const char *file, int line, const char *func)
 array operator new, with debug line info More...
 
void * operator new[] (size_t sz)
 
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...
 
virtual 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...
 

Protected Member Functions

virtual void _clearSliceRTT (size_t zoffset)
 Notify TextureBuffer of destruction of render target. More...
 
void allocateBuffer ()
 Buffer allocation/freeage. More...
 
virtual void download (const PixelBox &data)
 Download a box of pixels from the card. More...
 
void freeBuffer ()
 
PixelBox lockImpl (const Image::Box &lockBox, LockOptions options)
 Lock a box. More...
 
virtual void * lockImpl (size_t offset, size_t length, LockOptions options)
 Internal implementation of lock(), do not OVERRIDE or CALL this for HardwarePixelBuffer implementations, but override the previous method. More...
 
void unlockImpl (void)
 Unlock a box. More...
 
virtual void upload (const PixelBox &data, const Image::Box &dest)
 Upload a box of pixels to this buffer on the card. More...
 

Protected Attributes

PixelBox mBuffer
 Internal buffer; either on-card or in system memory, freed/allocated on demand depending on buffer usage. More...
 
PixelBox mCurrentLock
 Currently locked region (local coords) More...
 
LockOptions mCurrentLockOptions
 GL internal format. More...
 
uint32 mDepth
 
PixelFormat mFormat
 Internal format. More...
 
GLenum mGLInternalFormat
 
uint32 mHeight
 
bool mIsLocked
 
Image::Box mLockedBox
 The current locked box of this surface (entire surface coords) More...
 
size_t mLockSize
 
size_t mLockStart
 
UploadOptions mLockUploadOption
 
GLuint mRenderbufferID
 In case this is a render buffer. More...
 
size_t mRowPitch
 Pitches (offsets between rows and slices) More...
 
HardwareBuffermShadowBuffer
 
bool mShadowUpdated
 
size_t mSizeInBytes
 
size_t mSlicePitch
 
bool mSuppressHardwareUpdate
 
bool mSystemMemory
 
Usage mUsage
 
bool mUseShadowBuffer
 
uint32 mWidth
 Extents. More...
 

Detailed Description

Renderbuffer surface.

Needs FBO extension.

Definition at line 127 of file OgreGLHardwarePixelBuffer.h.

Member Enumeration Documentation

Locking options.

Enumerator
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 static buffers, i.e. those created without the HBU_DYNAMIC flag.

HBL_NO_OVERWRITE 

As HBL_DISCARD, 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.

HBL_WRITE_ONLY 

Lock the buffer for writing only.

Definition at line 121 of file OgreHardwareBuffer.h.

Device load options The following enum is used to controls how data is loaded to devices in a multi device environment This enum only works with the Direct3D 9 render system (5/2013).

Enumerator
HBU_DEFAULT 
HBU_ON_DEMAND 

Definition at line 146 of file OgreHardwareBuffer.h.

Enums describing buffer usage; not mutually exclusive.

Enumerator
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_DISCARDABLE 

Indicates that the application will be refilling the contents of the buffer regularly (not just updating, but generating the contents from scratch), and therefore does not mind if the contents of the buffer are lost somehow and need to be recreated.

This allows and additional level of optimisation on the buffer. This option only really makes sense when combined with HBU_DYNAMIC_WRITE_ONLY.

HBU_STATIC_WRITE_ONLY 

Combination of HBU_STATIC and HBU_WRITE_ONLY.

HBU_DYNAMIC_WRITE_ONLY 

Combination of HBU_DYNAMIC and HBU_WRITE_ONLY.

If you use this, strongly consider using HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE instead if you update the entire contents of the buffer very regularly.

HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE 

Combination of HBU_DYNAMIC, HBU_WRITE_ONLY and HBU_DISCARDABLE.

Definition at line 79 of file OgreHardwareBuffer.h.

Constructor & Destructor Documentation

Ogre::GLRenderBuffer::GLRenderBuffer ( GLenum  format,
uint32  width,
uint32  height,
GLsizei  numSamples 
)
Ogre::GLRenderBuffer::~GLRenderBuffer ( )

Member Function Documentation

virtual void Ogre::HardwarePixelBuffer::_clearSliceRTT ( size_t  zoffset)
protectedvirtualinherited

Notify TextureBuffer of destruction of render target.

Called by RenderTexture when destroyed.

Reimplemented in Ogre::D3D9HardwarePixelBuffer, Ogre::GLESTextureBuffer, Ogre::GLES2TextureBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::GLTextureBuffer, and Ogre::GL3PlusTextureBuffer.

virtual void Ogre::HardwareBuffer::_updateFromShadow ( void  )
inlinevirtualinherited

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

Reimplemented in Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLHardwareVertexBuffer, and Ogre::GLHardwareIndexBuffer.

Definition at line 324 of file OgreHardwareBuffer.h.

void Ogre::GLHardwarePixelBuffer::allocateBuffer ( )
protectedinherited

Buffer allocation/freeage.

virtual void Ogre::GLRenderBuffer::bindToFramebuffer ( GLenum  attachment,
uint32  zoffset 
)
virtual

Bind surface to frame buffer.

Needs FBO extension.

Reimplemented from Ogre::GLHardwarePixelBuffer.

virtual void Ogre::HardwarePixelBuffer::blit ( const HardwarePixelBufferSharedPtr src,
const Image::Box srcBox,
const Image::Box dstBox 
)
virtualinherited

Copies a box from another PixelBuffer to a region of the this PixelBuffer.

Parameters
srcSource pixel buffer
srcBoxImage::Box describing the source region in src
dstBoxImage::Box describing the destination region in this buffer
Remarks
The source and destination regions dimensions don't have to match, in which case scaling is done. This scaling is generally done using a bilinear filter in hardware, but it is faster to pass the source image in the right dimensions.
Note
Only call this function when both buffers are unlocked.

Reimplemented in Ogre::GLESTextureBuffer, Ogre::GLES2TextureBuffer, Ogre::D3D9HardwarePixelBuffer, Ogre::GLTextureBuffer, Ogre::D3D11HardwarePixelBuffer, and Ogre::GL3PlusTextureBuffer.

void Ogre::HardwarePixelBuffer::blit ( const HardwarePixelBufferSharedPtr src)
inherited

Convenience function that blits the entire source pixel buffer to this buffer.

If source and destination dimensions don't match, scaling is done.

Parameters
srcPixelBox containing the source pixels and format in memory
Note
Only call this function when the buffer is unlocked.
void Ogre::GLHardwarePixelBuffer::blitFromMemory ( const PixelBox src,
const Image::Box dstBox 
)
virtualinherited

Copies a region from normal memory to a region of this pixelbuffer.

The source image can be in any pixel format supported by OGRE, and in any size.

Parameters
srcPixelBox containing the source pixels and format in memory
dstBoxImage::Box describing the destination region in this buffer
Remarks
The source and destination regions dimensions don't have to match, in which case scaling is done. This scaling is generally done using a bilinear filter in hardware, but it is faster to pass the source image in the right dimensions.
Note
Only call this function when the buffer is unlocked.

Implements Ogre::HardwarePixelBuffer.

Reimplemented in Ogre::GLTextureBuffer.

void Ogre::HardwarePixelBuffer::blitFromMemory ( const PixelBox src)
inlineinherited

Convenience function that blits a pixelbox from memory to the entire buffer.

The source image is scaled as needed.

Parameters
srcPixelBox containing the source pixels and format in memory
Note
Only call this function when the buffer is unlocked.

Definition at line 152 of file OgreHardwarePixelBuffer.h.

void Ogre::GLHardwarePixelBuffer::blitToMemory ( const Image::Box srcBox,
const PixelBox dst 
)
virtualinherited

Copies a region of this pixelbuffer to normal memory.

Parameters
srcBoxImage::Box describing the source region of this buffer
dstPixelBox describing the destination pixels and format in memory
Remarks
The source and destination regions don't have to match, in which case scaling is done.
Note
Only call this function when the buffer is unlocked.

Implements Ogre::HardwarePixelBuffer.

void Ogre::HardwarePixelBuffer::blitToMemory ( const PixelBox dst)
inlineinherited

Convenience function that blits this entire buffer to a pixelbox.

The image is scaled as needed.

Parameters
dstPixelBox describing the destination pixels and format in memory
Note
Only call this function when the buffer is unlocked.

Definition at line 171 of file OgreHardwarePixelBuffer.h.

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

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 in Ogre::D3D11HardwareBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GL3PlusHardwareShaderStorageBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.

Definition at line 303 of file OgreHardwareBuffer.h.

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

virtual void Ogre::HardwareBuffer::copyData ( HardwareBuffer srcBuffer)
inlinevirtualinherited

Copy all data from another buffer into this one.

Remarks
Normally these buffers should be of identical size, but if they're not, the routine will use the smallest of the two sizes.

Definition at line 317 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::getSizeInBytes(), and Ogre::min().

virtual void Ogre::GLHardwarePixelBuffer::download ( const PixelBox data)
protectedvirtualinherited

Download a box of pixels from the card.

Reimplemented in Ogre::GLTextureBuffer.

void Ogre::GLHardwarePixelBuffer::freeBuffer ( )
protectedinherited
const PixelBox& Ogre::HardwarePixelBuffer::getCurrentLock ( )
inherited

Get the current locked region.

This is the same value as returned by lock(const Image::Box, LockOptions)

Returns
PixelBox containing the locked region
uint32 Ogre::HardwarePixelBuffer::getDepth ( ) const
inlineinherited

Gets the depth of this buffer.

Definition at line 190 of file OgreHardwarePixelBuffer.h.

PixelFormat Ogre::HardwarePixelBuffer::getFormat ( ) const
inlineinherited

Gets the native pixel format of this buffer.

Definition at line 192 of file OgreHardwarePixelBuffer.h.

GLenum Ogre::GLHardwarePixelBuffer::getGLFormat ( )
inlineinherited

Definition at line 74 of file OgreGLHardwarePixelBuffer.h.

uint32 Ogre::HardwarePixelBuffer::getHeight ( ) const
inlineinherited

Gets the height of this buffer.

Definition at line 188 of file OgreHardwarePixelBuffer.h.

virtual RenderTexture* Ogre::HardwarePixelBuffer::getRenderTarget ( size_t  slice = 0)
virtualinherited

Get a render target for this PixelBuffer, or a slice of it.

The texture this was acquired from must have TU_RENDERTARGET set, otherwise it is possible to render to it and this method will throw an ERR_RENDERSYSTEM exception.

Parameters
sliceWhich slice
Returns
A pointer to the render target. This pointer has the lifespan of this PixelBuffer.

Reimplemented in Ogre::D3D9HardwarePixelBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::GLESTextureBuffer, Ogre::GLES2TextureBuffer, Ogre::GLTextureBuffer, and Ogre::GL3PlusTextureBuffer.

size_t Ogre::HardwareBuffer::getSizeInBytes ( void  ) const
inlineinherited

Returns the size of this buffer in bytes.

Definition at line 349 of file OgreHardwareBuffer.h.

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

Usage Ogre::HardwareBuffer::getUsage ( void  ) const
inlineinherited

Returns the Usage flags with which this buffer was created.

Definition at line 351 of file OgreHardwareBuffer.h.

uint32 Ogre::HardwarePixelBuffer::getWidth ( ) const
inlineinherited

Gets the width of this buffer.

Definition at line 186 of file OgreHardwarePixelBuffer.h.

bool Ogre::HardwareBuffer::hasShadowBuffer ( void  ) const
inlineinherited

Returns whether this buffer has a system memory shadow for quicker reading.

Definition at line 355 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::isLocked ( void  ) const
inlineinherited

Returns whether or not this buffer is currently locked.

Definition at line 357 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::isSystemMemory ( void  ) const
inlineinherited

Returns whether this buffer is held in system memory.

Definition at line 353 of file OgreHardwareBuffer.h.

virtual const PixelBox& Ogre::HardwarePixelBuffer::lock ( const Image::Box lockBox,
LockOptions  options 
)
virtualinherited

Lock the buffer for (potentially) reading / writing.

Parameters
lockBoxRegion of the buffer to lock
optionsLocking options
Returns
PixelBox containing the locked region, the pitches and the pixel format
virtual void* Ogre::HardwarePixelBuffer::lock ( size_t  offset,
size_t  length,
LockOptions  options,
UploadOptions  uploadOpt = HBU_DEFAULT 
)
virtualinherited

Lock the buffer for (potentially) reading / writing.

Parameters
offsetThe byte offset from the start of the buffer to lock
lengthThe size of the area to lock, in bytes
optionsLocking options
Returns
Pointer to the locked memory

Reimplemented from Ogre::HardwareBuffer.

void* Ogre::HardwareBuffer::lock ( LockOptions  options,
UploadOptions  uploadOpt = HBU_DEFAULT 
)
inlineinherited

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

Parameters
optionsLocking options
Returns
Pointer to the locked memory

Definition at line 239 of file OgreHardwareBuffer.h.

PixelBox Ogre::GLHardwarePixelBuffer::lockImpl ( const Image::Box lockBox,
LockOptions  options 
)
protectedvirtualinherited

Lock a box.

Implements Ogre::HardwarePixelBuffer.

virtual void* Ogre::HardwarePixelBuffer::lockImpl ( size_t  offset,
size_t  length,
LockOptions  options 
)
protectedvirtualinherited

Internal implementation of lock(), do not OVERRIDE or CALL this for HardwarePixelBuffer implementations, but override the previous method.

Implements Ogre::HardwareBuffer.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr)
inlineinherited

Definition at line 96 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
void *   
)
inlineinherited

Definition at line 102 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 108 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr)
inlineinherited

Definition at line 113 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void Ogre::AllocatedObject< Alloc >::operator delete[] ( void *  ptr,
const char *  ,
int  ,
const char *   
)
inlineinherited

Definition at line 119 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz)
inlineinherited

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new ( size_t  sz,
void *  ptr 
)
inlineinherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz,
const char *  file,
int  line,
const char *  func 
)
inlineinherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

template<class Alloc >
void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t  sz)
inlineinherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

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

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!

Implements Ogre::HardwareBuffer.

void Ogre::HardwareBuffer::suppressHardwareUpdate ( bool  suppress)
inlineinherited

Pass true to suppress hardware upload of shadow buffer changes.

Definition at line 361 of file OgreHardwareBuffer.h.

virtual void Ogre::HardwareBuffer::unlock ( void  )
inlinevirtualinherited

Releases the lock on this buffer.

Remarks
Locking and unlocking a buffer can, in some rare circumstances such as switching video modes whilst the buffer is locked, corrupt the contents of a buffer. This is pretty rare, but if it occurs, this method will throw an exception, meaning you must re-upload the data.
Note that using the 'read' and 'write' forms of updating the buffer does not suffer from this problem, so if you want to be 100% sure your data will not be lost, use the 'read' and 'write' forms instead.

Reimplemented in Ogre::DefaultHardwareCounterBuffer, Ogre::GL3PlusDefaultHardwareCounterBuffer, Ogre::DefaultHardwareUniformBuffer, Ogre::GL3PlusDefaultHardwareUniformBuffer, Ogre::GLES2DefaultHardwareUniformBuffer, Ogre::DefaultHardwareIndexBuffer, Ogre::GLDefaultHardwareIndexBuffer, Ogre::GL3PlusDefaultHardwareIndexBuffer, Ogre::GLESDefaultHardwareIndexBuffer, Ogre::GLES2DefaultHardwareIndexBuffer, Ogre::DefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.

Definition at line 255 of file OgreHardwareBuffer.h.

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

void Ogre::GLHardwarePixelBuffer::unlockImpl ( void  )
protectedvirtualinherited

Unlock a box.

Implements Ogre::HardwareBuffer.

virtual void Ogre::GLHardwarePixelBuffer::upload ( const PixelBox data,
const Image::Box dest 
)
protectedvirtualinherited

Upload a box of pixels to this buffer on the card.

Reimplemented in Ogre::GLTextureBuffer.

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

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.

Implements Ogre::HardwareBuffer.

Member Data Documentation

PixelBox Ogre::GLHardwarePixelBuffer::mBuffer
protectedinherited

Internal buffer; either on-card or in system memory, freed/allocated on demand depending on buffer usage.

Definition at line 46 of file OgreGLHardwarePixelBuffer.h.

PixelBox Ogre::HardwarePixelBuffer::mCurrentLock
protectedinherited

Currently locked region (local coords)

Definition at line 66 of file OgreHardwarePixelBuffer.h.

LockOptions Ogre::GLHardwarePixelBuffer::mCurrentLockOptions
protectedinherited

GL internal format.

Definition at line 48 of file OgreGLHardwarePixelBuffer.h.

uint32 Ogre::HardwarePixelBuffer::mDepth
protectedinherited

Definition at line 60 of file OgreHardwarePixelBuffer.h.

PixelFormat Ogre::HardwarePixelBuffer::mFormat
protectedinherited

Internal format.

Definition at line 64 of file OgreHardwarePixelBuffer.h.

GLenum Ogre::GLHardwarePixelBuffer::mGLInternalFormat
protectedinherited

Definition at line 47 of file OgreGLHardwarePixelBuffer.h.

uint32 Ogre::HardwarePixelBuffer::mHeight
protectedinherited

Definition at line 60 of file OgreHardwarePixelBuffer.h.

bool Ogre::HardwareBuffer::mIsLocked
protectedinherited

Definition at line 162 of file OgreHardwareBuffer.h.

Image::Box Ogre::HardwarePixelBuffer::mLockedBox
protectedinherited

The current locked box of this surface (entire surface coords)

Definition at line 68 of file OgreHardwarePixelBuffer.h.

size_t Ogre::HardwareBuffer::mLockSize
protectedinherited

Definition at line 164 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareBuffer::mLockStart
protectedinherited

Definition at line 163 of file OgreHardwareBuffer.h.

UploadOptions Ogre::HardwareBuffer::mLockUploadOption
protectedinherited

Definition at line 165 of file OgreHardwareBuffer.h.

GLuint Ogre::GLRenderBuffer::mRenderbufferID
protected

In case this is a render buffer.

Definition at line 137 of file OgreGLHardwarePixelBuffer.h.

size_t Ogre::HardwarePixelBuffer::mRowPitch
protectedinherited

Pitches (offsets between rows and slices)

Definition at line 62 of file OgreHardwarePixelBuffer.h.

HardwareBuffer* Ogre::HardwareBuffer::mShadowBuffer
protectedinherited

Definition at line 168 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::mShadowUpdated
protectedinherited

Definition at line 169 of file OgreHardwareBuffer.h.

size_t Ogre::HardwareBuffer::mSizeInBytes
protectedinherited

Definition at line 160 of file OgreHardwareBuffer.h.

size_t Ogre::HardwarePixelBuffer::mSlicePitch
protectedinherited

Definition at line 62 of file OgreHardwarePixelBuffer.h.

bool Ogre::HardwareBuffer::mSuppressHardwareUpdate
protectedinherited

Definition at line 170 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::mSystemMemory
protectedinherited

Definition at line 166 of file OgreHardwareBuffer.h.

Usage Ogre::HardwareBuffer::mUsage
protectedinherited

Definition at line 161 of file OgreHardwareBuffer.h.

bool Ogre::HardwareBuffer::mUseShadowBuffer
protectedinherited

Definition at line 167 of file OgreHardwareBuffer.h.

uint32 Ogre::HardwarePixelBuffer::mWidth
protectedinherited

Extents.

Definition at line 60 of file OgreHardwarePixelBuffer.h.


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