pixoo_compose_scene
pixoo_compose_sceneIdempotent
Compose layered scenes with text, icons, widgets, shapes, images, and sprites. Add per-element effects and keyframe animations, render back-to-front, and preview as an image before pushing to your Pixoo display.
Instructions
Compose a full scene: layered elements (text, icons, widgets, shapes, bitmaps, images, sprites) with per-element effects and keyframes, static or animated. Returns the rendered scene as an image content block for immediate inspection. Elements render back-to-front in array order. For text-only display use pixoo_display_text; run pixoo_design_brief with topic "scene" or "dashboard" for layout and palette guidance.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| background | Yes | Scene background: solid color, gradient, or named theme. | |
| elements | Yes | Scene elements rendered back-to-front. Up to 50 elements. | |
| frames | No | Number of animation frames (1–40, default: 1). 20 frames at 150ms ≈ 3s loop. | |
| speed | No | Milliseconds per frame for animations (default: 150ms). | |
| push | No | Push to device (default: true). | |
| output | No | Explicit output file path for saving (overrides PIXOO_OUTPUT_DIR). |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pushed | Yes | True when the device acknowledged the push. False when push: false or push failed. | |
| previewData | No | Base64-encoded PNG preview of the rendered scene (8× upscaled, 512px). For animations: the middle frame. | |
| previewMimeType | No | MIME type of the preview image. | |
| frames | Yes | Number of frames in the rendered output (1 for static, 2–40 for animations). | |
| layout | Yes | Layout report for each element. | |
| deviceState | No | Device state after the push. Absent when push: false. | |
| outputFiles | No | Absolute paths to saved output files (PNG for static, GIF for animations). Present only when PIXOO_OUTPUT_DIR is configured or output is set. | |
| notice | No | Warning or informational notice about the render or push. |