Implementation of Metal as a rendering system. More...

#include <OgreMetalRenderSystem.h>

Inheritance diagram for Ogre::MetalRenderSystem:

Public Member Functions
	MetalRenderSystem ()

virtual	~MetalRenderSystem ()

virtual void	_beginFrame (void)
	Signifies the beginning of a frame, i.e. More...

virtual void	_convertProjectionMatrix (const Matrix4 &matrix, Matrix4 &dest, bool forGpuProgram=false)
	Converts a uniform projection matrix to suitable for this render system. More...

virtual DepthBuffer *	_createDepthBufferFor (RenderTarget *renderTarget)
	Creates a DepthBuffer that can be attached to the specified RenderTarget. More...

virtual RenderWindow *	_createRenderWindow (const String &name, unsigned int width, unsigned int height, bool fullScreen, const NameValuePairList *miscParams=0)
	Creates a new rendering window. More...

virtual void	_endFrame (void)
	Ends rendering of a frame to the current viewport. More...

void	_notifyActiveComputeEnded (void)

void	_notifyActiveEncoderEnded (void)

virtual void	_notifyCompositorNodeSwitchedRenderTarget (RenderTarget *previousTarget)

void	_notifyDeviceStalled (void)

virtual void	_render (const RenderOperation &op)
	Render something to the active viewport. More...

void	_setAlphaRejectSettings (CompareFunction func, unsigned char value, bool alphaToCoverage)
	Sets the global alpha rejection approach for future renders. More...

void	_setCullingMode (CullingMode mode)
	Sets the culling mode for the render system based on the 'vertex winding'. More...

void	_setDepthBias (float constantBias, float slopeScaleBias=0.0f)
	Sets the depth bias, NB you should use the Material version of this. More...

void	_setDepthBufferParams (bool depthTest=true, bool depthWrite=true, CompareFunction depthFunction=CMPF_LESS_EQUAL)
	Sets the mode of operation for depth buffer tests from this point onwards. More...

void	_setDepthClamp (bool enable)
	Clamp depth values to near and far plane rather than discarding. More...

void	_setPolygonMode (PolygonMode level)
	Sets how to rasterise triangles, as points, wireframe or solid polys. More...

virtual void	_setRenderTarget (RenderTarget *target)
	Set current render target to target, enabling its device context if needed. More...

void	_setSampler (size_t texUnit, Sampler &s)
	set the sampler settings for the given texture unit More...

virtual void	_setTexture (size_t unit, bool enabled, const TexturePtr &texPtr)
	Sets the texture to bind to a given texture unit. More...

virtual void	_setViewport (Viewport *vp)
	Sets the provided viewport as the active one for future rendering operations. More...

virtual void	_waitForTailFrameToFinish (void)
	See VaoManager::waitForTailFrameToFinish. More...

virtual bool	_willTailFrameStall (void)

void	applyFixedFunctionParams (const GpuProgramParametersPtr &params, uint16 mask)

virtual void	beginGPUSampleProfile (const String &name, uint32 *hashCache)

virtual void	beginProfileEvent (const String &eventName)
	This marks the beginning of an event for GPU profiling. More...

void	bindGpuProgram (GpuProgram *prg)
	Binds a given GpuProgram (but not the parameters). More...

virtual void	bindGpuProgramParameters (GpuProgramType gptype, const GpuProgramParametersPtr &params, uint16 variabilityMask)
	Bind Gpu program parameters. More...

virtual void	clearFrameBuffer (unsigned int buffers, const ColourValue &colour=ColourValue::Black, Real depth=1.0f, unsigned short stencil=0)
	Clears one or more frame buffers on the active render target. More...

virtual HardwareOcclusionQuery *	createHardwareOcclusionQuery (void)
	Create an object for performing hardware occlusion queries. More...

virtual MultiRenderTarget *	createMultiRenderTarget (const String &name)
	Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once. More...

virtual RenderSystemCapabilities *	createRenderSystemCapabilities (void) const
	Query the real capabilities of the GPU and driver in the RenderSystem. More...

virtual void	deinitGPUProfiling (void)

virtual void	discardFrameBuffer (unsigned int buffers)

virtual void	endGPUSampleProfile (const String &name)

virtual void	endProfileEvent (void)
	Ends the currently active GPU profiling event. More...

MetalDevice *	getActiveDevice (void)

const GpuProgramParametersPtr &	getFixedFunctionParams (TrackVertexColourType tracking, FogMode fog)

virtual const String &	getFriendlyName (void) const

virtual Real	getMaximumDepthInputValue (void)
	Gets the maximum (farthest) depth value to be used when rendering using identity transforms. More...

virtual Real	getMinimumDepthInputValue (void)
	Gets the minimum (closest) depth value to be used when rendering using identity transforms. More...

virtual const String &	getName (void) const
	Returns the name of the rendering system. More...

void	initConfigOptions ()

virtual void	initGPUProfiling (void)

virtual void	initialiseFromRenderSystemCapabilities (RenderSystemCapabilities caps, RenderTarget primary)
	Initialize the render system from the capabilities. More...

virtual void	markProfileEvent (const String &event)
	Marks an instantaneous event for graphics profilers. More...

void	setColourBlendState (const ColourBlendState &state)
	Sets the global blending factors for combining subsequent renders with the existing frame contents. More...

virtual void	setConfigOption (const String &name, const String &value)
	Sets an option for this API. More...

void	setScissorTest (bool enabled, const Rect &rect)
	Sets the 'scissor region' i.e. More...

