MRenderProfile Class Reference

#include <MRenderProfile.h>

Class Description

Render profile.

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).

Examples:

Public Types
enum	MStandardRenderer { kMayaSoftware, kMayaOpenGL, kMayaD3D }
	Maya's internal renderers. More...

Public Member Functions
	MRenderProfile ()
	Create a new empty render profile.
	~MRenderProfile ()
	Class destructor.
unsigned int	numberOfRenderers () const
	Find the number of renderers in this profile. More...
void	addRenderer (MStandardRenderer renderer)
	Add one of Maya's internal renderers to this render profile. More...
void	addRenderer (const MString &name, float version)
	Add a custom entry to this render profile. More...
bool	hasRenderer (MStandardRenderer renderer) const
	See if a Maya renderer is listed in this profile. More...
bool	hasRenderer (const MString &name, float version) const
	Find a custom entry in this render profile. More...

Member Enumeration Documentation

enum MStandardRenderer

Maya's internal renderers.

Enumerator
kMayaSoftware
kMayaOpenGL
kMayaD3D

Member Function Documentation

unsigned int numberOfRenderers

(

)

const

Find the number of renderers in this profile.

Returns

The number of renderers.

Examples:

void addRenderer

(

MStandardRenderer

renderer

)

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

Parameters

[in]

renderer

The internal Maya renderer to add to this profile.

Examples:

void addRenderer	(	const MString &	name,
		float	version
	)

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.

Parameters

[in]	name	The name of the renderer.
[in]	version	The version of the renderer or rendering API.

bool hasRenderer

(

MStandardRenderer

renderer

)

const

See if a Maya renderer is listed in this profile.

Parameters

[in]

renderer

The internal Maya renderer to search for

Examples:

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

Find a custom entry in this render profile.

Parameters

[in]	name	The name of the renderer.
[in]	version	The version of the renderer or rendering API.

---

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

• MRenderProfile.h
• MRenderProfile.cpp