Go to: Synopsis. Return value. Keywords. Flags. Python examples.
renderPassRegistry([channels=int], [isPassSupported=boolean], [passID=string], [passName=boolean], [renderer=string], [supportedChannelCounts=boolean], [supportedDataTypes=boolean], [supportedPassSemantics=boolean], [supportedRenderPassNames=boolean], [supportedRenderPasses=boolean])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
renderPassRegistry is NOT undoable, NOT queryable, and NOT editable.
query information related with render passes.
render, pass
channels, isPassSupported, passID, passName, renderer, supportedChannelCounts, supportedDataTypes, supportedPassSemantics, supportedRenderPassNames, supportedRenderPasses
| Long name (short name) |
Argument types |
Properties |
channels(ch)
|
int
|
|
|
Specify the number of channels for query.
|
|
isPassSupported(ips)
|
boolean
|
|
|
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.
|
|
passID(pi)
|
string
|
|
|
Specify the render pass ID for query.
|
|
passName(pn)
|
boolean
|
|
|
Get the pass name for the passID.
This flag must be specified by the flag -passID firstly.
|
|
renderer(r)
|
string
|
|
|
Specify a renderer when using this command.
By default the current renderer is specified.
|
|
supportedChannelCounts(scc)
|
boolean
|
|
|
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)
|
boolean
|
|
|
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)
|
boolean
|
|
|
List pass semantics supported by the specified passID.
This flag must be specified by the flag -passId firstly.
|
|
supportedRenderPassNames(spn)
|
boolean
|
|
|
List render pass names supported by the renderer(specified by the flag -renderer).
|
|
supportedRenderPasses(srp)
|
boolean
|
|
|
List render passes supported by the renderer(specified by the flag -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.
|
import maya.cmds as cmds
# Get supported channel counts supported by renderer mentalRay and the passID "DIFF".
cmds.renderPassRegistry(passID='DIFF',renderer='mentalRay', supportedChannelCounts=True)
#
# Get supported data types supported by renderer mentalRay, the passID "DIFF" and the channels "3".
cmds.renderPassRegistry(passID='DIFF', renderer='mentalRay', channels=3, supportedDataTypes=True)