Log inGet started
World

Tumblestep: The Endless Stair

Branchmain
Branchesmain
Commit7c31e3f635

README.md

flash

Full-screen flashes, vignettes and glows drawn as part of the rendered picture. They use one post-process pass (juiceFlash.shader, effect F.EFFECT = "juiceKit.flash") on the scene layer of the camera's post-process chain. That pass runs over the lit scene before the UI, so a HUD stays on top, untinted.

  • Modes: fill (a flat tint), vignette (closes in from the edges) and glow (a warm bloom from the corners), each with attack, hold and fade.
  • Mixing: the live flashes are combined per mode into the pass's three colour inputs.
  • When idle: the pass is disabled (not drawn at alpha 0), so it costs nothing.
  • Return value: play(spec, opts) returns the peak alpha it showed (0 when too faint to draw).
  • Reduce motion: flashes are gentler and shorter.
  • Limit: at most MAX_ACTIVE flashes at once.
  • Other calls: stop, stopTag, countTag, activeCount, setReduceMotion and stats. stats includes shown, effect and registrations.