VFX-JS
    Preparing search index...

    Class AsciiEffect

    ASCII / glyph-mosaic effect.

    vfx.add(el, { effect: new AsciiEffect({ font: "Helvetica", grid: 16 }) });
    vfx.add(el, { effect: new AsciiEffect({ chars: [" ", ".", "+", "#"] }) });
    // Image tiles (dark → light), each keeping its own colour:
    vfx.add(el, { effect: new AsciiEffect({ tiles: ["/0.png", "/1.png"] }) });

    Glyphs keep their native aspect ratio regardless of the grid ratio:
    each is fitted (contain) into its cell, so a non-square cell letterboxes
    rather than stretching the character. Match grid to the font's
    character box (≈ advance : em) for gap-free tiling.

    grid, color, background, colorFromSource, invert, and dither
    are live (read every frame). chars / tiles / font / fontWeight /
    charAspect are baked into the atlas at init() — after changing them
    via setParams, call AsciiEffect.updateAtlas (or re-add the
    effect) to rebuild.

    Implements

    Index

    Constructors

    constructor

    Properties

    params

    Methods

    dispose init render setParams updateAtlas

    Constructors

    Properties

    params: AsciiParams

    Methods

    • Rebuild the atlas from the current params, applying changes to the
      baked fields (chars / tiles / font / fontWeight /
      charAspect) without removing and re-adding the effect. Async — it
      may load fonts or decode image tiles. No-op before init().

      Allocates a fresh atlas texture and disposes the previous one once the
      swap is live, so repeated calls don't leak. Still does real work
      (rasterising / decoding), so prefer occasional calls (e.g. on a
      settings change) over per-frame use.

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods