Skip to content

ScrollKit

Visual Reference

Visual Reference¶

Every visual API in ScrollKit, shown in isolation on a canvas chosen to flatter the effect — deliberately different from the themed Demo Gallery, so you can see the effect itself, not an app. Each sample was recorded from the desktop simulator (make docs-reference) and links back to the guide that documents it.

See it live

A GIF loses the true LED look. To watch any effect in the real simulator window:

python demos/render_reference.py --preview iris-snap

Theatrical transitions¶

Full-screen swaps between content — cover the old, swap while hidden, reveal the new. Set via the transition_style setting. Full details: Theatrical Transitions.

Drop from Sky

Pixel Dissolve

Column Rain

Gradual Reveal

Scan Fold

Horizontal Wipe

Glitch Bars

Diagonal Wipe

Iris Snap

Venetian Shutters

Mosaic Resolve

CRT Collapse

Light Slit

Characterful scrollers¶

Scrolling text with personality — mass, waves, mechanical flips. Full details: Characterful Scrolling.

KineticMarquee — KineticMarquee — eases in, dwells at punctuation, springs

WaveRider — WaveRider — characters ride a sine wave

SplitFlap — SplitFlap — flips through glyphs then lands

Palette-animated bitmap text¶

The glyphs are drawn once; the colour is animated by rewriting the palette each frame. Full details: Palette-Animated Bitmap Text.

RainbowChase

MonoChase

NeonTubeCrawl

ChromeSheen

HazardStripes

Text content modes¶

ScrollingText scrolls right-to-left, or holds centred when speed=0. Full details: Display.

ScrollingText scrolling — ScrollingText — scrolling

ScrollingText static — ScrollingText — static (speed=0)

Gradient text fill¶

StaticText / ScrollingText fill the letters with a static gradient along the chosen axis. Full details: Gradient Text.

vertical — direction="vertical"

horizontal — direction="horizontal"

diagonal — direction="diagonal"

Splash reveals¶

Setup-time reveals that assemble a word or logo. Documented in Effects.

reveal — reveal — wink off non-text pixels

drip — drip — pixels fall into place

swarm — swarm — a flock assembles the image

Particles¶

Lightweight particle systems. Documented in Effects.

sparkle — Sparkle

snow — Snow

ember — Ember

Colour generators¶

Continuous 24-bit ramps sampled at any resolution — not fixed palettes. Documented in Utilities.

spectrum — spectrum(16)

gradient — gradient(deep blue, cyan, 16)

multi_gradient — multi_gradient(fire stops, 16)

depth_palette — depth_palette(base, 0.55, 12)

named colors — the 16 named colours