void	setStencilBufferParams (CompareFunction func=CMPF_ALWAYS_PASS, uint32 refValue=0, uint32 compareMask=0xFFFFFFFF, uint32 writeMask=0xFFFFFFFF, StencilOperation stencilFailOp=SOP_KEEP, StencilOperation depthFailOp=SOP_KEEP, StencilOperation passOp=SOP_KEEP, bool twoSidedOperation=false, bool readBackAsTexture=false)
	This method allows you to set all the stencil buffer parameters in one call. More...

void	setStencilCheckEnabled (bool enabled)
	Turns stencil buffer checking on or off. More...

virtual void	shutdown (void)
	Shutdown the renderer and cleanup resources. More...

Public Member Functions inherited from Ogre::RenderSystem
	RenderSystem ()
	Default Constructor. More...

virtual	~RenderSystem ()
	Destructor. More...

virtual void	_beginGeometryCount (void)
	The RenderSystem will keep a count of tris rendered, this resets the count. More...

void	_cleanupDepthBuffers (bool bCleanManualBuffers=true)
	Removes all depth buffers. More...

bool	_createRenderWindows (const RenderWindowDescriptionList &renderWindowDescriptions, RenderWindowList &createdWindows)

virtual void	_disableTextureUnit (size_t texUnit)
	Turns off a texture unit. More...

virtual void	_disableTextureUnitsFrom (size_t texUnit)
	Disables all texture units from the given unit upwards. More...

virtual void	_dispatchCompute (const Vector3i &workgroupDim)

virtual unsigned int	_getBatchCount (void) const
	Reports the number of batches rendered since the last _beginGeometryCount call. More...

virtual CullingMode	_getCullingMode (void) const

const String &	_getDefaultViewportMaterialScheme (void) const
	Returns the default material scheme used by the render system. More...

virtual unsigned int	_getFaceCount (void) const
	Reports the number of tris rendered since the last _beginGeometryCount call. More...

virtual unsigned int	_getVertexCount (void) const
	Reports the number of vertices passed to the renderer since the last _beginGeometryCount call. More...

virtual Viewport *	_getViewport (void)
	Get the current active viewport for rendering. More...

virtual void	_initialise ()
	Start up the renderer using the settings selected (Or the defaults if none have been selected). More...

void	_initRenderTargets (void)
	Utility method for initialising all render targets attached to this rendering system. More...

void	_notifyCameraRemoved (const Camera *cam)
	Utility method to notify all render targets that a camera has been removed, in case they were referring to it as their viewer. More...

virtual RenderSystemContext *	_pauseFrame (void)
	Pause rendering for a frame. More...

virtual void	_resumeFrame (RenderSystemContext *context)
	Resume rendering for a frame. More...

void	_setColourBufferWriteEnabled (bool red, bool green, bool blue, bool alpha)

virtual void	_setDepthBufferCheckEnabled (bool enabled=true)

virtual void	_setDepthBufferFunction (CompareFunction func=CMPF_LESS_EQUAL)

virtual void	_setDepthBufferWriteEnabled (bool enabled=true)

void	_setFog (FogMode f)

virtual void	_setLineWidth (float width)
	Set the line width when drawing as RenderOperation::OT_LINE_LIST/ RenderOperation::OT_LINE_STRIP. More...

virtual void	_setPointParameters (bool attenuationEnabled, Real minSize, Real maxSize)

virtual void	_setPointSpritesEnabled (bool enabled)
	Sets whether or not rendering points using OT_POINT_LIST will render point sprites (textured quads) or plain points. More...

void	_setProjectionMatrix (Matrix4 m)

void	_setSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendOperation op=SBO_ADD)

void	_setSeparateSceneBlending (SceneBlendFactor sourceFactor, SceneBlendFactor destFactor, SceneBlendFactor sourceFactorAlpha, SceneBlendFactor destFactorAlpha, SceneBlendOperation op=SBO_ADD, SceneBlendOperation alphaOp=SBO_ADD)

virtual void	_setTextureAddressingMode (size_t unit, const Sampler::UVWAddressingMode &uvw)

virtual void	_setTextureBlendMode (size_t unit, const LayerBlendModeEx &bm)
	Sets the texture blend modes from a TextureUnitState record. More...

virtual void	_setTextureCoordCalculation (size_t unit, TexCoordCalcMethod m, const Frustum *frustum=0)
	Sets a method for automatically calculating texture coordinates for a stage. More...

virtual void	_setTextureCoordSet (size_t unit, size_t index)
	Sets the texture coordinate set to use for a texture unit. More...

virtual void	_setTextureMatrix (size_t unit, const Matrix4 &xform)
	Sets the texture coordinate transformation matrix for a texture unit. More...

virtual void	_setTextureProjectionRelativeTo (bool enabled, const Vector3 &pos)
	Notify the rendersystem that it should adjust texture projection to be relative to a different origin. More...

virtual void	_setTextureUnitFiltering (size_t unit, FilterOptions minFilter, FilterOptions magFilter, FilterOptions mipFilter)

virtual void	_setTextureUnitFiltering (size_t unit, FilterType ftype, FilterOptions filter)

virtual void	_setTextureUnitSettings (size_t texUnit, TextureUnitState &tl)
	Utility function for setting all the properties of a texture unit at once. More...

virtual void	_setVertexTexture (size_t unit, const TexturePtr &tex)
	Binds a texture to a vertex, geometry, compute, tesselation hull or tessellation domain sampler. More...

void	_setViewMatrix (const Matrix4 &m)

void	_setWorldMatrix (const Matrix4 &m)

