Go to: Synopsis. Return value. Keywords. Flags. Python examples.

Synopsis

preferredRenderer([string], [fallback=string], [makeCurrent=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

preferredRenderer is NOT undoable, queryable, and NOT editable.

Command to set the preferred renderer. This command can be used to query the preferred renderer and to set the current renderer as the preferred one. It also allows users to specify a preferred fallback renderer.

Return value

None

In query mode, return type is based on queried flag.

Keywords

renderer

Flags

fallback, makeCurrent
Long name (short name) Argument types Properties
fallback(f) string createquery
Sets the preferred fallback renderer.
makeCurrent(mc) boolean create
Sets the current renderer as the preferred one.
Flag can appear in Create mode of command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

# To set the preferred renderer to a renderer called "myRenderer":
#
cmds.preferredRenderer( 'myRenderer' )

# To query the preferred renderer
#
cmds.preferredRenderer( query=True )

# To set the current renderer as the preferred one
#
cmds.preferredRenderer( makeCurrent=True )

# To set the preferred fallback renderer
#
cmds.preferredRenderer( fallback='myRenderer' )