Live: render view
live_render_viewRasterize the live Inkscape canvas to a PNG for visual feedback. Optionally specify a region, scale, or request a fast preview.
Instructions
Rasterize the live canvas to a PNG in the live artifacts dir (visual feedback).
When to use: a pixels-only view of the live canvas. For pixels PLUS structured scene use
live_get_scene; for just the selection use live_export_selection.
Key params: with no region the whole canvas renders. Supply ALL four of
region_x/region_y/region_width/region_height (user units; w/h > 0) for a targeted bbox,
and optional scale (>0) to up/downscale. fast=True gives a cheap downscaled loop-preview; an
explicit scale always wins. Every numeric is finite-checked and bounded server-side before it
crosses the transport; the frame comes from the transport renderer, never an OS screenshot
(deterministic, cross-platform — ADR-006). Served from a per-session cache keyed on
(doc_revision, viewport, scale) so a stale frame is never returned after a change.
Return shape: LiveRenderResult — a workspace-relative PNG path plus render metadata.
Example: live_render_view(fast=True)
Risk class: low (render to artifact dir; view-only, no Operation Record).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fast | No | ||
| scale | No | ||
| region_x | No | ||
| region_y | No | ||
| region_width | No | ||
| region_height | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| scale | No | ||
| format | Yes | ||
| region | No | ||
| size_bytes | Yes | ||
| artifact_path | Yes |