These guides explain how Capy Canvas works and how to develop it. Start with the root README for an introduction to the project. Instructions for artists belong in the website documentation.
Performance targets sets the minimum frame rate for every tool, brush and movement. It covers three hardware tiers and records the newest measurements. Check changes that affect frame generation against it.
The engineering whitepaper explains why we built the brush and rendering stack this way, from pen input to live effects and native apps. Architecture introduces the shared editor and follows an input event through to the GPU. The guides below cover one system at a time and link to implementation details when they become relevant.
| Topic | What it explains |
|---|---|
| Documents and edits | Layers, strokes, undo, editable projects and file-operation ownership. |
| Session recovery | Automatic restart, private history, crash-safe publication and bounded cleanup. |
| Workspace and UI | The editor session, commands, configurable panels, docking and Zen mode. |
| Settings and persistence | Shared defaults and validation, shortcuts, saved preferences and workspace state. |
| Rendering and composition | GPU storage, incremental updates, masks, filters and readback. |
| Brushes | Brush definitions, input dynamics, dab placement and different GPU execution paths. |
| Input and stroke feedback | Pen history, coordinate transforms, prediction and estimated-sample corrections. |
| Platform integration | Native toolkits, graphics backends, host responsibilities and port differences. |
AGENTS.md lists the rules every change follows. The
developer guide covers building each client, the shared
environment and test devices,
testing, writing docs and
publication. The commit guide
covers commits and pushing. The Apple and
Windows porting guides describe how features that land
on GTK, Web and Android reach the other clients.
These documents assume familiarity with the concept guides above.
| Area | References |
|---|---|
| Document files | Project format, authored model contract, package contract, binary payload boundaries. |
| Brushes | Dab layout and raster rules, GPU brush stages, painterly paint state, Liquify sessions and deformation. |
| Input | Stroke feedback and platform mapping. |
| UI | Shared UI contract, panel customization, numeric controls, theme colors. |
| Extensions | Runtime filters. |
| Distribution and performance | Performance targets, Web/PWA packaging, GPU benchmark workloads. |
History keeps research and design records that explain why the current design is the way it is. Their claims apply to when they were written; the guides above describe the application as it is now.