README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# grex_outline_post_process


A plugin for the [Bevy](https://bevyengine.org) engine which adds an outline post-processing effect.

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

## Screenshots
![](./doc/screenshot.png)
![](./doc/screenshot_smooth.png)
Configuration Used:
```rs
grex_outline_post_process::components::OutlinePostProcessSettings {
    weight: 2.0,
    threshold: 0.0,
}
```
## Compatibility

| Crate Version | Bevy Version |
|---            |---           |
| 0.1           | 0.13         |

## Installation

### Using git URL in Cargo.toml
```toml
[dependencies.grex_outline_post_process]
git = "https://github.com/exvacuum/grex_outline_post_process.git"
```

## Usage

In `main.rs`:
```rs
use bevy::prelude::*;
use grex_outline_post_process;

fn main() {
    App::new()
        .add_plugins((
            DefaultPlugins,
            grex_outline_post_process::OutlinePostProcessPlugin,
        ))
        .run();
}
```

When spawning a camera:
```rs
commands.spawn((
    // Camera3dBundle...
    grex_outline_post_process::components::OutlinePostProcessSettings {
        weight: 2.0,
        threshold: 0.0,
    }
));
```

This effect will only run for cameras which contain this component.