render
Start a Houdini ROP job, inspect its output and camera settings, or monitor progress and the output file on disk.
Instructions
Start a render, read its settings, or watch it run.
Use it for a final picture through a ROP node. For a fast look at the
viewport, use capture instead: it is much quicker.
mode:
"start" — render the ROP at `path`. `frame_range` is [start, end];
without it the node renders its own range. A render can
take a long time.
"progress" — what the ROP reports about the render.
"settings" — the output file, the camera, the resolution and the
renderer of the ROP.
"create" — make a ROP of `render_type` ("opengl", "karma", "mantra",
"ifd", …) named `name` under `parent_path`.
"watch" — count the husk and mantra processes on this machine, and
say whether the file at `output_path` is there and how big
it is. This mode does not need Houdini, so it also works
while Houdini is busy with the render.
Returns JSON. A render that writes no file, with no process running, has
failed: read the node with cook to see the error.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | One of "start", "progress", "settings", "create", "watch". | start |
| name | No | create: the name of the new ROP. | |
| path | No | start, progress, settings: the ROP node. | |
| frame_range | No | start: [start, end]. Without it the ROP renders its own range. | |
| output_path | No | watch: the image file to look for on disk. | |
| parent_path | No | create: the network that gets the ROP. | /out |
| render_type | No | create: the ROP kind, for example "opengl", "karma", "mantra" or "ifd". | opengl |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |