td_render
Render a TouchDesigner TOP to an image so you can visually verify what you built. Optionally save the PNG to a file and wait for parameter changes to settle before rendering.
Instructions
Render a TOP and return the image, so you can see what you built.
TouchDesigner is a visual tool: check your work with this rather than
inferring it from parameter values. height defaults to preserving the
TOP's aspect ratio; width=0 keeps the TOP's own resolution.
save_to writes the PNG to that path on this machine and answers in text
instead of returning the image — for comparing two states pixel by pixel,
or keeping a frame, without spending context on it. A file already at
that path is refused unless overwrite=True: it may be the artist's.
settle_frames waits that many of TouchDesigner's own frames before
rendering. A render right after td_set_params or td_build can return the
frame from before the edit; 2–3 frames is enough for a parameter change.
The answer says so if TouchDesigner stopped drawing during the wait.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | ||
| width | No | ||
| height | No | ||
| save_to | No | ||
| overwrite | No | ||
| settle_frames | No |