virtual void	_swapAllRenderTargetBuffers ()
	Internal method for swapping all the buffers on all render targets, if _updateAllRenderTargets was called with a 'false' parameter. More...

virtual void	_updateAllRenderTargets (bool swapBuffers=true)
	Internal method for updating all render targets attached to this rendering system. More...

virtual void	_useLights (unsigned short limit)
	Tells the rendersystem to use the attached set of lights (and no others) up to the number specified (this allows the same list to be used with different count limits) More...

void	addListener (Listener *l)
	Adds a listener to the custom events that this render system can raise. More...

void	attachRenderTarget (RenderTarget &target)
	Attaches the passed render target to the render system. More...

virtual void	bindGpuProgramPassIterationParameters (GpuProgramType gptype)

void	convertColourValue (const ColourValue &colour, uint32 *pDest)

virtual void	destroyHardwareOcclusionQuery (HardwareOcclusionQuery *hq)
	Destroy a hardware occlusion query object. More...

virtual void	destroyRenderTarget (const String &name)
	Destroys a render target of any sort. More...

virtual void	destroyRenderTexture (const String &name)
	Destroys a render texture. More...

virtual void	destroyRenderWindow (const String &name)
	Destroys a render window. More...

virtual RenderTarget *	detachRenderTarget (const String &name)
	Detaches the render target with the passed name from the render system and returns a pointer to it. More...

const RenderSystemCapabilities *	getCapabilities (void) const
	Gets the capabilities of the render system. More...

virtual VertexElementType	getColourVertexElementType (void) const

const ConfigOptionMap &	getConfigOptions () const
	Returns the details of this API's configuration options. More...

virtual void	getCustomAttribute (const String &name, void *pData)
	Gets a custom (maybe platform-specific) attribute. More...

virtual unsigned int	getDisplayMonitorCount () const

const DriverVersion &	getDriverVersion (void) const
	Returns the driver version. More...

HardwareVertexBufferSharedPtr	getGlobalInstanceVertexBuffer () const
	Returns the global instance vertex buffer. More...

VertexDeclaration *	getGlobalInstanceVertexBufferVertexDeclaration () const
	Gets vertex declaration for the global vertex buffer for the global instancing. More...

size_t	getGlobalNumberOfInstances () const
	Gets the global number of instances. More...

virtual Real	getHorizontalTexelOffset (void)
	Returns the horizontal texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...

bool	getInvertVertexWinding (void) const
	Indicates whether or not the vertex windings set will be inverted for the current render (e.g. More...

RenderSystemCapabilities *	getMutableCapabilities ()
	Get a pointer to the current capabilities being used by the RenderSystem. More...

uint16	getNativeShadingLanguageVersion () const
	Gets the native shading language version for this render system. More...

const StringVector &	getRenderSystemEvents (void) const
	Gets a list of the rendersystem specific events that this rendersystem can raise. More...

RenderTarget *	getRenderTarget (const String &name)
	Returns a pointer to the render target with the passed name, or NULL if that render target cannot be found. More...

RenderTargetIterator	getRenderTargetIterator (void)
	Returns a specialised MapIterator over all render targets attached to the RenderSystem. More...

RenderWindowDescription	getRenderWindowDescription () const
	get a RenderWindowDescription from the current ConfigOptionMap More...

virtual Real	getVerticalTexelOffset (void)
	Returns the vertical texel offset value required for mapping texel origins to pixel origins in this rendersystem. More...

bool	isGpuProgramBound (GpuProgramType gptype)
	Returns whether or not a Gpu program of the given type is currently bound. More...

bool	isReverseDepthBufferEnabled () const
	Returns if reverse Z-buffer is enabled. More...

virtual bool	isStaticBufferLockable () const

virtual void	postExtraThreadsStarted ()
	Tell the rendersystem to perform any tasks it needs to directly after other threads which might access the rendering API are registered. More...

virtual void	preExtraThreadsStarted ()
	Tell the rendersystem to perform any prep tasks it needs to directly before other threads which might access the rendering API are registered. More...

virtual void	registerThread ()
	Register the an additional thread which may make calls to rendersystem-related objects. More...

void	reinitialise (void)
	Restart the renderer (normally following a change in settings). More...

void	removeListener (Listener *l)
	Remove a listener to the custom events that this render system can raise. More...

virtual void	setClipPlanes (const PlaneList &clipPlanes)
	Sets the user clipping region. More...

virtual void	setCurrentPassIterationCount (const size_t count)
	set the current multi pass count value. More...

void	setDepthBufferFor (RenderTarget *renderTarget)
	Retrieves an existing DepthBuffer or creates a new one suited for the given RenderTarget and sets it. More...

void	setDeriveDepthBias (bool derive, float baseValue=0.0f, float multiplier=0.0f, float slopeScale=0.0f)
	Tell the render system whether to derive a depth bias on its own based on the values passed to it in setCurrentPassIterationCount. More...

virtual bool	setDrawBuffer (ColourBufferType colourBuffer)
	Sets the colour buffer that the render system will to draw. More...

void	setGlobalInstanceVertexBuffer (const HardwareVertexBufferSharedPtr &val)
	Sets the global instance vertex buffer. More...

void	setGlobalInstanceVertexBufferVertexDeclaration (VertexDeclaration *val)
	Sets vertex declaration for the global vertex buffer for the global instancing. More...

void	setGlobalNumberOfInstances (const size_t val)
	Sets the global number of instances. More...

void	setInvertVertexWinding (bool invert)
	Sets whether or not vertex windings set should be inverted; this can be important for rendering reflections. More...

virtual void	setLightingEnabled (bool enabled)
	Sets whether or not dynamic lighting is enabled. More...

virtual void	setNormaliseNormals (bool normalise)
	Sets whether or not normals are to be automatically normalised. More...

void	setScissorTest (bool enabled, size_t left, size_t top=0, size_t right=800, size_t bottom=600)

virtual void	setShadingType (ShadeOptions so)
	Sets the type of light shading required (default = Gouraud). More...

void	setStencilState (const StencilState &state)
	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	unbindGpuProgram (GpuProgramType gptype)
	Unbinds GpuPrograms of a given GpuProgramType. More...

virtual void	unregisterThread ()
	Unregister an additional thread which may make calls to rendersystem-related objects. More...

void	useCustomRenderSystemCapabilities (RenderSystemCapabilities *capabilities)
	Force the render system to use the special capabilities. More...

virtual String	validateConfigOptions (void)
	Validates the options set for the rendering system, returning a message if there are problems. More...

Additional Inherited Members
Public Types inherited from Ogre::RenderSystem
typedef MapIterator< Ogre::RenderTargetMap >	RenderTargetIterator
	Iterator over RenderTargets. More...

Static Public Member Functions inherited from Ogre::RenderSystem
static Listener *	getSharedListener (void)
	Retrieve a pointer to the current shared render system listener. More...

static void	setSharedListener (Listener *listener)
	Sets shared listener. More...

Detailed Description

Implementation of Metal as a rendering system.

Constructor & Destructor Documentation

◆ MetalRenderSystem()

Ogre::MetalRenderSystem::MetalRenderSystem ( )

◆ ~MetalRenderSystem()

virtual Ogre::MetalRenderSystem::~MetalRenderSystem ( )

virtual

Member Function Documentation

◆ getFixedFunctionParams()

const GpuProgramParametersPtr& Ogre::MetalRenderSystem::getFixedFunctionParams	(	TrackVertexColourType	tracking,
		FogMode	fog
	)

virtual

Reimplemented from Ogre::RenderSystem.

◆ applyFixedFunctionParams()

void Ogre::MetalRenderSystem::applyFixedFunctionParams	(	const GpuProgramParametersPtr &	params,
		uint16	mask
	)

virtual

Reimplemented from Ogre::RenderSystem.

◆ initConfigOptions()

void Ogre::MetalRenderSystem::initConfigOptions ( )

virtual

Reimplemented from Ogre::RenderSystem.

◆ shutdown()

virtual void Ogre::MetalRenderSystem::shutdown ( void )

virtual

Shutdown the renderer and cleanup resources.

Reimplemented from Ogre::RenderSystem.

◆ getName()

virtual const String& Ogre::MetalRenderSystem::getName ( void ) const

virtual

Returns the name of the rendering system.

Implements Ogre::RenderSystem.

◆ getFriendlyName()

virtual const String& Ogre::MetalRenderSystem::getFriendlyName ( void ) const

virtual

◆ setConfigOption()

virtual void Ogre::MetalRenderSystem::setConfigOption	(	const String &	name,
		const String &	value
	)

inlinevirtual

Sets an option for this API.

Used to confirm the settings (normally chosen by the user) in order to make the renderer able to initialise with the settings as required. This may initialise the RenderWindowDescription or set some RenderSystem specific paramters. Called automatically by the default configuration dialog, and by the restoration of saved settings. These settings are stored and only activated when RenderSystem::_initialise or RenderSystem::reinitialise are called.

If using a custom configuration dialog, it is advised that the caller calls RenderSystem::getConfigOptions again, since some options can alter resulting from a selection.

Common options:

Key	Default	Description
Full Screen	false	Window full-screen flag
VSync	true	"vsync" in _createRenderWindow
VSync Interval	1	"vsyncInterval" in _createRenderWindow
sRGB Gamma Conversion	false	"gamma" in _createRenderWindow
FSAA	0	concatenation of "FSAA" and "FSAAHint" as in _createRenderWindow
Video Mode	-	Window resolution
Display Frequency	-	"displayFrequency" in _createRenderWindow
Content Scaling Factor	1.0	"contentScalingFactor" in _createRenderWindow

Parameters

name	The name of the option to alter.
value	The value to set the option to.

Implements Ogre::RenderSystem.

◆ createHardwareOcclusionQuery()

virtual HardwareOcclusionQuery* Ogre::MetalRenderSystem::createHardwareOcclusionQuery ( void )

virtual

Create an object for performing hardware occlusion queries.

Implements Ogre::RenderSystem.

◆ createRenderSystemCapabilities()

virtual RenderSystemCapabilities* Ogre::MetalRenderSystem::createRenderSystemCapabilities ( void ) const

virtual

Query the real capabilities of the GPU and driver in the RenderSystem.

Implements Ogre::RenderSystem.

◆ _createRenderWindow()

virtual RenderWindow* Ogre::MetalRenderSystem::_createRenderWindow	(	const String &	name,
		unsigned int	width,
		unsigned int	height,
		bool	fullScreen,
		const NameValuePairList *	miscParams = `0`
	)

virtual

Creates a new rendering window.

Remarks: This method creates a new rendering window as specified by the paramteters. The rendering system could be responible for only a single window (e.g. in the case of a game), or could be in charge of multiple ones (in the case of a level editor). The option to create the window as a child of another is therefore given. This method will create an appropriate subclass of RenderWindow depending on the API and platform implementation.

: After creation, this window can be retrieved using getRenderTarget().

Parameters

name	The name of the window. Used in other methods later like setRenderTarget and getRenderTarget.
width	The width of the new window.
height	The height of the new window.
fullScreen	Specify true to make the window full screen without borders, title bar or menu bar.
miscParams	A NameValuePairList describing the other parameters for the new rendering window. Options are case sensitive. Unrecognised parameters will be ignored silently. These values might be platform dependent, but these are present for all platforms unless indicated otherwise:

Key	Type / Values	Default	Description	Platform
title	String	RenderTarget name	The title of the window that will appear in the title bar
left	Positive integers	Centred	Screen x coordinate from left
top	Positive integers	Centred	Screen y coordinate from left
border	none, fixed, resize	resize	The type of window border (in windowed mode)
hidden	true, false	false	hide the created window
FSAA	Positive integer (usually 0, 2, 4, 8, 16)	0	Full screen antialiasing factor
gamma	true, false	false	Enable hardware conversion from linear colour space to gamma colour space on rendering to the window.
vsync	true, false	false	Synchronize buffer swaps to monitor vsync, eliminating tearing at the expense of a fixed frame rate
vsyncInterval	1, 2, 3, 4	1	If vsync is enabled, the minimum number of vertical blanks that should occur between renders. For example if vsync is enabled, the refresh rate is 60 and this is set to 2, then the frame rate will be locked at 30.
Full Screen	true, false	false	Specify whether to create the window in full screen mode
displayFrequency	Refresh rate in Hertz (e.g. 60, 75, 100)	Desktop vsync rate	Display frequency rate, for fullscreen mode
parentWindowHandle	Win32: HWND as int Linux: X11 Window as ulong Emscripten: canvas selector String ("#canvas")	0 (none)	Parent window handle, for embedding the OGRE in a child of an external window
externalWindowHandle	Win32: HWND as int Linux: X11 Window as ulong or ulong:uint:ulong (display:screen:windowHandle) or ulong:uint:ulong:ulong (display:screen:windowHandle:XVisualInfo*) OS X Cocoa: OgreGLView address as an integer. You can pass NSView or NSWindow too, but should perform OgreGLView callbacks into the Ogre manually. OS X Carbon: WindowRef as an integer iOS: UIWindow address as an integer	0 (none)	External window handle, for embedding the OGRE render in an existing window
externalGLControl	true, false	false	Let the external window control OpenGL i.e. don't select a pixel format for the window, do not change v-sync and do not swap buffer. When set to true, the calling application is responsible of OpenGL initialization and buffer swapping. It should also create an OpenGL context for its own rendering, Ogre will create one for its use. Then the calling application must also enable Ogre OpenGL context before calling any Ogre function and restore its OpenGL context after these calls.	OpenGL
currentGLContext	true, false	false	Use an externally created GL context. (Must be current)	OpenGL
minColourBufferSize	Positive integer (usually 16, 32)	16	Min total colour buffer size. See EGL_BUFFER_SIZE	OpenGL
windowProc	WNDPROC	DefWindowProc	function that processes window messages	Win 32
colourDepth	16, 32	Desktop depth	Colour depth of the resulting rendering window; only applies if fullScreen	Win32
FSAAHint	RenderSystem specific. Currently enables EQAA/ CSAA mode on D3D: if you want 4f8x (8x CSAA), set FSAA=4 and this to "f8"	Blank	FSAA mode hint	D3D
outerDimensions	true, false	false	Whether the width/height is expressed as the size of the outer window, rather than the content area	Win32
monitorIndex		-1		Win 32
monitorHandle		0 (none)		Win 32 (OpenGL)
enableDoubleClick	true, false	false	Enable the window to keep track and transmit double click messages.	Win32
useNVPerfHUD	true, false	false	Enable the use of nVidia NVPerfHUD	D3D
depthBuffer	true, false	true	Use depth buffer	D3D
NSOpenGLCPSurfaceOrder	-1 or 1	1	NSOpenGLCPSurfaceOrder	OSX
contentScalingFactor	Positive Float	The default content scaling factor of the screen	On IOS specifies the CAEAGLLayer content scaling factor. This can be useful to limit the resolution of the OpenGL ES backing store. For example, the iPhone 4's native resolution is 960 x 640. Windows are always 320 x 480, if you would like to limit the display to 720 x 480, specify 1.5 as the scaling factor.	OSX, iOS, Android
externalViewHandle	UIView pointer as an integer	0	External view handle, for rendering OGRE render in an existing view	iOS
externalViewControllerHandle	UIViewController pointer as an integer	0	External view controller handle, for embedding OGRE in an existing view controller	iOS
externalSharegroup	EAGLSharegroup pointer as an integer	0	External sharegroup, used to shared GL resources between contexts	iOS
CSAA	Positive integer (usually 0, 2, 4, 8, 16)	0	Coverage sampling factor	Android
maxColourBufferSize	Positive integer (usually 16, 32)	32	Max EGL_BUFFER_SIZE	Android
maxStencilBufferSize	Positive integer (usually 0, 8)	0	EGL_STENCIL_SIZE	Android
maxDepthBufferSize	Positive integer (usually 0, 16, 24)	16	EGL_DEPTH_SIZE	Android

Reimplemented from Ogre::RenderSystem.

◆ createMultiRenderTarget()

virtual MultiRenderTarget* Ogre::MetalRenderSystem::createMultiRenderTarget ( const String & name )

virtual

Create a MultiRenderTarget, which is a render target that renders to multiple RenderTextures at once.

Surfaces can be bound and unbound at will. This fails if mCapabilities->getNumMultiRenderTargets() is smaller than 2.

Implements Ogre::RenderSystem.

◆ _setTexture()

virtual void Ogre::MetalRenderSystem::_setTexture	(	size_t	unit,
		bool	enabled,
		const TexturePtr &	texPtr
	)

virtual

Sets the texture to bind to a given texture unit.

User processes would not normally call this direct unless rendering primitives themselves.

Parameters

unit	The index of the texture unit to modify. Multitexturing hardware can support multiple units (see RenderSystemCapabilites::getNumTextureUnits)
enabled	Boolean to turn the unit on/off
texPtr	Pointer to the texture to use.

Implements Ogre::RenderSystem.

◆ _createDepthBufferFor()

virtual DepthBuffer* Ogre::MetalRenderSystem::_createDepthBufferFor ( RenderTarget * renderTarget )

virtual

Creates a DepthBuffer that can be attached to the specified RenderTarget.

Remarks: It doesn't attach anything, it just returns a pointer to a new DepthBuffer Caller is responsible for putting this buffer into the right pool, for attaching, and deleting it. Here's where API-specific magic happens. Don't call this directly unless you know what you're doing.

Implements Ogre::RenderSystem.

◆ setStencilCheckEnabled()

void Ogre::MetalRenderSystem::setStencilCheckEnabled ( bool enabled )

virtual

Turns stencil buffer checking on or off.

Remarks: Stencilling (masking off areas of the rendering target based on the stencil buffer) can be turned on or off using this method. By default, stencilling is disabled.

Implements Ogre::RenderSystem.

◆ setStencilBufferParams()

void Ogre::MetalRenderSystem::setStencilBufferParams	(	CompareFunction	func = `CMPF_ALWAYS_PASS`,
		uint32	refValue = `0`,
		uint32	compareMask = `0xFFFFFFFF`,
		uint32	writeMask = `0xFFFFFFFF`,
		StencilOperation	stencilFailOp = `SOP_KEEP`,
		StencilOperation	depthFailOp = `SOP_KEEP`,
		StencilOperation	passOp = `SOP_KEEP`,
		bool	twoSidedOperation = `false`,
		bool	readBackAsTexture = `false`
	)

virtual

This method allows you to set all the stencil buffer parameters in one call.

Unlike other render states, stencilling is left for the application to turn on and off when it requires. This is because you are likely to want to change parameters between batches of arbitrary objects and control the ordering yourself. In order to batch things this way, you'll want to use OGRE's Compositor stencil pass or separate render queue groups and register a RenderQueueListener to get notifications between batches.

See also: StencilState; RenderQueue

Implements Ogre::RenderSystem.

◆ _waitForTailFrameToFinish()

virtual void Ogre::MetalRenderSystem::_waitForTailFrameToFinish ( void )

virtual

See VaoManager::waitForTailFrameToFinish.

◆ _willTailFrameStall()

virtual bool Ogre::MetalRenderSystem::_willTailFrameStall ( void )

virtual

◆ _beginFrame()

virtual void Ogre::MetalRenderSystem::_beginFrame ( void )

virtual

Signifies the beginning of a frame, i.e.

the start of rendering on a single viewport. Will occur several times per complete frame if multiple viewports exist.

Reimplemented from Ogre::RenderSystem.

◆ _endFrame()

virtual void Ogre::MetalRenderSystem::_endFrame ( void )

virtual

Ends rendering of a frame to the current viewport.

Implements Ogre::RenderSystem.

◆ setScissorTest()

void Ogre::MetalRenderSystem::setScissorTest	(	bool	enabled,
		const Rect &	rect
	)

virtual

Sets the 'scissor region' i.e.

the region of the target in which rendering can take place.

Remarks: This method allows you to 'mask off' rendering in all but a given rectangular area as identified by the parameters to this method.

Parameters

enabled	True to enable the scissor test, false to disable it.
rect	The location of the corners of the rectangle, expressed in pixels.

Implements Ogre::RenderSystem.

◆ _setViewport()

virtual void Ogre::MetalRenderSystem::_setViewport ( Viewport * vp )

virtual

Sets the provided viewport as the active one for future rendering operations.

This viewport is aware of it's own camera and render target. Must be implemented by subclass.

Parameters

vp	Pointer to the appropriate viewport.

Implements Ogre::RenderSystem.

◆ setColourBlendState()

void Ogre::MetalRenderSystem::setColourBlendState ( const ColourBlendState & state )

virtual

Sets the global blending factors for combining subsequent renders with the existing frame contents.

Implements Ogre::RenderSystem.

◆ _setSampler()

void Ogre::MetalRenderSystem::_setSampler	(	size_t	texUnit,
		Sampler &	s
	)

virtual

set the sampler settings for the given texture unit

Implements Ogre::RenderSystem.

◆ _setDepthClamp()

void Ogre::MetalRenderSystem::_setDepthClamp ( bool enable )

virtual

Clamp depth values to near and far plane rather than discarding.

Useful for "shadow caster pancaking" or with shadow volumes

Reimplemented from Ogre::RenderSystem.

◆ _setDepthBufferParams()

void Ogre::MetalRenderSystem::_setDepthBufferParams	(	bool	depthTest = `true`,
		bool	depthWrite = `true`,
		CompareFunction	depthFunction = `CMPF_LESS_EQUAL`
	)

virtual

Sets the mode of operation for depth buffer tests from this point onwards.

Sometimes you may wish to alter the behaviour of the depth buffer to achieve special effects. Because it's unlikely that you'll set these options for an entire frame, but rather use them to tweak settings between rendering objects, this is an internal method (indicated by the '_' prefix) which will be used by a SceneManager implementation rather than directly from the client application. If this method is never called the settings are automatically the same as the default parameters.

Parameters

depthTest	If true, the depth buffer is tested for each pixel and the frame buffer is only updated if the depth function test succeeds. If false, no test is performed and pixels are always written.
depthWrite	If true, the depth buffer is updated with the depth of the new pixel if the depth test succeeds. If false, the depth buffer is left unchanged even if a new pixel is written.
depthFunction	Sets the function required for the depth test.

Implements Ogre::RenderSystem.

◆ _setCullingMode()

void Ogre::MetalRenderSystem::_setCullingMode ( CullingMode mode )

virtual

Sets the culling mode for the render system based on the 'vertex winding'.

A typical way for the rendering engine to cull triangles is based on the 'vertex winding' of triangles. Vertex winding refers to the direction in which the vertices are passed or indexed to in the rendering operation as viewed from the camera, and will wither be clockwise or anticlockwise (that's 'counterclockwise' for you Americans out there ;) The default is CULL_CLOCKWISE i.e. that only triangles whose vertices are passed/indexed in anticlockwise order are rendered - this is a common approach and is used in 3D studio models for example. You can alter this culling mode if you wish but it is not advised unless you know what you are doing. You may wish to use the CULL_NONE option for mesh data that you cull yourself where the vertex winding is uncertain.

Implements Ogre::RenderSystem.

◆ _setDepthBias()

void Ogre::MetalRenderSystem::_setDepthBias	(	float	constantBias,
		float	slopeScaleBias = `0.0f`
	)

virtual

Sets the depth bias, NB you should use the Material version of this.

Remarks: When polygons are coplanar, you can get problems with 'depth fighting' where the pixels from the two polys compete for the same screen pixel. This is particularly a problem for decals (polys attached to another surface to represent details such as bulletholes etc.).

: A way to combat this problem is to use a depth bias to adjust the depth buffer value used for the decal such that it is slightly higher than the true value, ensuring that the decal appears on top.

Note: The final bias value is a combination of a constant bias and a bias proportional to the maximum depth slope of the polygon being rendered. The final bias is constantBias + slopeScaleBias * maxslope. Slope scale biasing is generally preferable but is not available on older hardware.

Parameters

constantBias	The constant bias value, expressed as a value in homogeneous depth coordinates.
slopeScaleBias	The bias value which is factored by the maximum slope of the polygon, see the description above. This is not supported by all cards.

Implements Ogre::RenderSystem.

◆ _convertProjectionMatrix()

virtual void Ogre::MetalRenderSystem::_convertProjectionMatrix	(	const Matrix4 &	matrix,
		Matrix4 &	dest,
		bool	forGpuProgram = `false`
	)

virtual

Converts a uniform projection matrix to suitable for this render system.

Remarks: Because different APIs have different requirements (some incompatible) for the projection matrix, this method allows each to implement their own correctly and pass back a generic OGRE matrix for storage in the engine.

Implements Ogre::RenderSystem.

◆ _setPolygonMode()

void Ogre::MetalRenderSystem::_setPolygonMode ( PolygonMode level )

virtual

Sets how to rasterise triangles, as points, wireframe or solid polys.

Implements Ogre::RenderSystem.

◆ _setAlphaRejectSettings()

void Ogre::MetalRenderSystem::_setAlphaRejectSettings	(	CompareFunction	func,
		unsigned char	value,
		bool	alphaToCoverage
	)

virtual

Sets the global alpha rejection approach for future renders.

By default images are rendered regardless of texture alpha. This method lets you change that.

Parameters

func	The comparison function which must pass for a pixel to be written.
value	The value to compare each pixels alpha value to (0-255)
alphaToCoverage	Whether to enable alpha to coverage, if supported

Implements Ogre::RenderSystem.

◆ _render()

virtual void Ogre::MetalRenderSystem::_render ( const RenderOperation & op )

virtual

Render something to the active viewport.

Low-level rendering interface to perform rendering operations. Unlikely to be used directly by client applications, since the SceneManager and various support classes will be responsible for calling this method. Can only be called between _beginScene and _endScene

Parameters

op	A rendering operation instance, which contains details of the operation to be performed.

Reimplemented from Ogre::RenderSystem.

◆ bindGpuProgram()

void Ogre::MetalRenderSystem::bindGpuProgram ( GpuProgram * prg )

virtual

Binds a given GpuProgram (but not the parameters).

Remarks: Only one GpuProgram of each type can be bound at once, binding another one will simply replace the existing one.

Reimplemented from Ogre::RenderSystem.

◆ bindGpuProgramParameters()

virtual void Ogre::MetalRenderSystem::bindGpuProgramParameters	(	GpuProgramType	gptype,
		const GpuProgramParametersPtr &	params,
		uint16	variabilityMask
	)

virtual

Bind Gpu program parameters.

Parameters

gptype	The type of program to bind the parameters to
params	The parameters to bind
variabilityMask	A mask of GpuParamVariability identifying which params need binding

Implements Ogre::RenderSystem.

◆ clearFrameBuffer()

virtual void Ogre::MetalRenderSystem::clearFrameBuffer	(	unsigned int	buffers,
		const ColourValue &	colour = `ColourValue::Black`,
		Real	depth = `1.0f`,
		unsigned short	stencil = `0`
	)

virtual

Clears one or more frame buffers on the active render target.

Parameters

buffers	Combination of one or more elements of FrameBufferType denoting which buffers are to be cleared
colour	The colour to clear the colour buffer with, if enabled
depth	The value to initialise the depth buffer with, if enabled
stencil	The value to initialise the stencil buffer with, if enabled.

Implements Ogre::RenderSystem.

◆ discardFrameBuffer()

virtual void Ogre::MetalRenderSystem::discardFrameBuffer ( unsigned int buffers )

virtual

◆ getMinimumDepthInputValue()

virtual Real Ogre::MetalRenderSystem::getMinimumDepthInputValue ( void )

virtual

Gets the minimum (closest) depth value to be used when rendering using identity transforms.

Remarks: When using identity transforms you can manually set the depth of a vertex; however the input values required differ per rendersystem. This method lets you retrieve the correct value.

See also: Renderable::getUseIdentityView, Renderable::getUseIdentityProjection

Implements Ogre::RenderSystem.

◆ getMaximumDepthInputValue()

virtual Real Ogre::MetalRenderSystem::getMaximumDepthInputValue ( void )

virtual

Gets the maximum (farthest) depth value to be used when rendering using identity transforms.

Remarks: When using identity transforms you can manually set the depth of a vertex; however the input values required differ per rendersystem. This method lets you retrieve the correct value.

See also: Renderable::getUseIdentityView, Renderable::getUseIdentityProjection

Implements Ogre::RenderSystem.

◆ _setRenderTarget()

virtual void Ogre::MetalRenderSystem::_setRenderTarget ( RenderTarget * target )

virtual

Set current render target to target, enabling its device context if needed.

Implements Ogre::RenderSystem.

◆ _notifyCompositorNodeSwitchedRenderTarget()

virtual void Ogre::MetalRenderSystem::_notifyCompositorNodeSwitchedRenderTarget ( RenderTarget * previousTarget )

virtual

◆ beginProfileEvent()

virtual void Ogre::MetalRenderSystem::beginProfileEvent ( const String & eventName )

virtual

This marks the beginning of an event for GPU profiling.

Implements Ogre::RenderSystem.

◆ endProfileEvent()

virtual void Ogre::MetalRenderSystem::endProfileEvent ( void )

virtual

Ends the currently active GPU profiling event.

Implements Ogre::RenderSystem.

◆ markProfileEvent()

virtual void Ogre::MetalRenderSystem::markProfileEvent ( const String & event )

virtual

Marks an instantaneous event for graphics profilers.

This is equivalent to calling

See also: beginProfileEvent and; endProfileEvent back to back.

Implements Ogre::RenderSystem.

◆ initGPUProfiling()

virtual void Ogre::MetalRenderSystem::initGPUProfiling ( void )

virtual

◆ deinitGPUProfiling()

virtual void Ogre::MetalRenderSystem::deinitGPUProfiling ( void )

virtual

◆ beginGPUSampleProfile()

virtual void Ogre::MetalRenderSystem::beginGPUSampleProfile	(	const String &	name,
		uint32 *	hashCache
	)

virtual

◆ endGPUSampleProfile()

virtual void Ogre::MetalRenderSystem::endGPUSampleProfile ( const String & name )

virtual

◆ initialiseFromRenderSystemCapabilities()

virtual void Ogre::MetalRenderSystem::initialiseFromRenderSystemCapabilities	(	RenderSystemCapabilities *	caps,
		RenderTarget *	primary
	)

virtual

Initialize the render system from the capabilities.

Implements Ogre::RenderSystem.

◆ getActiveDevice()

MetalDevice* Ogre::MetalRenderSystem::getActiveDevice ( void )

inline

◆ _notifyActiveEncoderEnded()

void Ogre::MetalRenderSystem::_notifyActiveEncoderEnded ( void )

◆ _notifyActiveComputeEnded()

void Ogre::MetalRenderSystem::_notifyActiveComputeEnded ( void )

◆ _notifyDeviceStalled()

void Ogre::MetalRenderSystem::_notifyDeviceStalled ( void )

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

OgreMetalRenderSystem.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MetalRenderSystem()

◆ ~MetalRenderSystem()

Member Function Documentation

◆ getFixedFunctionParams()

◆ applyFixedFunctionParams()

◆ initConfigOptions()

◆ shutdown()

◆ getName()

◆ getFriendlyName()

◆ setConfigOption()

◆ createHardwareOcclusionQuery()

◆ createRenderSystemCapabilities()

◆ _createRenderWindow()

◆ createMultiRenderTarget()

◆ _setTexture()

◆ _createDepthBufferFor()

◆ setStencilCheckEnabled()

◆ setStencilBufferParams()

◆ _waitForTailFrameToFinish()

◆ _willTailFrameStall()

◆ _beginFrame()

◆ _endFrame()

◆ setScissorTest()

◆ _setViewport()

◆ setColourBlendState()

◆ _setSampler()

◆ _setDepthClamp()

◆ _setDepthBufferParams()

◆ _setCullingMode()

◆ _setDepthBias()

◆ _convertProjectionMatrix()

◆ _setPolygonMode()

◆ _setAlphaRejectSettings()

◆ _render()

◆ bindGpuProgram()

◆ bindGpuProgramParameters()

◆ clearFrameBuffer()

◆ discardFrameBuffer()

◆ getMinimumDepthInputValue()

◆ getMaximumDepthInputValue()

◆ _setRenderTarget()

◆ _notifyCompositorNodeSwitchedRenderTarget()

◆ beginProfileEvent()

◆ endProfileEvent()

◆ markProfileEvent()

◆ initGPUProfiling()

◆ deinitGPUProfiling()

◆ beginGPUSampleProfile()

◆ endGPUSampleProfile()

◆ initialiseFromRenderSystemCapabilities()

◆ getActiveDevice()

◆ _notifyActiveEncoderEnded()

◆ _notifyActiveComputeEnded()

◆ _notifyDeviceStalled()