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

Synopsis

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.

Return value

string[]Command result

Keywords

render, pass

Flags

channels, isPassSupported, passID, passName, renderer, supportedChannelCounts, supportedDataTypes, supportedPassSemantics, supportedRenderPassNames, supportedRenderPasses
Long name (short name) Argument types Properties
channels(ch) int create
Specify the number of channels for query.
isPassSupported(ips) boolean create
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 create
Specify the render pass ID for query.
passName(pn) boolean create
Get the pass name for the passID. This flag must be specified by the flag -passID firstly.
renderer(r) string create
Specify a renderer when using this command. By default the current renderer is specified.
supportedChannelCounts(scc) boolean create
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 create
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 create
List pass semantics supported by the specified passID. This flag must be specified by the flag -passId firstly.
supportedRenderPassNames(spn) boolean create
List render pass names supported by the renderer(specified by the flag -renderer).
supportedRenderPasses(srp) boolean create
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.

Python examples

import maya.cmds as cmds


# Get supported channel counts supported by your renderer and the passID "DIFF".

cmds.renderPassRegistry(passID='DIFF',renderer='yourRenderer', supportedChannelCounts=True)
#
# Get supported data types supported by your renderer, the passID "DIFF" and the channels "3".

cmds.renderPassRegistry(passID='DIFF', renderer='yourRenderer', channels=3, supportedDataTypes=True)