Ogre::MetalMultiRenderTarget Class Reference

#include <OgreMetalMultiRenderTarget.h>

Inheritance diagram for Ogre::MetalMultiRenderTarget:

Public Member Functions
	MetalMultiRenderTarget (const String &name)
virtual	~MetalMultiRenderTarget ()
virtual void	bindSurfaceImpl (size_t attachment, RenderTexture *target)
	Implementation of bindSurface, must be provided. More...
virtual void	getCustomAttribute (const String &name, void *pData)
	Retrieve a platform or API-specific piece of information. More...
virtual bool	requiresTextureFlipping () const
virtual void	unbindSurfaceImpl (size_t attachment)
	Implementation of unbindSurface, must be provided. More...
Public Member Functions inherited from Ogre::MultiRenderTarget
	MultiRenderTarget (const String &name)
virtual void	bindSurface (size_t attachment, RenderTexture *target)
	Bind a surface to a certain attachment point. More...
virtual void	copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer=FB_AUTO)
	Error throwing implementation, it's not possible to write a MultiRenderTarget to disk. More...
virtual void	copyContentsToMemory (const Box &src, const PixelBox &dst, FrameBuffer buffer=FB_AUTO)=0
	Copies the current contents of the render target to a pixelbox. More...
void	copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
RenderTexture *	getBoundSurface (size_t index)
	Get a pointer to a bound surface. More...
const BoundSufaceList &	getBoundSurfaceList () const
	Get a list of the surfaces which have been bound. More...
PixelFormat	suggestPixelFormat () const
	Irrelevant implementation since cannot copy. More...
virtual void	unbindSurface (size_t attachment)
	Unbind attachment. More...
Public Member Functions inherited from Ogre::RenderTarget
	RenderTarget ()
virtual	~RenderTarget ()
virtual void	_beginUpdate ()
	Method for manual management of rendering : fires 'preRenderTargetUpdate' and initialises statistics etc. More...
virtual void	_detachDepthBuffer ()
	Detaches DepthBuffer without notifying it from the detach. More...
virtual void	_endUpdate ()
	Method for manual management of rendering - finishes statistics calculation and fires 'postRenderTargetUpdate'. More...
virtual Impl *	_getImpl ()
virtual void	_notifyCameraRemoved (const Camera *cam)
	Utility method to notify a render target that a camera has been removed, incase it was referring to it as a viewer. More...
virtual void	_updateAutoUpdatedViewports (bool updateStatistics=true)
	Method for manual management of rendering - renders only viewports that are auto updated. More...
virtual void	_updateViewport (int zorder, bool updateStatistics=true)
	Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More...
virtual void	_updateViewport (Viewport *viewport, bool updateStatistics=true)
	Method for manual management of rendering - renders the given viewport (even if it is not autoupdated) More...
virtual void	addListener (RenderTargetListener *listener)
	Add a listener to this RenderTarget which will be called back before & after rendering. More...
virtual Viewport *	addViewport (Camera *cam, int ZOrder=0, float left=0.0f, float top=0.0f, float width=1.0f, float height=1.0f)
	Adds a viewport to the rendering target. More...
virtual bool	attachDepthBuffer (DepthBuffer *depthBuffer)
void	copyContentsToMemory (const PixelBox &dst, FrameBuffer buffer=FB_AUTO)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
virtual void	detachDepthBuffer ()
virtual uint32	getColourDepth (void) const
uint	getCustomAttribute (const String &name)
	simplified API for bindings More...
DepthBuffer *	getDepthBuffer () const
uint16	getDepthBufferPool () const
virtual uint	getFSAA () const
	Indicates whether multisampling is performed on rendering and at what level. More...
virtual const String &	getFSAAHint () const
	RenderSystem specific FSAA option. See RenderSystem::_createRenderWindow for details. More...
virtual uint32	getHeight (void) const
virtual void	getMetrics (unsigned int &width, unsigned int &height, unsigned int &colourDepth)
	Retrieve information about the render target. More...
virtual const String &	getName (void) const
	Retrieve target's name. More...
virtual unsigned short	getNumViewports (void) const
	Returns the number of viewports attached to this target. More...
virtual uchar	getPriority () const
	Gets the priority of a render target. More...
const FrameStats &	getStatistics (void) const
	Retieves details of current rendering performance. More...
virtual Viewport *	getViewport (unsigned short index)
	Retrieves a pointer to the viewport with the given index. More...
virtual Viewport *	getViewportByZOrder (int ZOrder)
	Retrieves a pointer to the viewport with the given Z-order. More...
virtual uint32	getWidth (void) const
virtual bool	hasViewportWithZOrder (int ZOrder)
	Returns true if and only if a viewport exists at the given Z-order. More...
virtual void	insertListener (RenderTargetListener *listener, const unsigned int pos=0)
	same as addListener, but force the position in the vector, so we can control the call order More...
