bevy_mod_outline/README.md

93 lines
2.3 KiB
Markdown
Raw Normal View History

2022-06-10 21:29:51 +00:00
# bevy_mod_outline
2022-08-09 00:48:38 +00:00
[![crates.io](https://img.shields.io/crates/v/bevy_mod_outline.svg)](https://crates.io/crates/bevy_mod_outline)
[![docs](https://docs.rs/bevy_mod_outline/badge.svg)](https://docs.rs/bevy_mod_outline)
2023-03-08 00:06:39 +00:00
![Screenshot of bevy_mod_outline's shapes example](https://github.com/bevyengine/bevy-assets/blob/main/Assets/3D/bevy_mod_outline.png?raw=true)
2022-06-13 22:23:35 +00:00
This crate provides a Bevy plugin for drawing outlines around meshes using the
vertex extrusion method.
2022-06-10 21:29:51 +00:00
## Dependency
```toml
[dependencies]
2024-03-01 21:22:37 +00:00
bevy_mod_outline = "0.7"
2022-06-10 21:29:51 +00:00
```
2023-02-21 21:42:13 +00:00
## Examples
2022-06-10 21:29:51 +00:00
A rotating cube and torus with opaque and transparent outlines.
2022-06-10 21:29:51 +00:00
```shell
2022-08-09 00:48:38 +00:00
cargo run --example shapes
2022-06-10 21:29:51 +00:00
```
Multiple intersecting meshes sharing an outline plane. The outline stencil is offset to create
a gap between the object and its outline.
```shell
cargo run --example pieces
```
2023-10-25 23:46:06 +00:00
Many instances of the same mesh, with two different outline configurations, flying towards the
camera.
```shell
cargo run --example flying_objects
```
2023-02-21 21:41:11 +00:00
An outlined torus viewed through four cameras with different combinations of render layers
enabled.
```shell
cargo run --example render_layers
```
2023-03-21 18:35:10 +00:00
An animated jointed glTF model with an outline.
2023-02-21 21:41:11 +00:00
```shell
cargo run --example animated_fox
2023-02-21 21:41:11 +00:00
```
2023-03-21 18:35:10 +00:00
A glTF model with pre-baked outline normals.
```shell
cargo run --example hollow
```
An animated morphing glTF model with an outline.
```shell
cargo run --example morph_targets
```
2022-06-10 21:29:51 +00:00
## Versions
| This Version | Bevy version |
|--------------|--------------|
2024-03-01 21:22:37 +00:00
| 0.7.x | 0.13.x |
2023-11-08 23:21:01 +00:00
| 0.6.x | 0.12.x |
| 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 |
2022-06-13 22:23:35 +00:00
## Features
2022-08-23 22:01:01 +00:00
- `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.
2022-08-09 00:48:38 +00:00
## 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.
2022-06-13 22:23:35 +00:00
2022-08-09 00:48:38 +00:00
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.