Skip to main content

Crate ditherlib

Crate ditherlib 

Source
Expand description

§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.

samurai

§Features

  • Greyscale and Gaussian blur
  • Threshold and configurable ordered dithering
  • Fourteen error-diffusion presets, from minimal Two-dimensional Knuth through broad Stevenson-Arce
  • Custom diffusion kernels, strength, clamping, and scan direction
  • Custom rectangular threshold maps with strength, offset, rotation, and mirroring
  • 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

cargo add ditherlib

JPEG and PNG support are enabled by default:

[dependencies]
ditherlib = "0.5"

Codec features can be selected individually:

[dependencies]
ditherlib = { version = "0.5", default-features = false, features = ["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 ditherlib::{
    Greyscale, OrderedDither, Palette, Pipeline, Point, Polygon, Renderer, 
    Colour, Selection, ThresholdMap, read, write,
};

fn main() -> ditherlib::Result<()> {
    let source = read("input.jpg")?;
    let width = source.width() as f32;
    let height = source.height() as f32;

    let centre = Point::new(width * 0.5, height * 0.5);
    let area = Polygon::centered_square(centre, width / 1.50)?;

    let mut pipeline = Pipeline::new();
    pipeline.add(Greyscale, Selection::All);
    pipeline.add(
        OrderedDither::new(
            Palette::monochrome(Colour::RED),
            ThresholdMap::bayer_4x4(),
        )
            .with_pixel_size(4)?,
        Selection::Polygon(area),
    );

    let rendered = Renderer::new().render_pipeline(&source, &pipeline)?;
    write("output.png", &rendered)
}

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.

§Ordered dithering

ThresholdMap provides standard Bayer 2x2, 4x4, and 8x8 maps and validates custom rectangular maps. Custom values are row-major ranks from zero up to one less than the map length; repeated ranks are allowed.

use ditherlib::{OrderedDither, Palette, ThresholdMap, ThresholdRotation};

fn main() -> ditherlib::Result<()> {
    let map = ThresholdMap::new(3, 2, [0, 3, 1, 4, 2, 5])?;
    let effect = OrderedDither::new(Palette::black_and_white(), map)
        .with_strength(0.75)?
        .with_offset(1, 0)
        .with_rotation(ThresholdRotation::Clockwise90)
        .with_mirroring(true, false);
    assert_eq!(effect.offset(), (1, 0));
    Ok(())
}

Offsets use logical pixels and move the map right and down for positive values. Rotation is clockwise. Mirroring applies horizontally and vertically after rotation. Every transformation remains anchored to the image origin when an effect targets a polygon.

§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 ditherlib::{Colour, Palette};

fn main() -> ditherlib::Result<()> {
    let palette = Palette::new([
        Colour::BLACK,
        Colour::new(220, 20, 60),
        Colour::WHITE,
    ])?;
    assert_eq!(palette.colours().len(), 3);
    Ok(())
}

§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 ditherlib::{
    DiffusionAlgorithm, DiffusionScan, ErrorDiffusion, Palette, Renderer,
    Selection, read, write,
};

fn main() -> ditherlib::Result<()> {
    let source = read("input.png")?;
    let effect = ErrorDiffusion::new(Palette::black_and_white(), DiffusionAlgorithm::Stucki)
        .with_scan(DiffusionScan::Serpentine)
        .with_pixel_size(2)?;
    let rendered = Renderer::new().render(&source, &effect, &Selection::All)?;
    write("output.png", &rendered)
}

Custom kernels contain forward-pointing weighted taps and a divisor:

use ditherlib::{DiffusionKernel, DiffusionTap, ErrorDiffusion, Palette};

fn main() -> ditherlib::Result<()> {
    let kernel = DiffusionKernel::new(
        [
            DiffusionTap::new(1, 0, 7),
            DiffusionTap::new(-1, 1, 3),
            DiffusionTap::new(0, 1, 5),
            DiffusionTap::new(1, 1, 1),
        ],
        16,
    )?;
    let effect = ErrorDiffusion::new(Palette::black_and_white(), kernel)
        .with_strength(0.75)?
        .with_error_clamp(48);
    assert_eq!(effect.strength(), 0.75);
    Ok(())
}

Built-in presets have distinct grain and edge behaviour:

PresetVisual character
Floyd-SteinbergCrisp, balanced detail with a familiar fine grain
AtkinsonHigh contrast with clean highlights, shadows, and clustered dots
Jarvis-Judice-NinkeSoft, finely dispersed grain with smooth tonal changes
StuckiSharp detail with broad, even error distribution
BurkesClean two-row texture with less softness than Stucki
SierraSmooth, balanced grain with gentle transitions
Two-Row SierraCompact, moderately crisp grain
Sierra LiteFast, coarse texture with visible directional structure
False Floyd-SteinbergCoarse, strongly directional texture
FanCompact, left-leaning grain with pronounced diagonal structure
Shiau-FanShort-tailed texture designed to reduce worm artefacts
Shiau-Fan 2Longer-tailed grain with smoother highlight and shadow texture
Stevenson-ArceVery fine, dispersed grain with smooth tones and preserved detail
Two-dimensional KnuthMinimal, 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:

cargo run --release --example pipeline -- input.jpg output.png
cargo run --release --example polygon_pipeline -- input.jpg output.png
cargo run --release --example diffusion_comparison -- input.jpg comparison-{1,2,3,4,5,6,7}.png
cargo run --release --example diffusion_controls -- input.jpg strengths.png clamps.png
cargo run --release --example ordered_comparison -- input.jpg maps.png strengths.png rotations.png
cargo run --release --example palette_comparison -- input.jpg palettes.png

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 ordered comparison creates three quadrant images. maps.png compares Bayer 2x2, 4x4, and 8x8 with a custom 3x2 map. strengths.png compares 0.25, 0.5, 1.0, and 1.5. rotations.png compares 0, 90, 180, and 270 degrees clockwise.

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.

Structs§

Blur
A fast three-pass approximation of Gaussian blur.
Colour
An RGB colour with 8-bit channels.
DiffusionKernel
A validated set of weights used to distribute quantisation error.
DiffusionTap
A weighted destination in an error-diffusion kernel.
DitherError
An error returned by a Ditherlib operation.
ErrorDiffusion
Applies a configurable error-diffusion algorithm.
Greyscale
Converts RGB channels to greyscale while preserving alpha.
Mask
Per-pixel selection coverage for an image.
OrderedDither
Applies ordered dithering using a configurable threshold map.
Palette
A non-empty collection of RGB colours available to a dithering effect.
Pipeline
An editable ordered collection of effects and their selections.
PipelineStep
One effect and selection in an ordered Pipeline.
Point
A point in image coordinates, with the origin at the top-left corner.
Polygon
A polygon selection boundary.
RenderedImage
A separately owned image produced by a Renderer.
Renderer
Evaluates effects without modifying their source image.
SourceImage
An image loaded into memory by Ditherlib.
Threshold
Deterministically maps each selected pixel to its nearest palette colour.
ThresholdMap
A validated rectangular pattern of threshold ranks.

Enums§

DiffusionAlgorithm
An error-diffusion weight preset.
DiffusionScan
The horizontal traversal used by error diffusion.
ErrorKind
A category describing why a Ditherlib operation failed.
Selection
An area of an image to which an effect can be applied.
ThresholdRotation
A clockwise rotation applied to a threshold map.

Traits§

Effect
An image effect that can be evaluated by a Renderer.

Functions§

read
Reads and decodes an image from disk.
write
Encodes a rendered image to a file.

Type Aliases§

Color
American English alias for Colour.
Result
A result returned by Ditherlib operations.