#include <OgreD3D9HardwarePixelBuffer.h>

Inheritance diagram for Ogre::D3D9HardwarePixelBuffer:

[legend]

Classes
struct	BufferResources

Public Types
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 = 5, HBU_DYNAMIC_WRITE_ONLY = 6, HBU_DYNAMIC_WRITE_ONLY_DISCARDABLE = 14 }
	Enums describing buffer usage; not mutually exclusive. More...

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

	~D3D9HardwarePixelBuffer ()

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

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

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

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

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

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

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

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

void	destroyBufferResources (IDirect3DDevice9 *d3d9Device)
	Destroy resources associated with the given device. 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...

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

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

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

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

IDirect3DSurface9 *	getSurface (IDirect3DDevice9 *d3d9Device)
	Accessor for surface. 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 PixelBox &	lock (const Image::Box &lockBox, LockOptions options)
	Lock the buffer for (potentially) reading / writing. More...

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

void *	lock (LockOptions options)
	Lock the entire buffer for (potentially) reading / writing. 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...

void	operator delete (void *ptr)

void	operator delete (void ptr, const char , int, const char *)

void	operator delete (void ptr, void )

void	operator delete[] (void *ptr)

void	operator delete[] (void ptr, const char , int, const char *)

void *	operator new (size_t sz)

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 *ptr)
	placement operator new More...

void *	operator new[] (size_t sz)

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info 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...

void	releaseSurfaces (IDirect3DDevice9 *d3d9Device)
	Release surfaces held by this pixel buffer. 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...

Static Public Member Functions
static void	lockDeviceAccess ()

static void	unlockDeviceAccess ()

Protected Types
typedef DeviceToBufferResourcesMap::iterator	DeviceToBufferResourcesIterator

typedef map< IDirect3DDevice9 , BufferResources >::type	DeviceToBufferResourcesMap

Protected Member Functions
void	blit (IDirect3DDevice9 d3d9Device, const HardwarePixelBufferSharedPtr &src, const Image::Box &srcBox, const Image::Box &dstBox, BufferResources srcBufferResources, BufferResources *dstBufferResources)

void	blitFromMemory (const PixelBox &src, const Image::Box &dstBox, BufferResources *dstBufferResources)

void	blitToMemory (const Image::Box &srcBox, const PixelBox &dst, BufferResources srcBufferResources, IDirect3DDevice9 d3d9Device)

BufferResources *	createBufferResources ()

void	destroyRenderTexture ()
	destroy render texture. More...

BufferResources *	getBufferResources (IDirect3DDevice9 *d3d9Device)

PixelBox	lockBuffer (BufferResources *bufferResources, const Image::Box &lockBox, DWORD flags)

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

	OGRE_STATIC_MUTEX (msDeviceAccessMutex)

void	unlockBuffer (BufferResources *bufferResources)

void	unlockImpl (void)
	Unlock a box. More...

void	updateRenderTexture (bool writeGamma, uint fsaa, const String &srcName)
	updates render texture. More...

Protected Attributes
PixelBox	mCurrentLock
	Currently locked region (local coords) More...

uint32	mDepth

bool	mDoMipmapGen
	Mipmapping. More...

PixelFormat	mFormat
	Internal format. More...

uint32	mHeight

bool	mHWMipmaps

bool	mIsLocked

Image::Box	mLockedBox
	The current locked box of this surface (entire surface coords) More...

DWORD	mLockFlags

size_t	mLockSize

size_t	mLockStart

DeviceToBufferResourcesMap	mMapDeviceToBufferResources
	Map between device to buffer resources. More...

D3D9Texture *	mOwnerTexture

D3D9RenderTexture *	mRenderTexture
	Render target. More...

size_t	mRowPitch
	Pitches (offsets between rows and slices) More...

HardwareBuffer *	mShadowBuffer

bool	mShadowUpdated

size_t	mSizeInBytes

size_t	mSlicePitch

bool	mSuppressHardwareUpdate

bool	mSystemMemory

Usage	mUsage

bool	mUseShadowBuffer

uint32	mWidth
	Extents. More...

Detailed Description

Definition at line 40 of file OgreD3D9HardwarePixelBuffer.h.

Member Typedef Documentation

◆ DeviceToBufferResourcesIterator

typedef DeviceToBufferResourcesMap::iterator Ogre::D3D9HardwarePixelBuffer::DeviceToBufferResourcesIterator

protected

Definition at line 60 of file OgreD3D9HardwarePixelBuffer.h.

◆ DeviceToBufferResourcesMap

typedef map<IDirect3DDevice9*, BufferResources*>::type Ogre::D3D9HardwarePixelBuffer::DeviceToBufferResourcesMap

