OGRE  1.12.8
Object-Oriented Graphics Rendering Engine
Ogre::HardwarePixelBuffer Class Referenceabstract

Specialisation of HardwareBuffer for a pixel buffer. More...

#include <OgreHardwarePixelBuffer.h>

+ Inheritance diagram for Ogre::HardwarePixelBuffer:

Public Member Functions

 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...
 
virtual 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...
 
void blitFromMemory (const PixelBox &src)
 Convenience function that blits a pixelbox from memory to the entire buffer. More...
 
virtual void blitFromMemory (const PixelBox &src, const Box &dstBox)=0
 Copies a region from normal memory to a region of this pixelbuffer. More...
 
virtual void blitToMemory (const Box &srcBox, const PixelBox &dst)=0
 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...
 
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...
 
virtual RenderTexturegetRenderTarget (size_t slice=0)
 Get a render target for this PixelBuffer, or a slice of it. 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

Specialisation of HardwareBuffer for a pixel buffer.

The HardwarePixelbuffer abstracts an 1D, 2D or 3D quantity of pixels stored by the rendering API. The buffer can be located on the card or in main memory depending on its usage. One mipmap level of a texture is an example of a HardwarePixelBuffer.

Constructor & Destructor Documentation

◆ HardwarePixelBuffer()

Ogre::HardwarePixelBuffer::HardwarePixelBuffer ( uint32  mWidth,
uint32  mHeight,
uint32  mDepth,
PixelFormat  mFormat,
HardwareBuffer::Usage  usage,
bool  useSystemMemory,
bool  useShadowBuffer 
)

Should be called by HardwareBufferManager.

◆ ~HardwarePixelBuffer()

Ogre::HardwarePixelBuffer::~HardwarePixelBuffer ( )

Member Function Documentation

◆ lock() [1/4]

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

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

◆ lock() [2/4]

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

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
Attention
this method returns a pointer to the raw buffer storage, which is likely not what you want. The RenderSystem is free to add padding, which you have to query from getCurrentLock() and apply during copying. Prefer Blit from memory, which correctly handles copying in this case
See also
Updating Pixel Buffers

Reimplemented from Ogre::HardwareBuffer.

◆ getCurrentLock()

const PixelBox& Ogre::HardwarePixelBuffer::getCurrentLock ( )

Get the current locked region.

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

Returns
PixelBox containing the locked region

◆ readData()

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

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.

◆ writeData()

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

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.

◆ blit() [1/2]

virtual void Ogre::HardwarePixelBuffer::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 in Ogre::MetalTextureBuffer, Ogre::D3D9HardwarePixelBuffer, Ogre::GLES2TextureBuffer, Ogre::GLTextureBuffer, Ogre::D3D11HardwarePixelBuffer, and Ogre::GL3PlusTextureBuffer.

◆ blit() [2/2]

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

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.

◆ blitFromMemory() [1/2]

virtual void Ogre::HardwarePixelBuffer::blitFromMemory ( const PixelBox src,
const Box dstBox 
)
pure virtual

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
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 the buffer is unlocked.

Implemented in Ogre::MetalTextureBuffer, Ogre::GLES2TextureBuffer, Ogre::GLTextureBuffer, Ogre::GL3PlusTextureBuffer, Ogre::D3D9HardwarePixelBuffer, Ogre::MetalDepthPixelBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::MetalHardwarePixelBuffer, Ogre::GL3PlusHardwarePixelBuffer, Ogre::GLES2HardwarePixelBuffer, and Ogre::GLHardwarePixelBuffer.

◆ blitFromMemory() [2/2]

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

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.

References blitFromMemory().

Referenced by blitFromMemory().

◆ blitToMemory() [1/2]

virtual void Ogre::HardwarePixelBuffer::blitToMemory ( const Box srcBox,
const PixelBox dst 
)
pure virtual

Copies a region of this pixelbuffer to normal memory.

Parameters
srcBoxBox 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.

Implemented in Ogre::D3D9HardwarePixelBuffer, Ogre::MetalDepthPixelBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::MetalHardwarePixelBuffer, Ogre::GL3PlusHardwarePixelBuffer, Ogre::GLES2HardwarePixelBuffer, and Ogre::GLHardwarePixelBuffer.

◆ blitToMemory() [2/2]

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

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.

References blitToMemory().

Referenced by blitToMemory().

◆ getRenderTarget()

virtual RenderTexture* Ogre::HardwarePixelBuffer::getRenderTarget ( size_t  slice = 0)
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 in Ogre::GL3PlusTextureBuffer, Ogre::D3D9HardwarePixelBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::MetalDepthPixelBuffer, Ogre::MetalTextureBuffer, Ogre::GLES2TextureBuffer, and Ogre::GLTextureBuffer.

◆ getWidth()

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

Gets the width of this buffer.

◆ getHeight()

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

Gets the height of this buffer.

◆ getDepth()

uint32 Ogre::HardwarePixelBuffer::getDepth ( ) const
inline

Gets the depth of this buffer.

◆ getSize()

Vector3i Ogre::HardwarePixelBuffer::getSize ( ) const
inline

size (width, height, depth) of the pixel buffer

◆ getFormat()

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

Gets the native pixel format of this buffer.

◆ lock() [3/4]

virtual void* Ogre::HardwareBuffer::lock
inline

◆ lock() [4/4]

void* Ogre::HardwareBuffer::lock
inline

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