#include <OgreD3D11HardwarePixelBuffer.h>

Inheritance diagram for Ogre::D3D11HardwarePixelBuffer:

Public Member Functions
	D3D11HardwarePixelBuffer (D3D11Texture *parentTexture, D3D11Device &device, UINT mipLevel, size_t width, size_t height, size_t depth, UINT face, PixelFormat format, HardwareBuffer::Usage usage)

	~D3D11HardwarePixelBuffer ()

void	_genMipmaps ()
	Internal function to update mipmaps on update of level 0. 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...

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

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

UINT	getFace () const

D3D11Texture *	getParentTexture () const

D3D11_BOX	getSubresourceBox (const Box &box) const

UINT	getSubresourceIndex (size_t box_front) const

Public Member Functions inherited from Ogre::HardwarePixelBuffer
	HardwarePixelBuffer (uint32 mWidth, uint32 mHeight, uint32 mDepth, PixelFormat mFormat, HardwareBuffer::Usage usage, 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 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...

Constructor & Destructor Documentation

◆ D3D11HardwarePixelBuffer()

Ogre::D3D11HardwarePixelBuffer::D3D11HardwarePixelBuffer	(	D3D11Texture *	parentTexture,
		D3D11Device &	device,
		UINT	mipLevel,
		size_t	width,
		size_t	height,
		size_t	depth,
		UINT	face,
		PixelFormat	format,
		HardwareBuffer::Usage	usage
	)

◆ ~D3D11HardwarePixelBuffer()

Ogre::D3D11HardwarePixelBuffer::~D3D11HardwarePixelBuffer ( )

Member Function Documentation

◆ blit()

void Ogre::D3D11HardwarePixelBuffer::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::D3D11HardwarePixelBuffer::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::D3D11HardwarePixelBuffer::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::D3D11HardwarePixelBuffer::_genMipmaps ( )

Internal function to update mipmaps on update of level 0.

◆ getParentTexture()

D3D11Texture* Ogre::D3D11HardwarePixelBuffer::getParentTexture ( ) const

◆ getFace()

UINT Ogre::D3D11HardwarePixelBuffer::getFace ( ) const

◆ getSubresourceIndex()

UINT Ogre::D3D11HardwarePixelBuffer::getSubresourceIndex ( size_t box_front ) const

◆ getSubresourceBox()

D3D11_BOX Ogre::D3D11HardwarePixelBuffer::getSubresourceBox ( const Box & box ) const

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

OgreD3D11HardwarePixelBuffer.h

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ D3D11HardwarePixelBuffer()

◆ ~D3D11HardwarePixelBuffer()

Member Function Documentation

◆ blit()

◆ blitFromMemory()

◆ blitToMemory()

◆ _genMipmaps()

◆ getParentTexture()

◆ getFace()

◆ getSubresourceIndex()

◆ getSubresourceBox()