bevy_outline_post_process

Crates Tag Build

A plugin for the Bevy engine which adds an outline post-processing effect. Optionally supports adaptive outlining, so darker areas are outlined in white rather than black, based on luminance.

Note: This is a full-screen post process effect and cannot be enabled/disabled for specific objects.

Screenshots

Configuration Used:

bevy_outline_post_process::components::OutlinePostProcessSettings::new(2.0, 0.0, false);

Compatibility

Crate Version	Bevy Version
0.3	0.14
0.1-0.2	0.13

Installation

crates.io

[dependencies]
bevy_outline_post_process = "0.3"

Using git URL in Cargo.toml

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

Usage

In main.rs:

use bevy::prelude::*;
use bevy_outline_post_process;

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins,
            bevy_outline_post_process::OutlinePostProcessPlugin,
        ))
        .insert_resource(Msaa::Off)
        .run();
}

When spawning a camera:

commands.spawn((
    // Camera3dBundle...
    NormalPrepass,
    bevy_outline_post_process::components::OutlinePostProcessSettings::new(2.0, 0.0, false);
));

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.