class MRenderProfile

Jump to documentation

public members:

	MRenderProfile ()
	~MRenderProfile ()
typedef enum	{///kMayaSoftware,///kMayaOpenGL,///kMayaD3D}MStandardRenderer
unsigned int	numberOfRenderers () const
void	addRenderer ( MStandardRenderer renderer)
void	addRenderer ( const MString & name, float version)
bool	hasRenderer ( MStandardRenderer renderer ) const
bool	hasRenderer ( const MString &name, float version ) const

Documentation

Description

The MRenderProfile class describes the rendering APIs and algorithms supported by a given rendering entity (e.g. a shading node, a renderer). A single profile can contain multiple entries allowing, for example, a shading node to specify that it supports both OpenGL and Direct3D rendering. The profile entries refer to renderers rather than rendering APIs as the rendering elements may depend on specific services, information or algorithms implemented by the renderer (e.g. a global light table, or render state cache).

Functions

MRenderProfile:: MRenderProfile ()

Description

Create a new empty render profile.

MRenderProfile:: ~MRenderProfile ()

Description

Class destructor.

void MRenderProfile:: addRenderer ( MStandardRenderer renderer)

Description

Add one of Maya's internal renderers to this render profile.

Arguments

• renderer : the internal Maya renderer to add to this profile.

void MRenderProfile:: addRenderer ( const MString & name, float version)

Description

Add a custom entry to this render profile. The name and version specified must correspond to a renderer registered with Maya. Currently, only Maya's internal renderers (just named after the APIs they use: "OpenGL", "D3D", or "Software") are supported. When registering support for Maya's internal renderers, it's simpler to use the other version of this method.

Arguments

• name : the name of the renderer.
• version : the version of the renderer or rendering API.

unsigned int MRenderProfile:: numberOfRenderers () const

Description

Find the number of renderers in this profile.

Return Value

• The number of renderers.

bool MRenderProfile:: hasRenderer ( MStandardRenderer renderer ) const

Description

See if a Maya renderer is listed in this profile.

Arguments

• renderer : the internal Maya renderer to search for

bool MRenderProfile:: hasRenderer ( const MString &name, float version ) const

Description

Find a custom entry in this render profile.

Arguments

• name : the name of the renderer.
• version : the version of the renderer or rendering API.

This class has no child classes.