Go to: Synopsis. Return value. Flags. Python examples.
batchRender([filename=string], [melCommand=string], [numProcs=int], [preRenderCommand=string], [remoteRenderMachine=string], [renderCommandOptions=string], [showImage=boolean], [status=string], [useRemoteRender=boolean], [useStandalone=boolean], [verbosity=int])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
batchRender is undoable, NOT queryable, and NOT editable.
The batchRender command is used to spawn off a separate
rendering session of the current maya file. If no
mayaFile is specified, it'll ask you whether you want the
current job killed.
The batchRender will spawn a separate maya process in which
commands will be communicated to it through a commandPort. If Maya
is unable to find an available port an error will be
produced. Maya will attempt to use ports 7835 through 7844.
None
filename, melCommand, numProcs, preRenderCommand, remoteRenderMachine, renderCommandOptions, showImage, status, useRemoteRender, useStandalone, verbosity
| Long name (short name) |
Argument types |
Properties |
|
filename(f)
|
string
|
|
|
Filename to be rendered; if empty, a temporary filename will be created.
|
|
melCommand(mc)
|
string
|
|
|
Mel command to execute to run a renderer other than the software renderer.
|
|
numProcs(n)
|
int
|
|
|
Number of processors to use (0 means use all available processors).
|
|
preRenderCommand(prc)
|
string
|
|
|
Command to be run prior to invoking a batch render.
|
|
remoteRenderMachine(rm)
|
string
|
|
|
Name of remote render machine. Not available on Windows.
|
|
renderCommandOptions(rco)
|
string
|
|
|
Arguments to the render command for batch rendering.
|
|
showImage(si)
|
boolean
|
|
|
Show progress of the current rendering job.
|
|
status(st)
|
string
|
|
|
Status string for displaying the batch render status.
|
|
useRemoteRender(um)
|
boolean
|
|
|
If remote rendering is desired. Not available on Windows.
|
|
useStandalone(us)
|
boolean
|
|
|
Batch rendering is to be done by exporting the scene and rendering with a standalone renderer.
|
|
verbosity(v)
|
int
|
|
|
Defines the verbosity level to report the batch rendering
status:
- 1: display only one start message, then one message when all
frames are rendered.
- 2: display only start and end frame messages.
- 3: display all messages (default).
|
|
|
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
cmds.batchRender()
cmds.batchRender( 'mayafile' )