Skip to content

Commit 0e20c7b

Browse files
czeiclaude
andcommitted
docs: full-size samples everywhere the tables cramped them
Same fix as the transitions table, applied across the guides: the bitmap-text palette-effects table folds each sample into the Animation column at native 300px; the palette-treatments guide gains the gallery it was missing (all 13 treatments, GIF above description, with class and partition columns); the SwirlIn and reverse-swarm sections in the effects guide get their samples inline. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent a7cec0c commit 0e20c7b

3 files changed

Lines changed: 26 additions & 12 deletions

File tree

‎docs/guide/bitmap-text.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,13 @@ A `palette_effect` rewrites a few `palette[i] = color` entries per frame to anim
4040
the same rendered glyphs. They are plain strategy objects with an
4141
`apply(palette)` method:
4242

43-
| Effect | Animation | Colour | Sample |
44-
|--------|-----------|--------|--------|
45-
| `RainbowChase` | Rotates a full-spectrum ramp so a rainbow travels through the letters. | multi-hue (the rainbow) | ![](../assets/reference/palette/rainbow-chase.gif){ width="180" } |
46-
| `MonoChase` | A single bright band of one colour chases through the letters — RainbowChase, but monochrome. | `color` (default white) | ![](../assets/reference/palette/mono-chase.gif){ width="180" } |
47-
| `NeonTubeCrawl` | A bright pulse crawls along an otherwise-dim neon tube — one glowing slot moving. | `color` (or set `glow`/`base`) | ![](../assets/reference/palette/neon-tube-crawl.gif){ width="180" } |
48-
| `ChromeSheen` | A dark→bright ramp of one colour with a highlight band that sweeps across — a metallic sheen. | `color` (default silver) | ![](../assets/reference/palette/chrome-sheen.gif){ width="180" } |
49-
| `HazardStripes` | An accent colour alternating with a dark ground, marching one slot per step. | `color` + `dark` (or set `a`/`b`) | ![](../assets/reference/palette/hazard-stripes.gif){ width="180" } |
43+
| Effect | Animation | Colour |
44+
|--------|-----------|--------|
45+
| `RainbowChase` | ![](../assets/reference/palette/rainbow-chase.gif){ width="300" }<br>Rotates a full-spectrum ramp so a rainbow travels through the letters. | multi-hue (the rainbow) |
46+
| `MonoChase` | ![](../assets/reference/palette/mono-chase.gif){ width="300" }<br>A single bright band of one colour chases through the letters — RainbowChase, but monochrome. | `color` (default white) |
47+
| `NeonTubeCrawl` | ![](../assets/reference/palette/neon-tube-crawl.gif){ width="300" }<br>A bright pulse crawls along an otherwise-dim neon tube — one glowing slot moving. | `color` (or set `glow`/`base`) |
48+
| `ChromeSheen` | ![](../assets/reference/palette/chrome-sheen.gif){ width="300" }<br>A dark→bright ramp of one colour with a highlight band that sweeps across — a metallic sheen. | `color` (default silver) |
49+
| `HazardStripes` | ![](../assets/reference/palette/hazard-stripes.gif){ width="300" }<br>An accent colour alternating with a dark ground, marching one slot per step. | `color` + `dark` (or set `a`/`b`) |
5050

5151
All except `RainbowChase` take a base **`color`** and derive their shades from it
5252
(e.g. `ChromeSheen(0x3060FF)`, `MonoChase(0xFF4060)`), computed once so there's no

