render¶

[scriptjob] jobs render ( string mode , table|nil opts )

Start a rendering process

This function starts a rendering process just like the Batch Render or Farm Render commands do.

mode indicates to which render farm manager the render is submitted to, such as "Coalition". mode accepts other generic values:

"farm" or true or nil: use the default farm interface (set in Preferences > Local Settings > Render Farm > Active Farm)
"batch" or false: render on the system without using the render farm
"none": only generate the rendering files without actually rendering them

opts are options used for rib generation and render farm submission. See renderoptions for a complete description of all available options.

All other options are passed to the render farm interface as custom parameters. Notable options for Coalition are:

Host: The host name of the render manager to submit jobs to
Port: The host port of the render manager to submit jobs to
Parent: The parent job in which to submit the jobs (default is project Render Parent, or Root)
TimeOut: The job time out value in minutes (default is project time out, or none)
Affinity: The job affinity (default is project affinity, or none)
Priority: The initial jobs priority (default is project priority, or 1000)
Retry: The initial jobs retries count (default is 10)

Examples:

Submitting with all default options:
render ()

Submitting with specific frame range and name:
render ("farm", { FrameRange="12:30", Name="MySequence" })

Submitting with deferred rib generation:
render ("farm", { DeferredRibGen = true })

Arguments:

mode The render farm interface, or "batch" to render on the local system, "farm" to use the default render farm interface, or "none" to just generate ribs.
opts The farm/batch options

Return: