renderer

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

Synopsis

renderer([string], [addGlobalsNode=string], [addGlobalsTab=[string, string, string]], [batchRenderOptionsProcedure=string], [batchRenderOptionsStringProcedure=string], [batchRenderProcedure=string], [cancelBatchRenderProcedure=string], [changeIprRegionProcedure=string], [commandRenderProcedure=string], [exists=boolean], [globalsNodes=boolean], [globalsTabCreateProcNames=boolean], [globalsTabLabels=boolean], [globalsTabUpdateProcNames=boolean], [iprOptionsMenuLabel=string], [iprOptionsProcedure=string], [iprOptionsSubMenuProcedure=string], [iprRenderProcedure=string], [iprRenderSubMenuProcedure=string], [isRunningIprProcedure=string], [logoCallbackProcedure=string], [logoImageName=string], [materialViewRendererList=boolean], [materialViewRendererPause=boolean], [materialViewRendererSuspend=boolean], [namesOfAvailableRenderers=boolean], [pauseIprRenderProcedure=string], [polyPrelightProcedure=string], [refreshIprRenderProcedure=string], [renderDiagnosticsProcedure=string], [renderGlobalsProcedure=string], [renderMenuProcedure=string], [renderOptionsProcedure=string], [renderProcedure=string], [renderRegionProcedure=string], [renderSequenceProcedure=string], [rendererUIName=string], [renderingEditorsSubMenuProcedure=string], [showBatchRenderLogProcedure=string], [showBatchRenderProcedure=string], [showRenderLogProcedure=string], [startIprRenderProcedure=string], [stopIprRenderProcedure=string], [supportColorManagement=boolean], [textureBakingProcedure=string], [unregisterRenderer=boolean])

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

renderer is NOT undoable, queryable, and editable.

Return value

None

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

Keywords

Flags

Long name (short name)	Argument types	Properties
addGlobalsNode(agn)	string
This flag allows the user to add a globals node the specified renderer uses.
addGlobalsTab(agt)	[string, string, string]
Add a tab associated with the specified renderer for the unified render globals window.
batchRenderOptionsProcedure(bro)	string
Set or query the batch render options procedure associated with the specified renderer.
batchRenderOptionsStringProcedure(bso)	string
Set or query the argument string that will be used with the command line utility 'Render' when doing a batch render
batchRenderProcedure(br)	string
Set or query the batch render procedure associated with the specified renderer.
cancelBatchRenderProcedure(cbr)	string
Set or query returns the cancel batch render procedure associated with the specified renderer.
changeIprRegionProcedure(cir)	string
Set or query the change IPR region procedure associated with the specified renderer.
commandRenderProcedure(cr)	string
Set or query the command line rendering procedure associated with the specified renderer.
exists(ex)	boolean
The flag returns true if the specified renderer is registered in the registry, and it returns false otherwise.
globalsNodes(gn)	boolean
This flag returns the list of render globals nodes the specified renderer uses.
globalsTabCreateProcNames(gtc)	boolean
This flag returns the names of procedures that are used to create the unified render globals window tabs that are associated with the specified renderer.
globalsTabLabels(gtl)	boolean
This flag returns the labels of unified render globals window tabs that are associated with the specified renderer.
globalsTabUpdateProcNames(gtu)	boolean
This flag returns the names of procedures that are used to update the unified render globals window tabs that are associated with the specified renderer.
iprOptionsMenuLabel(ipm)	string
Set or query the label for the IPR update options menu which is under the render view's IPR menu.
iprOptionsProcedure(io)	string
Set or query the IPR render options procedure associated with the specified renderer.
iprOptionsSubMenuProcedure(ips)	string
Set or query the procedure for creating the sub menu for the IPR update options menu which is under the render view's IPR menu.
iprRenderProcedure(ipr)	string
Set or query the IPR render command associated with the specified renderer.
iprRenderSubMenuProcedure(irs)	string
Set or query the procedure for creating the sub menu for the IPR render menu which is under the render view's IPR menu.
isRunningIprProcedure(isr)	string
Set or query the isRunningIpr command associated with the specified renderer.
logoCallbackProcedure(lgc)	string
Set or query the procedure which is a callback associated to the logo for the specified renderer. For example, the logo and the callback can be used in the unified render globals window beside the "Render Using" optionMenu.
logoImageName(log)	string
Set or query the logo image name for the specified renderer. The logo is a image representing the renderer.
materialViewRendererList(mvl)	boolean
Returns the names of material view renderers that are currently registered.
materialViewRendererPause(mvp)	boolean
Specifies whether to pause the material viewer. Useful for globally halting updates to the material viewer. The material view renderer will remain suspended while the viewer is paused.
materialViewRendererSuspend(mvs)	boolean
Specifies whether to suspend or resume the material view renderer. Useful for temporarily stopping the material view renderer while another rendering task is running.
namesOfAvailableRenderers(ava)	boolean
Returns the names of renderers that are currently registered.
pauseIprRenderProcedure(psi)	string
Set or query the pause IPR render procedure associated with the specified renderer.
polyPrelightProcedure(pp)	string
Set or query the polygon prelight procedure associated with the specified renderer.
refreshIprRenderProcedure(rfi)	string
Set or query the refresh IPR render procedure associated with the specified renderer.
renderDiagnosticsProcedure(rd)	string
Set or query the render diagnostics procedure associated with the specified renderer.
renderGlobalsProcedure(rg)	string
This flag is obsolete. It will be removed in the next release.
renderMenuProcedure(rm)	string
This flag is obsolete. It will be removed in the next release.
renderOptionsProcedure(ro)	string
Set or query the render options procedure associated with the specified renderer.
renderProcedure(r)	string
Set or query the render command associated with the specified renderer.
renderRegionProcedure(rr)	string
Set or query the render region procedure associated with the specified renderer.
renderSequenceProcedure(rs)	string
Set or query the sequence rendering procedure associated with the specified renderer.
rendererUIName(ui)	string
Set or query the rendererUIName for the specified renderer. The rendererUIName is the name of the renderer as it would appear in menus.
renderingEditorsSubMenuProcedure(res)	string
Set or query the procedure reponsible for creating renderer specific editors submenu under the "Rendering Editors" menu for the specified renderer.
showBatchRenderLogProcedure(brl)	string
Set or query the log file batch procedure associated with the specified renderer.
showBatchRenderProcedure(sbr)	string
Set or query the show batch render procedure associated with the specified renderer.
showRenderLogProcedure(srl)	string
Set or query the log file render procedure associated with the specified renderer.
startIprRenderProcedure(sti)	string
Set or query the start IPR render procedure associated with the specified renderer.
stopIprRenderProcedure(spi)	string
Set or query the stop IPR render procedure associated with the specified renderer.
supportColorManagement(scm)	boolean
Specifies whether the renderer supports color management.
textureBakingProcedure(tb)	string
Set or query the texture baking procedure associated with the specified renderer.
unregisterRenderer(unr)	boolean
Unregister the specified renderer.

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 register a renderer called "myRenderer":
#
cmds.renderer( 'myRenderer' )

