Go to file
Robin KAY 2a4184ab32 Fix outline depth being propagated onto children without InheritOutlineDepth. 2023-03-16 01:27:06 +00:00
.github/workflows Change CI from actions-rs to rust-toolchain. 2023-02-21 21:21:41 +00:00
assets Add support for jointed (skinned) models. 2022-10-12 18:31:02 +01:00
examples Port to Bevy 0.10. 2023-03-10 18:43:13 +00:00
src Fix outline depth being propagated onto children without InheritOutlineDepth. 2023-03-16 01:27:06 +00:00
.gitignore Initial commit. 2022-06-10 22:29:51 +01:00
CHANGELOG.md Update version and change-log for 0.3.5. 2023-03-08 08:18:05 +00:00
Cargo.toml Port to Bevy 0.10. 2023-03-10 18:43:13 +00:00
LICENCE-APACHE Initial commit. 2022-06-10 22:29:51 +01:00
LICENCE-MIT Initial commit. 2022-06-10 22:29:51 +01:00
README.md Add screenshot to the README. 2023-03-08 00:06:39 +00:00

README.md

bevy_mod_outline

crates.io docs

Screenshot of bevy_mod_outline's shapes example

This crate provides a Bevy plugin for drawing outlines around meshes using the vertex extrusion method.

Dependency

[dependencies]
bevy_mod_outline = "0.3"

Examples

A rotating cube and torus with opaque and transparent outlines.

cargo run --example shapes

Multiple intersecting meshes sharing an outline plane. The outline stencil is offset to create a gap between the object and its outline.

cargo run --example pieces

An outlined torus viewed through four cameras with different combinations of render layers enabled.

cargo run --example render_layers

An animated jointed model with an outline.

cargo run --features="bevy/animation bevy/bevy_gltf bevy/png bevy/bevy_scene" \
    --example animated_fox

Versions

This Version Bevy version
0.1.x 0.7.x
0.2.x 0.8.x
0.3.x 0.9.x

Features

  • bevy_ui (default) - Adds a render graph edge to prevent clashing with the UI. This adds a dependency on the bevy_ui crate and can be disabled if it is not used.

Licence

This crate is licensed under the Apache License, Version 2.0 (see LICENCE-APACHE or http://www.apache.org/licenses/LICENSE-2.0) or the MIT licence (see LICENCE-MIT or http://opensource.org/licenses/MIT), at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.