start_render
Execute render or file-writing nodes in Houdini, with foreground progress and cancellation, or background rendering. Reports output path and file presence.
Instructions
Execute any node that renders or writes files.
Foreground by default: Houdini shows its own progress dialog and the user can cancel. The call holds until the render finishes, however long that is; a client that hands a long call to a background task notifies you with the verdict. Do nothing else in Houdini meanwhile and never poll the disk.
Not just /out ROPs: a LOP usdrender_rop (which is how Solaris renders), a SOP ROP Geometry, or a File Cache's Save to Disk all work, because what matters is whether the node can be executed rather than its category.
The result reports the output path it wrote to and whether anything is actually on disk there, so a render that succeeds and writes nowhere is visible instead of silent.
Args:
node_path: Any node with a render() or an 'execute' button.
frame_range: [start, end] or [start, end, increment].
background: Render in a separate hython on the saved hip and return
at once with status "launched"; get_render_progress reports the
process, its log tail and the files. The user sees no progress
in Houdini, so use it only when asked to keep working while a
render runs.
overrides: {parm_name: value} for this render only, e.g. a draft
{"resolutionx": 640, "resolutiony": 360}; a parm tuple takes a
list. Put back afterwards, expressions and keyframes included,
even if the render fails (overrides_applied,
overrides_restored). Foreground only. A Karma LOP's "Wait for
Render to Complete" is switched on for the call when it is off
(foreground_forced).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| node_path | Yes | ||
| overrides | No | ||
| background | No | ||
| frame_range | No |