protected

Definition at line 59 of file OgreD3D9HardwarePixelBuffer.h.

Member Enumeration Documentation

◆ LockOptions

enum Ogre::HardwareBuffer::LockOptions

inherited

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.

◆ Usage

enum Ogre::HardwareBuffer::Usage

inherited

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

◆ D3D9HardwarePixelBuffer()

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

◆ ~D3D9HardwarePixelBuffer()

Ogre::D3D9HardwarePixelBuffer::~D3D9HardwarePixelBuffer ( )

Member Function Documentation

◆ _clearSliceRTT()

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

virtual

Notify TextureBuffer of destruction of render target.

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

◆ _updateFromShadow()

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

virtualinherited

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

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

Definition at line 305 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::lockImpl(), and Ogre::HardwareBuffer::unlockImpl().

◆ 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() [1/3]

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

src	PixelBox containing the source pixels and format in memory

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

◆ blit() [2/3]

void Ogre::D3D9HardwarePixelBuffer::blit	(	const HardwarePixelBufferSharedPtr &	src,
		const Image::Box &	srcBox,
		const Image::Box &	dstBox
	)

virtual

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

Parameters

src	Source pixel buffer
srcBox	Image::Box describing the source region in src
dstBox	Image::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.

◆ blit() [3/3]

void Ogre::D3D9HardwarePixelBuffer::blit	(	IDirect3DDevice9 *	d3d9Device,
		const HardwarePixelBufferSharedPtr &	src,
		const Image::Box &	srcBox,
		const Image::Box &	dstBox,
		BufferResources *	srcBufferResources,
		BufferResources *	dstBufferResources
	)

protected

◆ blitFromMemory() [1/3]

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

inherited

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.

Definition at line 149 of file OgreHardwarePixelBuffer.h.

◆ blitFromMemory() [2/3]

void Ogre::D3D9HardwarePixelBuffer::blitFromMemory	(	const PixelBox &	src,
		const Image::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	Image::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.

◆ blitFromMemory() [3/3]

void Ogre::D3D9HardwarePixelBuffer::blitFromMemory	(	const PixelBox &	src,
		const Image::Box &	dstBox,
		BufferResources *	dstBufferResources
	)

protected

◆ blitToMemory() [1/3]

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

virtual

Copies a region of this pixelbuffer to normal memory.

Parameters

srcBox	Image::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.

◆ blitToMemory() [2/3]

void Ogre::D3D9HardwarePixelBuffer::blitToMemory	(	const Image::Box &	srcBox,
		const PixelBox &	dst,
		BufferResources *	srcBufferResources,
		IDirect3DDevice9 *	d3d9Device
	)

protected

◆ blitToMemory() [3/3]

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

inherited

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.

Definition at line 168 of file OgreHardwarePixelBuffer.h.

◆ copyData() [1/2]

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

virtualinherited

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 298 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::getSizeInBytes().

◆ copyData() [2/2]

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

virtualinherited

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

srcBuffer	The buffer from which to read the copied data
srcOffset	Offset in the source buffer at which to start reading
dstOffset	Offset in the destination buffer to start writing
length	Length of the data to copy, in bytes.
discardWholeBuffer	If true, will discard the entire contents of this buffer before copying

Reimplemented in Ogre::D3D11HardwareBuffer, Ogre::GL3PlusHardwareVertexBuffer, Ogre::GL3PlusHardwareIndexBuffer, Ogre::GLES2HardwareUniformBuffer, Ogre::GL3PlusHardwareUniformBuffer, Ogre::GL3PlusHardwareCounterBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.

Definition at line 284 of file OgreHardwareBuffer.h.

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

◆ createBufferResources()

BufferResources* Ogre::D3D9HardwarePixelBuffer::createBufferResources ( )

protected

◆ destroyBufferResources()

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

Destroy resources associated with the given device.

◆ destroyRenderTexture()

void Ogre::D3D9HardwarePixelBuffer::destroyRenderTexture ( )

protected

destroy render texture.

◆ getBufferResources()

BufferResources* Ogre::D3D9HardwarePixelBuffer::getBufferResources ( IDirect3DDevice9 * d3d9Device )

protected

◆ getCurrentLock()

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

◆ getDepth()

uint32 Ogre::HardwarePixelBuffer::getDepth ( ) const

inherited

Gets the depth of this buffer.

Definition at line 187 of file OgreHardwarePixelBuffer.h.

◆ getFormat()

PixelFormat Ogre::HardwarePixelBuffer::getFormat ( ) const

inherited

Gets the native pixel format of this buffer.

Definition at line 189 of file OgreHardwarePixelBuffer.h.

◆ getFSAASurface()

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

Accessor for AA surface.

◆ getHeight()

uint32 Ogre::HardwarePixelBuffer::getHeight ( ) const

inherited

Gets the height of this buffer.

Definition at line 185 of file OgreHardwarePixelBuffer.h.

◆ getRenderTarget()

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

virtual

Get rendertarget for z slice.

Reimplemented from Ogre::HardwarePixelBuffer.

◆ getSizeInBytes()

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

inherited

Returns the size of this buffer in bytes.

Definition at line 330 of file OgreHardwareBuffer.h.

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

◆ getSurface()

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

Accessor for surface.

◆ getUsage()

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

inherited

Returns the Usage flags with which this buffer was created.

Definition at line 332 of file OgreHardwareBuffer.h.

◆ getWidth()

uint32 Ogre::HardwarePixelBuffer::getWidth ( ) const

inherited

Gets the width of this buffer.

Definition at line 183 of file OgreHardwarePixelBuffer.h.

◆ hasShadowBuffer()

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

inherited

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

Definition at line 336 of file OgreHardwareBuffer.h.

◆ isLocked()

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

inherited

Returns whether or not this buffer is currently locked.

Definition at line 338 of file OgreHardwareBuffer.h.

References Ogre::HardwareBuffer::isLocked().

Referenced by Ogre::HardwareBuffer::isLocked(), and Ogre::HardwareBuffer::unlock().

◆ isSystemMemory()

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

inherited

Returns whether this buffer is held in system memory.

Definition at line 334 of file OgreHardwareBuffer.h.

◆ lock() [1/5]

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

virtualinherited

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/5]

