pymel.core.rendering.renderPassRegistry

static rendering.renderPassRegistry(*args, **kwargs)

query information related with render passes.

Flags:
Long name (short name) Argument Types Properties
channels (ch) int ../../../_images/create.gif
 
Specify the number of channels for query.
isPassSupported (ips) bool ../../../_images/create.gif
 

Return whether the pass is supported by the renderer This flag must be specified by the flag -passID firstly. The renderer whose default value is the current renderer is specified by the flag renderer. Flag can have multiple arguments, passed either as a tuple or a list.

passID (pi) unicode ../../../_images/create.gif
 
Specify the render pass ID for query.
passName (pn) bool ../../../_images/create.gif
 
Get the pass name for the passID. This flag must be specified by the flag -passID firstly.
renderer (r) unicode ../../../_images/create.gif
 
Specifiy a renderer when using this command. By default the current renderer is specified.
supportedChannelCounts (scc) bool ../../../_images/create.gif
 
List channel counts supported by the renderer(specified by the flag -renderer) and the specified pass ID. This flag must be specified by the flag -passID firstly.
supportedDataTypes (sdt) bool ../../../_images/create.gif
 

List frame buffer types supported by the renderer(specified by the flag -renderer), the specified passID and channels. This flag must be specified by the flag -passID and -channels firstly.

supportedPassSemantics (ps) bool ../../../_images/create.gif
 
List pass semantics supported by the specified passID. This flag must be specified by the flag -passId firstly.
supportedRenderPassNames (spn) bool ../../../_images/create.gif
 
List render pass names supported by the renderer(specified by the flag -renderer).
supportedRenderPasses (srp) bool ../../../_images/create.gif
 
List render passes supported by the renderer(specified by the flag -renderer).

Derived from mel command maya.cmds.renderPassRegistry

Example:

import pymel.core as pm

# Get supported channel counts supported by renderer mentalRay and the passID "DIFF".
pm.renderPassRegistry(passID='DIFF',renderer='mentalRay', supportedChannelCounts=True)
# Result: [4, 3] #
#
# Get supported data types supported by renderer mentalRay, the passID "DIFF" and the channels "3".
pm.renderPassRegistry(passID='DIFF', renderer='mentalRay', channels=3, supportedDataTypes=True)
# Result: [1, 2, 256, 512] #

Previous topic

pymel.core.rendering.renderPartition

Next topic

pymel.core.rendering.renderQualityNode

Core

Core Modules

Other Modules

This Page