get_pixels
Read pixel colors from a rendered Aseprite frame, all visible layers, or one layer as a legend or hex grid, including transparency, to inspect sprite graphics.
Instructions
Reads pixels of the rendered frame (all visible layers) or of one layer. Default format 'legend' returns rows of characters plus a legend of colors ('.' = transparent); 'hex' returns a grid of '#rrggbbaa' (null = transparent). Indexed sprites return palette indices.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rect | No | ||
| frame | No | 1-based frame number. Defaults to the active frame (or 1). | |
| layer | No | Read only this layer (default: the composited frame) | |
| format | No | ||
| sprite | No | File path, open tab title, or sprite id. Defaults to the active sprite (live). Batch mode needs a file path. | |
| backend | No | auto (default): live Aseprite if connected, else headless batch | |
| maxPixels | No | Safety limit on area (default 16384) |