‎docs/guide/effects.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -314,10 +314,14 @@ while not sw.is_complete:
314314
await display.show()
315315
```
316316

317+
![swirl](../assets/reference/splashes/swirl.gif){ width="300" }
318+
317319
## Swarm true-color and reverse modes (0.9.0)
318320

319321
`SwarmReveal` can now assemble an arbitrary source image's exact colors —
320322
pass `pixel_colors={(x, y): 0xRRGGBB}` (the palette is derived for you) or
321323
`text_colors=` + `index_map={(x, y): ramp_index}` for explicit control.
322324
And `reverse=True` runs the deconstruction: the image starts fully lit and
323325
each bird CARRIES ITS PIXEL AWAY, leaving darkness when the flock disperses.
326+
327+
![swarm-reverse](../assets/reference/splashes/swarm-reverse.gif){ width="300" }

‎docs/guide/palette-treatments.md‎

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,21 @@ selects by it). All take a 5-stop **theme** `(base, dim, flat, warm, hot)`
5454
— darkest to hottest — and start/end painting `flat`, so an invisible
5555
tile swap in and out is seamless.
5656

57-
`VelvetSweep`, `AnchorWake`, `HaloPulse`, `SonarSweep`, `CipherRain`,
58-
`InkShimmer`, `RimLight`, `HeatmapDrift`, `EclipseCross`,
59-
`GradientDwell` (crossfade to a two-stop gradient edition and back),
60-
`StrokeAnatomy`, `RouteCircuit`, and `PacketTrace` (the one that owns
61-
display sprites — call `start(display)` / `detach()` around it).
57+
| Class | Partition | Motion |
58+
|-------|-----------|--------|
59+
| `VelvetSweep` | `diagonal` | ![](../assets/reference/treatments/velvet-sweep.gif){ width="300" }<br>A hot sheen travels diagonally across the dimmed mark, like light over velvet. |
60+
| `AnchorWake` | `anchor` | ![](../assets/reference/treatments/anchor-wake.gif){ width="300" }<br>Warmth flows outward from the anchor through the mark, and a dimmer echo returns. |
61+
| `HaloPulse` | `radial` | ![](../assets/reference/treatments/halo-pulse.gif){ width="300" }<br>Circular pressure waves expand outward through radial bands. |
62+
| `SonarSweep` | `angle` | ![](../assets/reference/treatments/sonar-sweep.gif){ width="300" }<br>A wedge sweeps around the anchor, leaving a fading afterglow. |
63+
| `CipherRain` | `rain` | ![](../assets/reference/treatments/cipher-rain.gif){ width="300" }<br>Phase-staggered highlights descend within the strokes, column by column. |
64+
| `InkShimmer` | `checker` | ![](../assets/reference/treatments/ink-shimmer.gif){ width="300" }<br>Interleaved groups slowly exchange two close shades — a satin shimmer, quiet enough for long dwells. |
65+
| `RimLight` | `exposure` | ![](../assets/reference/treatments/rim-light.gif){ width="300" }<br>A light source passes over; whichever stroke edge faces it catches a pale highlight. |
66+
| `HeatmapDrift` | `regions` | ![](../assets/reference/treatments/heatmap-drift.gif){ width="300" }<br>Coherent regions warm and cool independently, like detections surfacing on a map. |
67+
| `EclipseCross` | `diagonal` | ![](../assets/reference/treatments/eclipse-cross.gif){ width="300" }<br>A deep shadow crosses the flat mark with a hot corona at its leading edge and a dusk trail behind. |
68+
| `GradientDwell` | `diagonal` | ![](../assets/reference/treatments/gradient-dwell.gif){ width="300" }<br>The mark crossfades to a two-stop gradient edition, dwells, and returns to flat. |
69+
| `StrokeAnatomy` | `topology` | ![](../assets/reference/treatments/stroke-anatomy.gif){ width="300" }<br>Endpoints, corners, junctions, and runs trade emphasis in turn: the typography under analysis. |
70+
| `RouteCircuit` | `route` | ![](../assets/reference/treatments/route-circuit.gif){ width="300" }<br>Hot packets crawl the route sections from both ends and converge on the terminus, which flares. |
71+
| `PacketTrace` | `route` | ![](../assets/reference/treatments/packet-trace.gif){ width="300" }<br>Packet dots crawl the actual strokes toward the terminus while sections glow in their wake. The one treatment that owns display sprites — call `start(display)` / `detach()` around it. |
6272

6373
The caller owns pacing **and blinks**: after each `step()`, `blink_now`
6474
is True on the exact frames the choreography wants an identity blink:

0 commit comments

Comments
 (0)