Go to file
Robin KAY 6dcf604b93 Remove unnecessary clone. 2023-11-08 22:17:19 +00:00
.github/workflows Change CI from actions-rs to rust-toolchain. 2023-02-21 21:21:41 +00:00
assets Port to Bevy 0.11 (#22) 2023-08-14 01:51:43 +01:00
examples Change outline and stencil properties to be inheritable. 2023-11-08 21:40:19 +00:00
src Remove unnecessary clone. 2023-11-08 22:17:19 +00:00
.gitignore Initial commit. 2022-06-10 22:29:51 +01:00
CHANGELOG.md Merge in change-log from 0.4 release branch. 2023-11-06 23:10:02 +00:00
Cargo.toml Bump version to 0.6. 2023-11-08 21:38:20 +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 Bump version to 0.6. 2023-11-08 21:38:20 +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.6"

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

Many instances of the same mesh, with two different outline configurations, flying towards the camera.

cargo run --example flying_objects

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

cargo run --example render_layers

An animated jointed glTF model with an outline.

cargo run --example animated_fox

A glTF model with pre-baked outline normals.

cargo run --example hollow

An animated morphing glTF model with an outline.

cargo run --example morph_targets

Versions

This Version Bevy version
0.5.x 0.11.x
0.4.x 0.10.x
0.3.x 0.9.x
0.2.x 0.8.x
0.1.x 0.7.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.