Skip to content

textmode.overlay.js

DOM overlay target capture and geometry synchronization for textmode.js.

Sketch workflow

  1. Add OverlayPlugin to the sketch's plugins.
  2. Bind a live canvas or video with t.overlay.setTarget().
  3. Shape the returned texture with the standard character, color, conversion, and transform settings.
  4. Show, hide, or toggle the output canvas while drawing continues.

Overlay controller

The per-instance controller that samples a target and keeps the output aligned.

InterfaceDescription
TextmodeOverlayControllerControls the sampled target and DOM alignment for one textmode.js instance.

Target types

The live browser media elements the overlay can sample.

Type AliasDescription
TextmodeOverlayTargetA live browser media element that can be sampled by the overlay controller.

Workflow

The plugin that installs the overlay controller on textmode.js layers.

VariableDescription
OverlayPluginInstalls an isolated overlay controller on each textmode.js instance.