virtual bool	isActive () const
	Used to retrieve or set the active state of the render target. More...
virtual bool	isAutoUpdated (void) const
	Gets whether this target is automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More...
virtual bool	isHardwareGammaEnabled () const
	Indicates whether on rendering, linear colour space is converted to sRGB gamma colour space. More...
virtual bool	isPrimary (void) const
	Indicates whether this target is the primary window. More...
virtual bool	isStereoEnabled (void) const
	Indicates whether stereo is currently enabled for this target. More...
virtual void	removeAllListeners (void)
	Removes all listeners from this instance. More...
virtual void	removeAllViewports (void)
	Removes all viewports on this target. More...
virtual void	removeListener (RenderTargetListener *listener)
	Removes a RenderTargetListener previously registered using addListener. More...
virtual void	removeViewport (int ZOrder)
	Removes a viewport at a given Z-order. More...
void	resetStatistics (void)
	Resets saved frame-rate statistices. More...
virtual void	setActive (bool state)
	Used to set the active state of the render target. More...
virtual void	setAutoUpdated (bool autoupdate)
	Sets whether this target should be automatically updated if Ogre's rendering loop or Root::_updateAllRenderTargets is being used. More...
void	setDepthBufferPool (uint16 poolId)
	Sets the pool ID this RenderTarget should query from. More...
virtual void	setFSAA (uint fsaa, const String &fsaaHint)
	Set the level of multisample AA to be used if hardware support it. More...
virtual void	setPriority (uchar priority)
	Sets the priority of this render target in relation to the others. More...
virtual void	swapBuffers ()
	Swaps the frame buffers to display the next frame. More...
virtual void	update (bool swapBuffers=true)
	Tells the target to update it's contents. More...
void	writeContentsToFile (const String &filename)
	Writes the current contents of the render target to the named file. More...
virtual String	writeContentsToTimestampedFile (const String &filenamePrefix, const String &filenameSuffix)
	Writes the current contents of the render target to the (PREFIX)(time-stamp)(SUFFIX) file. More...

Additional Inherited Members
Public Types inherited from Ogre::MultiRenderTarget
typedef std::vector< RenderTexture * >	BoundSufaceList
Public Types inherited from Ogre::RenderTarget
enum	FrameBuffer { FB_FRONT, FB_BACK, FB_AUTO }
enum	StatFlags {   SF_NONE = 0, SF_FPS = 1, SF_AVG_FPS = 2, SF_BEST_FPS = 4,   SF_WORST_FPS = 8, SF_TRIANGLE_COUNT = 16, SF_ALL = 0xFFFF }

Constructor & Destructor Documentation

MetalMultiRenderTarget()

Ogre::MetalMultiRenderTarget::MetalMultiRenderTarget

(

const String &

name

)

~MetalMultiRenderTarget()

virtual Ogre::MetalMultiRenderTarget::~MetalMultiRenderTarget ( )

virtual

Member Function Documentation

bindSurfaceImpl()

virtual void Ogre::MetalMultiRenderTarget::bindSurfaceImpl ( size_t  attachment, RenderTexture *  target  )

virtual

Implementation of bindSurface, must be provided.

Implements Ogre::MultiRenderTarget.

unbindSurfaceImpl()

virtual void Ogre::MetalMultiRenderTarget::unbindSurfaceImpl ( size_t  attachment )

virtual

Implementation of unbindSurface, must be provided.

Implements Ogre::MultiRenderTarget.

requiresTextureFlipping()

virtual bool Ogre::MetalMultiRenderTarget::requiresTextureFlipping ( ) const

inlinevirtual

Implements Ogre::RenderTarget.

getCustomAttribute()

virtual void Ogre::MetalMultiRenderTarget::getCustomAttribute ( const String &  name, void *  pData  )

virtual

Retrieve a platform or API-specific piece of information.

This method of retrieving information should only be used if you know what you're doing.

Name	Description
WINDOW	The native window handle. (X11 Window XID/ HWND / NSWindow*)
HWND	deprecated (same as WINDOW)
GL_FBOID	the id of the OpenGL framebuffer object
GL_MULTISAMPLEFBOID	the id of the OpenGL framebuffer object used for multisampling
GLFBO	id of the screen OpenGL framebuffer object on iOS
GLCONTEXT	deprecated, do not use
FBO	deprecated, do not use
TARGET	deprecated, do not use
XDISPLAY	The X Display connection behind that context.
DISPLAYNAME	The X Server name for the connected display.
ATOM	The X Atom used in client delete events.
VIEW	Cocoa NSView*
NSOPENGLCONTEXT	Cocoa NSOpenGLContext*
NSOPENGLPIXELFORMAT	Cocoa NSOpenGLPixelFormat*

Parameters

name	The name of the attribute.
pData	Pointer to memory of the right kind of structure to receive the info.

Reimplemented from Ogre::RenderTarget.

---

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

• OgreMetalMultiRenderTarget.h