Skip to content

Latest commit

 

History

History
89 lines (66 loc) · 2.79 KB

README.md

File metadata and controls

89 lines (66 loc) · 2.79 KB
Raw

Pixel-Perfect Outline Shader for Bevy

A easy-use pixel-perfect outline shader for bevy using vertex extrusion method. Inspired by this wonderful tutorial.

Features

  • Pixel perfect: the width of drawn outline is in pixel unit and the same as what we want.
  • Eliminate foreshortening: the width of outline is uniform from near view to far view.
  • Customizability. Width and color can be determined by user.
  • Integration with bevy_mod_picking.

Usage

First, add bevy_outline as a dependency into your Cargo.toml:

[dependencies]
bevy_outline = "0.1"

Second, add OutlinePlugin into your app add set Msaa to a reasonable value:

App::new()
    .insert_resource(Msaa { samples: 4})
... ...
    .add_plugin(OutlinePlugin)
... ...

Third, use OutlineMaterial as a mesh material:

fn setup(
    ...
    mut outlines: ResMut<Assets<OutlineMaterial>>,
    ...
) {
    ...
    commands
        .spawn_bundle(PbrBundle {
            mesh: meshes.add(Mesh::from(shape::Cube { ..default() })),
            material: materials.add(Color::rgb(0.8, 0.7, 0.6).into()),
            transform: Transform::from_translation(translation),
            ..default()
        })
        .insert(outlines.add(OutlineMaterial {
            width: 5.,
            color: Color::rgba(0.2, 0.3, 0.4, 1.0),
        }));
    ...
}

Note that the unit of width attribute of OutlineMaterial is pixel.

Work with bevy_mod_picking

The initial motivation of this crate is to enable outlining instead of material substitution when a mesh is picked by bevy_mod_picking. Use this functionality is very simple:

  • enable the picking feature of this crate.
  • add picking::DefaultPickingPlugins in this crate to your application.
  • set the associated resource like HoverOutline, SelectedOutline and PressedOutline to enable the outlining when hovered, selected and pressed. See this example for demo.

Demos

See example folder

Problems

  • the width of outliner seems not to be uniform.
  • outline of built-in torus seems weird (algorithm is wrong and will be fixed in 0.8)
  • Pan + Orbit camera in example does not work with main branch

Bevy Version Support

I intend to track the main branch of Bevy. PRs supporting this are welcome!

bevy bevy_outline
0.7 0.1

License

This project is licensed under the MIT License.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in bevy_outline by you, shall be licensed as MIT, without any additional terms or conditions.