void* Ogre::HardwareBuffer::lock

inherited

Make every lock method from HardwareBuffer available.

See http://www.research.att.com/~bs/bs_faq2.html#overloadderived

Definition at line 220 of file OgreHardwareBuffer.h.

◆ lock() [3/5]

void* Ogre::HardwareBuffer::lock ( LockOptions options )

inherited

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

Parameters

options Locking options

Returns: Pointer to the locked memory

Definition at line 220 of file OgreHardwareBuffer.h.

◆ lock() [4/5]

virtual void* Ogre::HardwareBuffer::lock

inherited

Make every lock method from HardwareBuffer available.

See http://www.research.att.com/~bs/bs_faq2.html#overloadderived

Definition at line 183 of file OgreHardwareBuffer.h.

◆ lock() [5/5]

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

virtualinherited

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

Reimplemented from Ogre::HardwareBuffer.

◆ lockBuffer()

PixelBox Ogre::D3D9HardwarePixelBuffer::lockBuffer	(	BufferResources *	bufferResources,
		const Image::Box &	lockBox,
		DWORD	flags
	)

protected

◆ lockDeviceAccess()

static void Ogre::D3D9HardwarePixelBuffer::lockDeviceAccess ( )

static

◆ lockImpl() [1/2]

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

protectedvirtual

Lock a box.

Implements Ogre::HardwarePixelBuffer.

◆ lockImpl() [2/2]

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.

template<class Alloc >

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

inherited

operator new, with debug line info

Definition at line 68 of file OgreMemoryAllocatedObject.h.

◆ operator new() [3/3]

template<class Alloc >

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

inherited

placement operator new

Definition at line 79 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [1/2]

template<class Alloc >

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

inherited

Definition at line 91 of file OgreMemoryAllocatedObject.h.

◆ operator new[]() [2/2]

template<class Alloc >

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

inherited

array operator new, with debug line info

Definition at line 86 of file OgreMemoryAllocatedObject.h.

◆ readData()

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

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!

Implements Ogre::HardwareBuffer.

◆ releaseSurfaces()

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

Release surfaces held by this pixel buffer.

◆ suppressHardwareUpdate()

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

inherited

Pass true to suppress hardware upload of shadow buffer changes.

Definition at line 342 of file OgreHardwareBuffer.h.

◆ unlock()

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

virtualinherited

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::GL3PlusDefaultHardwareVertexBuffer, Ogre::GLDefaultHardwareVertexBuffer, Ogre::GLESDefaultHardwareVertexBuffer, Ogre::GLES2DefaultHardwareVertexBuffer, Ogre::D3D11HardwareIndexBuffer, Ogre::D3D11HardwareUniformBuffer, and Ogre::D3D11HardwareVertexBuffer.

Definition at line 236 of file OgreHardwareBuffer.h.

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

Referenced by Ogre::HardwareBuffer::copyData(), and Ogre::HardwareBuffer::unlock().

◆ unlockBuffer()

void Ogre::D3D9HardwarePixelBuffer::unlockBuffer ( BufferResources * bufferResources )

protected

◆ unlockDeviceAccess()

