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 useShadowBuffer)
	Should be called by HardwareBufferManager. More...

	~HardwarePixelBuffer ()

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	blit (const HardwarePixelBufferSharedPtr &src)
	Convenience function that blits the entire source pixel buffer to this 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...

void	blitFromMemory (const PixelBox &src)
	Convenience function that blits a pixelbox from memory to the entire buffer. 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 PixelBox &	getCurrentLock ()
	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...

RenderTexture *	getRenderTarget (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...

const PixelBox &	lock (const Box &lockBox, LockOptions options)
	Lock the buffer for (potentially) reading / writing. More...

void *	lock (size_t offset, size_t length, LockOptions options) override
	Lock the buffer for (potentially) reading / writing. 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	writeData (size_t offset, size_t length, const void *pSource, bool discardWholeBuffer=false) 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 useShadowBuffer)
	Constructor, to be called by HardwareBufferManager only. More...

virtual	~HardwareBuffer ()

template<typename T >
T *	_getImpl ()

virtual void	_updateFromShadow (void)
	Updates the real buffer from the shadow buffer, if required. 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...

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

virtual bool	isSystemMemory (void) const
	Returns whether this buffer is held in system memory. More...

void *	lock (LockOptions options)

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 : uint8 { HBL_NORMAL, HBL_DISCARD, HBL_READ_ONLY, HBL_NO_OVERWRITE, HBL_WRITE_ONLY }
	Locking options. More...

typedef uint8	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 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	useShadowBuffer
	)

Should be called by HardwareBufferManager.

◆ ~HardwarePixelBuffer()

Ogre::HardwarePixelBuffer::~HardwarePixelBuffer ( )

Member Function Documentation

◆ lock() [1/2]

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

Lock the buffer for (potentially) reading / writing.

Parameters

lockBox	Region of the buffer to lock
options	Locking options

Returns: PixelBox containing the locked region, the pitches and the pixel format

◆ lock() [2/2]

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

overridevirtual

Lock the buffer for (potentially) reading / writing.

Parameters

offset	The byte offset from the start of the buffer to lock
length	The size of the area to lock, in bytes
options	Locking 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()

void Ogre::HardwarePixelBuffer::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

offset	The byte offset from the start of the buffer to read
length	The size of the area to read, in bytes
pDest	The area of memory in which to place the data, must be large enough to accommodate the data!

Reimplemented from Ogre::HardwareBuffer.

◆ writeData()

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

overridevirtual

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

Parameters

offset	The byte offset from the start of the buffer to start writing
length	The size of the data to write to, in bytes
pSource	The source of the data to be written
discardWholeBuffer	If 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.

◆ 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

src	Source pixel buffer
srcBox	Box describing the source region in src
dstBox	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::D3D9HardwarePixelBuffer, Ogre::MetalTextureBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::GL3PlusTextureBuffer, Ogre::GLTextureBuffer, and Ogre::GLES2TextureBuffer.

◆ 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

src	PixelBox 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

src	PixelBox containing the source pixels and format in memory
dstBox	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.

Implemented in Ogre::D3D9HardwarePixelBuffer, Ogre::MetalTextureBuffer, Ogre::VulkanHardwarePixelBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::MetalHardwarePixelBuffer, Ogre::GL3PlusTextureBuffer, Ogre::GLTextureBuffer, Ogre::GLES2TextureBuffer, and Ogre::TinyHardwarePixelBuffer.

◆ 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

src	PixelBox 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

srcBox	Box describing the source region of this buffer
dst	PixelBox 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::VulkanHardwarePixelBuffer, Ogre::D3D11HardwarePixelBuffer, Ogre::MetalHardwarePixelBuffer, Ogre::GL3PlusTextureBuffer, Ogre::GLTextureBuffer, Ogre::GLES2TextureBuffer, and Ogre::TinyHardwarePixelBuffer.

◆ 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

dst	PixelBox describing the destination pixels and format in memory

Note: Only call this function when the buffer is unlocked.

References blitToMemory().

Referenced by blitToMemory().

◆ getRenderTarget()

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

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

The texture this was acquired from must have TU_RENDERTARGET set

Parameters

slice Which slice

Returns: A pointer to the render target. This pointer has the lifespan of this PixelBuffer.

◆ 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 ( void ) 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.

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

OgreHardwarePixelBuffer.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HardwarePixelBuffer()

◆ ~HardwarePixelBuffer()

Member Function Documentation

◆ lock() [1/2]

◆ lock() [2/2]

◆ getCurrentLock()

◆ readData()

◆ writeData()

◆ blit() [1/2]

◆ blit() [2/2]

◆ blitFromMemory() [1/2]

◆ blitFromMemory() [2/2]

◆ blitToMemory() [1/2]

◆ blitToMemory() [2/2]

◆ getRenderTarget()

◆ getWidth()

◆ getHeight()

◆ getDepth()

◆ getSize()

◆ getFormat()