pixoo_display_text
pixoo_display_textRender styled text onto Pixoo display using themes, gradients, shadows, and outlines. Auto-fits text and pushes the frame for immediate inspection.
Instructions
Render styled text (theme, gradient, shadow, outline, auto-fit) onto the Pixoo display and push it. Returns the rendered frame as an image content block for immediate inspection. The primary tool for text-only display — for layers, icons, widgets, or animations use pixoo_compose_scene. Run pixoo_design_brief with topic "text" first for palette and legibility guidance.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | Yes | Text to display. String or array of lines. | |
| theme | No | Named scene theme — sets background gradient and default text palette. | |
| background | No | Background color or gradient. Overrides theme background when set. | |
| style | No | Text style: palette, shadow, outline, scale. | |
| font | No | Font variant: standard (5×7) or compact (3×5). Auto-fit will choose if omitted. | |
| position | No | Text position on the display. | |
| align | No | Multi-line text alignment (default: center). | |
| effect | No | Animation effect. auto = scroll only when text overflows. Produces a multi-frame result. | |
| push | No | Push the rendered frame to the device (default: true). | |
| brightness | No | Set device brightness before push (0–100). Failure is a warning, not an error. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| pushed | Yes | True when the device acknowledged the push. | |
| previewData | No | Base64-encoded PNG preview of the rendered frame (8× upscaled, 512px). | |
| previewMimeType | No | MIME type of the preview image. | |
| layout | Yes | Layout report: every fit decision the renderer made. | |
| deviceState | No | Device state after the push. Absent when push: false. | |
| outputFiles | No | Absolute paths to saved PNG preview files. Present only when PIXOO_OUTPUT_DIR is configured. | |
| notice | No | Warning or informational message about the render or push. |