Documentation
Public API reference and guides for the BLIT386 palette-first WebGPU engine.
This is the public documentation for the BLIT386 engine. New here? Start with Getting Started.
For the API, see API: Core for bootstrap(), initialization, and the configure surface. The pages
below mirror the canonical engine documentation maintained in the
blit386 repository.
| Page | What it covers |
|---|
| API: Core | bootstrap, initialization, and default configuration |
| API: Overlay | overlay HUD configure flags, style objects, worked examples |
| API: Game Loop | fixed-timestep timing, tick counters, and Timer |
| API: Camera | the camera's global pixel offset and world-clamp helpers |
| API: Easing | named easing curves via applyEasing |
| API: Core Types | the integer core types: Vector2i, Rect2i, Color32 |
| Browser Support | WebGPU support matrix, software fallback, build toolchain |
| API: Rendering | primitives, sprites, text, post-process, frame capture |
| API: Palette | palette setup, presets, effects, serialization |
| API: Assets | sprite sheets, bitmap fonts, and asset loading |
| API: Audio | bus volume and mute, playback, and the autoplay-unlock state |
| Page | What it covers |
|---|
| Input Guide | pointer, keyboard, gamepad, text accumulation |
| Game Loop Guide | smoothing motion between fixed update() steps |
| Palette Guide | the palette-first workflow, offsets, and effects |
| Palette Presets | built-in preset palettes and the HUD preset |
| Overlay Guide | engine HUD subsystem, toggle, layout |
| Post-Process Effects | the effect chain, built-in effects, CRT presets |
| Bitmap Fonts | the system font and custom .btfont fonts |
| Audio Guide | bus layout, the gesture unlock rule, web audio |
Contributor-only documentation - the developer experience guide, the documentation and versioning guide, the voice
guide, tooling notes, and the security runbook and policies - is not mirrored here and stays in the
engine repository on GitHub.
