Ogre::MetalTextureBuffer Class Reference

Texture surface. More...

#include <OgreMetalHardwarePixelBuffer.h>

Inheritance diagram for Ogre::MetalTextureBuffer:

Public Member Functions
	MetalTextureBuffer (__unsafe_unretained id< MTLTexture > renderTexture, __unsafe_unretained id< MTLTexture > resolveTexture, MetalDevice *device, const String &baseName, MTLTextureType target, int width, int height, int depth, PixelFormat format, int face, int level, Usage usage, bool writeGamma, uint fsaa)
	Texture constructor. More...
virtual	~MetalTextureBuffer ()
void	bindToFramebuffer (uint32 attachment, size_t zoffset) override
	Bind surface to frame buffer. More...
void	blit (const HardwarePixelBufferSharedPtr &src, const Box &srcBox, const Box &dstBox) override
	Copies a box from another PixelBuffer to a region of the this PixelBuffer. More...
void	blitFromMemory (const PixelBox &src_orig, const Box &dstBox) override
	Hardware implementation of blitFromMemory. More...
void	blitFromTexture (MetalTextureBuffer *src, const Box &srcBox, const Box &dstBox)
void	copyFromFramebuffer (size_t zoffset)
	Lock a box. More...
void	download (const PixelBox &data) override
	Download a box of pixels from the card. More...
void	upload (const PixelBox &data, const Box &dest) override
	Upload a box of pixels to this buffer on the card. More...
Public Member Functions inherited from Ogre::MetalHardwarePixelBuffer
	MetalHardwarePixelBuffer (uint32 width, uint32 height, uint32 depth, PixelFormat format, bool hwGamma, HardwareBuffer::Usage usage)
	Should be called by HardwareBufferManager. More...
virtual	~MetalHardwarePixelBuffer ()
void	blitToMemory (const Box &srcBox, const PixelBox &dst) override
	Copies a region of this pixelbuffer to normal memory. More...
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...

Detailed Description

Texture surface.

Constructor & Destructor Documentation

MetalTextureBuffer()

Ogre::MetalTextureBuffer::MetalTextureBuffer	(	__unsafe_unretained id< MTLTexture >	renderTexture,
		__unsafe_unretained id< MTLTexture >	resolveTexture,
		MetalDevice *	device,
		const String &	baseName,
		MTLTextureType	target,
		int	width,
		int	height,
		int	depth,
		PixelFormat	format,
		int	face,
		int	level,
		Usage	usage,
		bool	writeGamma,
		uint	fsaa
	)

Texture constructor.

~MetalTextureBuffer()

virtual Ogre::MetalTextureBuffer::~MetalTextureBuffer ( )

virtual

Member Function Documentation

bindToFramebuffer()

void Ogre::MetalTextureBuffer::bindToFramebuffer ( uint32  attachment, size_t  zoffset  )

overridevirtual

Bind surface to frame buffer.

Needs FBO extension.

Reimplemented from Ogre::MetalHardwarePixelBuffer.

upload()

void Ogre::MetalTextureBuffer::upload ( const PixelBox &  data, const Box &  dest  )

overridevirtual

Upload a box of pixels to this buffer on the card.

Reimplemented from Ogre::MetalHardwarePixelBuffer.

download()

void Ogre::MetalTextureBuffer::download ( const PixelBox &  data )

overridevirtual

Download a box of pixels from the card.

Reimplemented from Ogre::MetalHardwarePixelBuffer.

blitFromMemory()

void Ogre::MetalTextureBuffer::blitFromMemory ( const PixelBox &  src_orig, const Box &  dstBox  )

overridevirtual

Hardware implementation of blitFromMemory.

Reimplemented from Ogre::MetalHardwarePixelBuffer.

copyFromFramebuffer()

void Ogre::MetalTextureBuffer::copyFromFramebuffer

(

size_t

zoffset

)

Lock a box.

blit()

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

overridevirtual

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.

blitFromTexture()

void Ogre::MetalTextureBuffer::blitFromTexture	(	MetalTextureBuffer *	src,
		const Box &	srcBox,
		const Box &	dstBox
	)

---

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

• OgreMetalHardwarePixelBuffer.h