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

Texture surface. More...

#include <OgreGLES2HardwarePixelBuffer.h>

+ Inheritance diagram for Ogre::GLES2TextureBuffer:

Public Member Functions

 GLES2TextureBuffer (GLES2Texture *parent, GLint face, GLint level, GLint width, GLint height, GLint depth)
 Texture constructor. More...
 
virtual ~GLES2TextureBuffer ()
 
void _clearSliceRTT (size_t zoffset)
 Notify TextureBuffer of destruction of render target. More...
 
virtual void bindToFramebuffer (uint32 attachment, uint32 zoffset)
 Bind surface to frame buffer. More...
 
void blit (const HardwarePixelBufferSharedPtr &src, const Box &srcBox, const Box &dstBox)
 Copies a box from another PixelBuffer to a region of the this PixelBuffer. More...
 
virtual void blitFromMemory (const PixelBox &src_orig, const Box &dstBox)
 Hardware implementation of blitFromMemory. More...
 
void blitFromTexture (GLES2TextureBuffer *src, const Box &srcBox, const Box &dstBox)
 
void copyFromFramebuffer (size_t zoffset)
 
virtual void download (const PixelBox &data)
 Download a box of pixels from the card. More...
 
RenderTexturegetRenderTarget (size_t slice)
 Get a render target for this PixelBuffer, or a slice of it. More...
 
virtual void upload (const PixelBox &data, const Box &dest)
 Upload a box of pixels to this buffer on the card. More...
 
- Public Member Functions inherited from Ogre::GLES2HardwarePixelBuffer
 GLES2HardwarePixelBuffer (uint32 mWidth, uint32 mHeight, uint32 mDepth, PixelFormat mFormat, HardwareBuffer::Usage usage)
 Should be called by HardwareBufferManager. More...
 
void blitToMemory (const Box &srcBox, const PixelBox &dst)
 Copies a region of this pixelbuffer to normal memory. More...
 
- Public Member Functions inherited from Ogre::GLHardwarePixelBufferCommon
 GLHardwarePixelBufferCommon (uint32 mWidth, uint32 mHeight, uint32 mDepth, PixelFormat mFormat, HardwareBuffer::Usage usage)
 Should be called by HardwareBufferManager. More...
 
virtual ~GLHardwarePixelBufferCommon ()
 
uint32 getGLFormat ()
 
- Public Member Functions inherited from Ogre::HardwarePixelBuffer
 HardwarePixelBuffer (uint32 mWidth, uint32 mHeight, uint32 mDepth, PixelFormat mFormat, HardwareBuffer::Usage usage, bool useSystemMemory, bool useShadowBuffer)
 Should be called by HardwareBufferManager. More...
 
 ~HardwarePixelBuffer ()
 
void blit (const HardwarePixelBufferSharedPtr &src)
 Convenience function that blits the entire source pixel buffer to this buffer. More...
 
void blitFromMemory (const PixelBox &src)
 Convenience function that blits a pixelbox from memory to the entire buffer. More...
 
void blitToMemory (const PixelBox &dst)
 Convenience function that blits this entire buffer to a pixelbox. 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...
 
uint32 getHeight () const
 Gets the height of this buffer. More...
 
Vector3i getSize () const
 size (width, height, depth) of the pixel buffer More...
 
uint32 getWidth () const
 Gets the width of this buffer. More...
 
virtual const PixelBoxlock (const Box &lockBox, LockOptions options)
 Lock the buffer for (potentially) reading / writing. More...
 
void * lock (LockOptions options)
 Make every lock method from HardwareBuffer available. More...
 
virtual void * lock (size_t offset, size_t length, LockOptions options)
 Make every lock method from HardwareBuffer available. 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...
 
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...
 
- 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...
 
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...
 
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

Texture surface.

Constructor & Destructor Documentation

◆ GLES2TextureBuffer()

Ogre::GLES2TextureBuffer::GLES2TextureBuffer ( GLES2Texture parent,
GLint  face,
GLint  level,
GLint  width,
GLint  height,
GLint  depth 
)

Texture constructor.

◆ ~GLES2TextureBuffer()

virtual Ogre::GLES2TextureBuffer::~GLES2TextureBuffer ( )
virtual

Member Function Documentation

◆ bindToFramebuffer()

virtual void Ogre::GLES2TextureBuffer::bindToFramebuffer ( uint32  attachment,
uint32  zoffset 
)
virtual

Bind surface to frame buffer.

Needs FBO extension.

Reimplemented from Ogre::GLHardwarePixelBufferCommon.

◆ getRenderTarget()

RenderTexture* Ogre::GLES2TextureBuffer::getRenderTarget ( size_t  slice)
virtual

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 from Ogre::HardwarePixelBuffer.

◆ upload()

virtual void Ogre::GLES2TextureBuffer::upload ( const PixelBox data,
const Box dest 
)
virtual

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

Reimplemented from Ogre::GLHardwarePixelBufferCommon.

◆ download()

virtual void Ogre::GLES2TextureBuffer::download ( const PixelBox data)
virtual

Download a box of pixels from the card.

Reimplemented from Ogre::GLHardwarePixelBufferCommon.

◆ blitFromMemory()

virtual void Ogre::GLES2TextureBuffer::blitFromMemory ( const PixelBox src_orig,
const Box dstBox 
)
virtual

Hardware implementation of blitFromMemory.

Reimplemented from Ogre::GLES2HardwarePixelBuffer.

◆ _clearSliceRTT()

void Ogre::GLES2TextureBuffer::_clearSliceRTT ( size_t  zoffset)
inlinevirtual

Notify TextureBuffer of destruction of render target.

Reimplemented from Ogre::HardwarePixelBuffer.

◆ copyFromFramebuffer()

void Ogre::GLES2TextureBuffer::copyFromFramebuffer ( size_t  zoffset)

◆ blit()

void Ogre::GLES2TextureBuffer::blit ( const HardwarePixelBufferSharedPtr src,
const Box srcBox,
const Box dstBox 
)
virtual

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

Parameters
srcSource pixel buffer
srcBoxBox describing the source region in src
dstBoxBox 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 from Ogre::HardwarePixelBuffer.

◆ blitFromTexture()

void Ogre::GLES2TextureBuffer::blitFromTexture ( GLES2TextureBuffer src,
const Box srcBox,
const Box dstBox 
)

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