#include <OgreD3D9HardwarePixelBuffer.h>

Inheritance diagram for Ogre::D3D9HardwarePixelBuffer:

Public Member Functions
	D3D9HardwarePixelBuffer (HardwareBuffer::Usage usage, D3D9Texture *ownerTexture)

	~D3D9HardwarePixelBuffer ()

virtual void	_clearSliceRTT (size_t zoffset)
	Notify TextureBuffer of destruction of render target.

void	_genMipmaps (IDirect3DBaseTexture9 *mipTex)
	Internal function to update mipmaps on update of level 0.

void	_setMipmapping (bool doMipmapGen, bool HWMipmaps)
	Function to set mipmap generation.

void	bind (IDirect3DDevice9 dev, IDirect3DSurface9 mSurface, IDirect3DSurface9 fsaaSurface, bool writeGamma, uint fsaa, const String &srcName, IDirect3DBaseTexture9 mipTex)
	Call this to associate a D3D surface or volume with this pixel buffer.

void	bind (IDirect3DDevice9 dev, IDirect3DVolume9 mVolume, IDirect3DBaseTexture9 *mipTex)

void	blit (const HardwarePixelBufferSharedPtr &src, const Box &srcBox, const Box &dstBox)
	Copies a box from another PixelBuffer to a region of the this PixelBuffer.

void	blitFromMemory (const PixelBox &src, const Box &dstBox)
	Copies a region from normal memory to a region of this pixelbuffer.

void	blitToMemory (const Box &srcBox, const PixelBox &dst)
	Copies a region of this pixelbuffer to normal memory.

void	destroyBufferResources (IDirect3DDevice9 *d3d9Device)
	Destroy resources associated with the given device.

IDirect3DSurface9 *	getFSAASurface (IDirect3DDevice9 *d3d9Device)
	Accessor for AA surface.

RenderTexture *	getRenderTarget (size_t zoffset)
	Get rendertarget for z slice.

IDirect3DSurface9 *	getSurface (IDirect3DDevice9 *d3d9Device)
	Accessor for surface.

void	releaseSurfaces (IDirect3DDevice9 *d3d9Device)
	Release surfaces held by this pixel buffer.

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.

	~HardwarePixelBuffer ()

void	blit (const HardwarePixelBufferSharedPtr &src)
	Convenience function that blits the entire source pixel buffer to this buffer.

void	blitFromMemory (const PixelBox &src)
	Convenience function that blits a pixelbox from memory to the entire buffer.

void	blitToMemory (const PixelBox &dst)
	Convenience function that blits this entire buffer to a pixelbox.

const PixelBox &	getCurrentLock ()
	Get the current locked region.

uint32	getDepth () const
	Gets the depth of this buffer.

PixelFormat	getFormat () const
	Gets the native pixel format of this buffer.

uint32	getHeight () const
	Gets the height of this buffer.

Vector3i	getSize () const
	size (width, height, depth) of the pixel buffer

uint32	getWidth () const
	Gets the width of this buffer.

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

void *	lock (LockOptions options)
	Make every lock method from HardwareBuffer available.

virtual void *	lock (size_t offset, size_t length, LockOptions options)
	Make every lock method from HardwareBuffer available.

virtual void *	lock (size_t offset, size_t length, LockOptions options)
	Lock the buffer for (potentially) reading / writing.

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.

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.

Public Member Functions inherited from Ogre::HardwareBuffer
	HardwareBuffer (Usage usage, bool systemMemory, bool useShadowBuffer)
	Constructor, to be called by HardwareBufferManager only.

virtual	~HardwareBuffer ()

virtual void	_updateFromShadow (void)
	Updates the real buffer from the shadow buffer, if required.

virtual void	copyData (HardwareBuffer &srcBuffer)
	Copy all data from another buffer into this one.

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.

size_t	getSizeInBytes (void) const
	Returns the size of this buffer in bytes.

Usage	getUsage (void) const
	Returns the Usage flags with which this buffer was created.

bool	hasShadowBuffer (void) const
	Returns whether this buffer has a system memory shadow for quicker reading.

bool	isLocked (void) const
	Returns whether or not this buffer is currently locked.

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

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.

void	suppressHardwareUpdate (bool suppress)
	Pass true to suppress hardware upload of shadow buffer changes.

virtual void	unlock (void)
	Releases the lock on this buffer.

