#post-processing #bevy #effect #white #black #game-engine #ordered

bevy_dither_post_process

A post-process black and white ordered dithering effect for the Bevy game engine

2 releases

0.2.1 Aug 5, 2024
0.2.0 Jul 21, 2024

#1106 in Game dev


Used in bevy_terminal_display

0BSD OR MIT OR Apache-2.0

20KB
242 lines

bevy_dither_post_process

Crates License Tag Build Docs

A plugin for the Bevy engine which adds a dither post-processing effect.

The effect is implemented as a bilevel ordered dither using a Bayer matrix with a configurable level. It dithers the image to black and white only, and operates on the entire screen.

Screenshots

Configuration Used:

bevy_dither_post_process::components::DitherPostProcessSettings::new(3, &asset_server);

Compatibility

Crate Version Bevy Version
0.2 0.14
0.1 0.13

Installation

crates.io

[dependencies]
bevy_dither_post_process = "0.2"

Using git URL in Cargo.toml

[dependencies.bevy_dither_post_process]
git = "https://github.com/exvacuum/bevy_dither_post_process.git"

Usage

In main.rs:

use bevy::prelude::*;
use bevy_dither_post_process;

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins,
            bevy_dither_post_process::DitherPostProcessPlugin,
        ))
        .run();
}

When spawning a camera:

commands.spawn((
    // Camera3dBundle...
    bevy_dither_post_process::components::DitherPostProcessSettings::new(level, &asset_server);
));

This effect will only run for cameras which contain this component.

License

This crate is licensed under your choice of 0BSD, Apache-2.0, or MIT license.

Dependencies

~35–72MB
~1.5M SLoC