Start
Documentation
How to use the editor, the library under it, and how it all works.
Image-to-Pixel has two parts. The editor is the app at Editor: open images or video, tune the look, export. The library is the engine underneath, with no UI, for your own pages, tools and games.
Start here#
| Getting started | Your first image in the editor, and your first lines of library code |
| The editor | Panes, files, presets, compare, zoom, the colour picker |
| Library | Install, createPixelator(), results, helpers, Node |
Editor guides#
| Size and resampling | Pixel width, pixel size, detecting the grid of upscaled art |
| Palettes | Built-in, custom, extracted, imported (.gpl, .hex, .pal, Lospec) |
| Dithering | All 16 methods, strength, custom threshold matrices |
| Adjust, cleanup and outline | Tone controls, alpha, stray pixels, outlines |
| Batches | Many files, one set of settings, one ZIP |
| Video | Frame-accurate preview and export |
| Exporting | PNG, GIF, WebM, MP4, sprite sheets, tilesets |
| Presets and sharing | Presets, share links, settings files |
| Keyboard shortcuts | Every key |
Reference#
| Settings reference | Every field of the settings object |
| Video API | image-to-pixel/video: WebCodecs encoding |
| Embedding the editor | mountEditor() in your own page |
| How it works | The shader pipeline and the diffusion wavefront |
| Migrating from 2.x | The classic pixelate() call and what changed |