Narcissistic, Perfectly Modest
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.23 • Public • Published


    npm version npm downloads Twitter Follow

    This project is part of the monorepo.



    Extensible image dithering w/ various algorithm presets. This is a support package for

    The package provides the following dithering algorithm presets (can also be very easily extended via definition of custom kernels):

    • Atkinson
    • Bayes (ordered dithering w/ customizable sizes & levels)
    • Burkes
    • Diffusion (1D row/column, 2D)
    • Floyd-Steinberg
    • Jarvis-Judice-Ninke
    • Sierra 2-row
    • Stucki
    • Threshold


    STABLE - used in production

    Search or submit any issues for this package


    yarn add

    ES module import:

    <script type="module" src=""></script>

    Skypack documentation

    For Node.js REPL:

    # with flag only for < v16
    node --experimental-repl-await
    > const pixelDither = await import("");

    Package sizes (gzipped, pre-treeshake): ESM: 1.13 KB


    Usage examples

    Several demos in this repo's /examples directory are using this package.

    A selection:

    Screenshot Description Live demo Source
    Showcase of various dithering algorithms Demo Source
    Image dithering and remapping using indexed palettes Demo Source


    Generated API docs

    import { intBufferFromImage, GRAY8 } from "";
    import { ditherWith, ATKINSON } from "";
    const img = intBufferFromImage("foo.jpg");
    // apply dithering to all channels in given pixel buffer
    ditherWith(ATKINSON, img);
    // first convert to 8-bit gray before dithering
    // ...or apply dithering to select channels only
    // use custom threshold & error spillage/bleed factor
    ditherWith(ATKINSON, img, { channels: [1, 2, 3], threshold: 0.66, bleed: 0.75 });

    Custom dither kernels

    All bundled algorithm presets (apart from orderedDither()) are implemented as DitherKernel configurations for, defining how each dithered pixel's error should be diffused/distributed to neighbors. This approach makes it very easy to define custom dither configs, like so:

    const CUSTOM: DitherKernel = {
        // X offsets of neighbor pixels to update
        ox: [1],
        // Y offsets of neighbor pixels to update
        oy: [1],
        // error weights for updated pixels
        weights: [1],
        // bit shift (scale factor)
        shift: 1,
    ditherWith(CUSTOM, img);

    The above config will distribute the error to a single pixel @ offset (1,1). However the error will be bit-shifted by 1 bit to the right (aka division-by-2). In code form:

    pixels[i + ox + oy * width] += (err * weight) >> shift;

    Important: Ensure the offset positions only refer to still unprocessed pixels, i.e. those to the right and/or below the currently processed pixel (in following rows).

    You can see the result of this kernel in the pixel-dither demo.


    Karsten Schmidt

    If this project contributes to an academic publication, please cite it as:

      title = "",
      author = "Karsten Schmidt",
      note = "",
      year = 2021


    © 2021 - 2022 Karsten Schmidt // Apache Software License 2.0



    npm i

    DownloadsWeekly Downloads






    Unpacked Size

    35.5 kB

    Total Files


    Last publish