Ditherlib
Ditherlib is a Rust library for non-destructive image effects and dithering. Effects can target an entire image or anti-aliased polygon selections, and an ordered pipeline can combine several selected effects into one render.
Source pixels remain immutable after loading. Each render starts from the source and produces a separately owned image, so callers can freely edit and re-render pipelines.

Features
- Greyscale and Gaussian blur
- Threshold and ordered Bayer dithering
- Fourteen error-diffusion presets, from minimal Two-dimensional Knuth through broad Stevenson-Arce
- Custom diffusion kernels, strength, clamping, and scan direction
- Custom RGB palettes, black-and-white palettes, and monochrome palettes
- Configurable logical pixel sizes for every dithering method
- Whole-image and polygon selections with anti-aliased edges
- Ordered multi-effect pipelines with reusable rendering buffers
- Crate-owned image, result, and error types
Installation
JPEG and PNG support are enabled by default:
[]
= "0.4"
Codec features can be selected individually:
[]
= { = "0.4", = false, = ["png", "webp"] }
Available codec features are avif, bmp, dds, exr, ff, gif, hdr,
ico, jpeg, png, pnm, qoi, tga, tiff, and webp. The processing
algorithms compile without any codec features.
Usage
This example converts the full image to greyscale, then applies a red monochrome ordered dither inside a polygon:
use ;
Pipeline order matters. Each step receives the result of the previous step,
including where polygon selections overlap. Rendering the same pipeline again
always begins from the unchanged SourceImage.
Palettes
Palette::black_and_white() provides the familiar two-colour palette.
Palette::monochrome(colour) combines black, the supplied RGB colour, and
white. Eight-level greyscale, Game Boy, CGA, and PICO-8 palettes are also
available through Palette::greyscale(), Palette::game_boy(),
Palette::cga(), and Palette::pico_8().
Colour represents an RGB value with named channels, common colour constants,
and conversions to and from [u8; 3]. Color is an alias for callers using
American spelling. Palette::new accepts either representation:
use ;
Error diffusion
ErrorDiffusion accepts a built-in algorithm or a validated custom kernel. It
supports raster or serpentine scanning, diffusion strength from 0.0 through
2.0, and optional per-channel error clamping.
use ;
Custom kernels contain forward-pointing weighted taps and a divisor:
use ;
Built-in presets have distinct grain and edge behaviour:
| Preset | Visual character |
|---|---|
| Floyd-Steinberg | Crisp, balanced detail with a familiar fine grain |
| Atkinson | High contrast with clean highlights, shadows, and clustered dots |
| Jarvis-Judice-Ninke | Soft, finely dispersed grain with smooth tonal changes |
| Stucki | Sharp detail with broad, even error distribution |
| Burkes | Clean two-row texture with less softness than Stucki |
| Sierra | Smooth, balanced grain with gentle transitions |
| Two-Row Sierra | Compact, moderately crisp grain |
| Sierra Lite | Fast, coarse texture with visible directional structure |
| False Floyd-Steinberg | Coarse, strongly directional texture |
| Fan | Compact, left-leaning grain with pronounced diagonal structure |
| Shiau-Fan | Short-tailed texture designed to reduce worm artefacts |
| Shiau-Fan 2 | Longer-tailed grain with smoother highlight and shadow texture |
| Stevenson-Arce | Very fine, dispersed grain with smooth tones and preserved detail |
| Two-dimensional Knuth | Minimal, regular diagonal texture |
Errors
Fallible operations return ditherlib::Result<T>. Use DitherError::kind()
to handle stable ErrorKind categories covering file access, unsupported
formats, decoding, encoding, invalid geometry, dimension mismatches, invalid
parameters, and effect failures. Dependency errors may remain available
through the standard Error::source() method for diagnostics.
JPEG output discards alpha because the format does not support transparency.
Examples
Every example accepts an input path and output path:
The diffusion comparison requires an image with an even width and creates seven
side-by-side comparisons. From comparison-1.png through comparison-7.png,
the left/right pairs are Floyd-Steinberg/Atkinson,
Jarvis-Judice-Ninke/Stucki, Burkes/Sierra, Two-Row Sierra/Sierra Lite, False
Floyd-Steinberg/Fan, Shiau-Fan/Shiau-Fan 2, and
Stevenson-Arce/Two-dimensional Knuth.
The diffusion controls example creates two quadrant comparisons. strengths.png
uses strengths 0.0, 0.5, 1.0, and 1.5 from top-left to bottom-right.
clamps.png uses error limits of 0, 24, 64, and unlimited in the same order.
The palette comparison uses greyscale, Game Boy, CGA, and PICO-8 from top-left to bottom-right. It applies Floyd-Steinberg diffusion with serpentine scanning to every quadrant so the palette is the only variable.
Additional examples cover each built-in effect in the examples
directory.