static void Ogre::D3D9HardwarePixelBuffer::unlockDeviceAccess ( )

static

◆ unlockImpl()

void Ogre::D3D9HardwarePixelBuffer::unlockImpl ( void )

protectedvirtual

Unlock a box.

Implements Ogre::HardwareBuffer.

◆ updateRenderTexture()

void Ogre::D3D9HardwarePixelBuffer::updateRenderTexture	(	bool	writeGamma,
		uint	fsaa,
		const String &	srcName
	)

protected

updates render texture.

◆ writeData()

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

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.

Implements Ogre::HardwareBuffer.

Member Data Documentation

◆ mCurrentLock

bool Ogre::HardwareBuffer::mIsLocked

protectedinherited

Definition at line 145 of file OgreHardwareBuffer.h.

◆ mLockedBox

Image::Box Ogre::HardwarePixelBuffer::mLockedBox

protectedinherited

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

Definition at line 65 of file OgreHardwarePixelBuffer.h.

◆ mLockFlags

DWORD Ogre::D3D9HardwarePixelBuffer::mLockFlags

protected

Definition at line 76 of file OgreD3D9HardwarePixelBuffer.h.

◆ mLockSize

size_t Ogre::HardwareBuffer::mLockSize

protectedinherited

Definition at line 147 of file OgreHardwareBuffer.h.

◆ mLockStart

size_t Ogre::HardwareBuffer::mLockStart

protectedinherited

Definition at line 146 of file OgreHardwareBuffer.h.

◆ mMapDeviceToBufferResources

DeviceToBufferResourcesMap Ogre::D3D9HardwarePixelBuffer::mMapDeviceToBufferResources

protected

Map between device to buffer resources.

Definition at line 63 of file OgreD3D9HardwarePixelBuffer.h.

◆ mOwnerTexture

D3D9Texture* Ogre::D3D9HardwarePixelBuffer::mOwnerTexture

protected

Definition at line 73 of file OgreD3D9HardwarePixelBuffer.h.

◆ mRenderTexture

D3D9RenderTexture* Ogre::D3D9HardwarePixelBuffer::mRenderTexture

protected

Render target.

Definition at line 70 of file OgreD3D9HardwarePixelBuffer.h.

◆ mRowPitch

size_t Ogre::HardwarePixelBuffer::mRowPitch

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

OgreD3D9HardwarePixelBuffer.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ DeviceToBufferResourcesIterator

◆ DeviceToBufferResourcesMap

Member Enumeration Documentation

◆ LockOptions

◆ Usage

Constructor & Destructor Documentation

◆ D3D9HardwarePixelBuffer()

◆ ~D3D9HardwarePixelBuffer()

Member Function Documentation

◆ _clearSliceRTT()

◆ _genMipmaps()

◆ _setMipmapping()

◆ _updateFromShadow()

◆ bind() [1/2]

◆ bind() [2/2]

◆ blit() [1/3]

◆ blit() [2/3]

◆ blit() [3/3]

◆ blitFromMemory() [1/3]

◆ blitFromMemory() [2/3]

◆ blitFromMemory() [3/3]

◆ blitToMemory() [1/3]

◆ blitToMemory() [2/3]

◆ blitToMemory() [3/3]

◆ copyData() [1/2]

◆ copyData() [2/2]

◆ createBufferResources()

◆ destroyBufferResources()

◆ destroyRenderTexture()

◆ getBufferResources()

◆ getCurrentLock()

◆ getDepth()

◆ getFormat()

◆ getFSAASurface()

◆ getHeight()

◆ getRenderTarget()

◆ getSizeInBytes()

◆ getSurface()

◆ getUsage()

◆ getWidth()

◆ hasShadowBuffer()

◆ isLocked()

◆ isSystemMemory()

◆ lock() [1/5]

◆ lock() [2/5]

◆ lock() [3/5]

◆ lock() [4/5]

◆ lock() [5/5]

◆ lockBuffer()

◆ lockDeviceAccess()

◆ lockImpl() [1/2]

◆ lockImpl() [2/2]

◆ OGRE_STATIC_MUTEX()

◆ operator delete() [1/3]

◆ operator delete() [2/3]

◆ operator delete() [3/3]

◆ operator delete[]() [1/2]

◆ operator delete[]() [2/2]

◆ operator new() [1/3]

◆ operator new() [2/3]

◆ operator new() [3/3]

◆ operator new[]() [1/2]

◆ operator new[]() [2/2]

◆ readData()

◆ releaseSurfaces()

◆ suppressHardwareUpdate()

◆ unlock()

◆ unlockBuffer()

◆ unlockDeviceAccess()

◆ unlockImpl()

◆ updateRenderTexture()