Static Public Member Functions
static void	lockDeviceAccess ()

static void	unlockDeviceAccess ()

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

◆ D3D9HardwarePixelBuffer()

Ogre::D3D9HardwarePixelBuffer::D3D9HardwarePixelBuffer	(	HardwareBuffer::Usage	usage,
		D3D9Texture *	ownerTexture
	)

◆ ~D3D9HardwarePixelBuffer()

Ogre::D3D9HardwarePixelBuffer::~D3D9HardwarePixelBuffer ( )

Member Function Documentation

◆ bind() [1/2]

void Ogre::D3D9HardwarePixelBuffer::bind	(	IDirect3DDevice9 *	dev,
		IDirect3DSurface9 *	mSurface,
		IDirect3DSurface9 *	fsaaSurface,
		bool	writeGamma,
		uint	fsaa,
		const String &	srcName,
		IDirect3DBaseTexture9 *	mipTex
	)

Call this to associate a D3D surface or volume with this pixel buffer.

◆ bind() [2/2]

void Ogre::D3D9HardwarePixelBuffer::bind	(	IDirect3DDevice9 *	dev,
		IDirect3DVolume9 *	mVolume,
		IDirect3DBaseTexture9 *	mipTex
	)

◆ blit()

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

◆ blitFromMemory()

void Ogre::D3D9HardwarePixelBuffer::blitFromMemory	(	const PixelBox &	src,
		const Box &	dstBox
	)

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.

Implements Ogre::HardwarePixelBuffer.

◆ blitToMemory()

void Ogre::D3D9HardwarePixelBuffer::blitToMemory	(	const Box &	srcBox,
		const PixelBox &	dst
	)

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.

Implements Ogre::HardwarePixelBuffer.

◆ _genMipmaps()

void Ogre::D3D9HardwarePixelBuffer::_genMipmaps ( IDirect3DBaseTexture9 * mipTex )

Internal function to update mipmaps on update of level 0.

◆ _setMipmapping()

void Ogre::D3D9HardwarePixelBuffer::_setMipmapping	(	bool	doMipmapGen,
		bool	HWMipmaps
	)

Function to set mipmap generation.

◆ getRenderTarget()

RenderTexture * Ogre::D3D9HardwarePixelBuffer::getRenderTarget ( size_t zoffset )

virtual

Get rendertarget for z slice.

Reimplemented from Ogre::HardwarePixelBuffer.

◆ getSurface()

IDirect3DSurface9 * Ogre::D3D9HardwarePixelBuffer::getSurface ( IDirect3DDevice9 * d3d9Device )

Accessor for surface.

◆ getFSAASurface()

IDirect3DSurface9 * Ogre::D3D9HardwarePixelBuffer::getFSAASurface ( IDirect3DDevice9 * d3d9Device )

Accessor for AA surface.

◆ _clearSliceRTT()

virtual void Ogre::D3D9HardwarePixelBuffer::_clearSliceRTT ( size_t zoffset )

virtual

Notify TextureBuffer of destruction of render target.

Reimplemented from Ogre::HardwarePixelBuffer.

◆ releaseSurfaces()

void Ogre::D3D9HardwarePixelBuffer::releaseSurfaces ( IDirect3DDevice9 * d3d9Device )

Release surfaces held by this pixel buffer.

◆ destroyBufferResources()

void Ogre::D3D9HardwarePixelBuffer::destroyBufferResources ( IDirect3DDevice9 * d3d9Device )

Destroy resources associated with the given device.

◆ lockDeviceAccess()

static void Ogre::D3D9HardwarePixelBuffer::lockDeviceAccess ( )

static

◆ unlockDeviceAccess()

static void Ogre::D3D9HardwarePixelBuffer::unlockDeviceAccess ( )

static

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

OgreD3D9HardwarePixelBuffer.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ D3D9HardwarePixelBuffer()

◆ ~D3D9HardwarePixelBuffer()

Member Function Documentation

◆ bind() [1/2]

◆ bind() [2/2]

◆ blit()

◆ blitFromMemory()

◆ blitToMemory()

◆ _genMipmaps()

◆ _setMipmapping()

◆ getRenderTarget()

◆ getSurface()

◆ getFSAASurface()

◆ _clearSliceRTT()

◆ releaseSurfaces()

◆ destroyBufferResources()

◆ lockDeviceAccess()

◆ unlockDeviceAccess()