# To edit a renderer called "myRenderer" with its rendererUIName
# being "My Renderer":
#
cmds.renderer( 'myRenderer', edit=True, rendererUIName='My Renderer' )

# To register a renderer called "anotherRenderer" with all
# its parameters specified.
#
cmds.renderer( 'anotherRenderer', rendererUIName='Another Renderer', iprRenderProcedure='mayaSoftwareIprRender', -iprOptionsProcedure='', isRunningIprProcedure='mayaSoftwareIsRunningIpr', startIprRenderProcedure='mayaSoftwareStartIprRender', stopIprRenderProcedure='mayaSoftwareStopIprRender', refreshIprRenderProcedure='mayaSoftwareRefreshIprImage', pauseIprRenderProcedure='mayaSoftwarePauseIprRender', changeIprRegionProcedure='mayaSoftwareChangeIprRegion', iprOptionsMenuLabel='IPR Tuning Options', iprOptionsSubMenuProcedure='mayaSoftwareIprUpdateOptionsSubMenu', iprRenderSubMenuProcedure='mayaSoftwareIprUpdateRenderSubMenu', renderProcedure='mayaSoftwareRender', renderOptionsProcedure='RenderOptions', renderDiagnosticsProcedure='RenderDiagnostics', commandRenderProcedure='render -batch', batchRenderProcedure='BatchRender', batchRenderOptionsProcedure='BatchRenderOptions', batchRenderOptionsStringProcedure="mayaSoftwareBatchRenderOptionsString", cancelBatchRenderProcedure='CancelBatchRender', showBatchRenderProcedure='ShowBatchRender', showRenderLogProcedure='', showBatchRenderLogProcedure='', renderRegionProcedure='mayaRenderRegion', textureBakingProcedure='performConvertSolidTx', polyPrelightProcedure='performPrelight', renderingEditorsSubMenuProcedure='', logoImageName='', logoCallbackProcedure='' )

# To add a render globals node the renderer uses:
#
cmds.renderer( 'anotherRenderer', edit=True, addGlobalsNode='defaultRenderGlobals' )

# To add the tabs associated with the specified renderer
# for the unified render globals window, use the syntax
#
#      renderer -edit
#               -addGlobalsTab globalsTabLabel
#                              globalsTabCreateProcName
#                              globalsTabUpdateProcName
#               renderer;
#
# where "globalsTabLabel" is the label of the tab,
# "globalsTabCreatedProcName" is the name of the mel procedure
# which is used to create the content in the tab.
# and "globalsTabCreatedProcName" is the name of the mel procedure
# which is used to update the content in the tab.
#
# Note that if you want to add a number of tabs, you need to repeat
# this renderer command for each tab you wish to add, as shown below.
#
cmds.renderer( 'anotherRenderer', edit=True, addGlobalsTab=('Maya Software', 'createMayaSoftwareGlobalsTab', 'updateMayaSoftwareGlobalsTab') )


# To get a list of unified render globals window tab labels associated
# with the specified renderer.
#
cmds.renderer( 'anotherRenderer', query=True, globalsTabLabels=True )

# To get a list of names of mel procedures that are used to
# create the unified render globals window tabs associated with
# the specified renderer.
#
cmds.renderer( 'anotherRenderer', query=True, globalsTabCreateProcNames=True )

# To get a list of names of mel procedures that are used to
# update the unified render globals window tabs associated with
# the specified renderer.
#
cmds.renderer( 'anotherRenderer', query=True, globalsTabUpdateProcNames=True )

# To view a list of registered renderers.
#
cmds.renderer( query=True, namesOfAvailableRenderers=True )

# To check if anotherRenderer exists.
#
cmds.renderer( 'anotherRenderer', exists=True )

# To view a list of render globals nodes used by the specified
# renderer:
#
cmds.renderer( 'anotherRenderer', query=True, globalsNodes=True )