devotee 0.1.39

Visualization engine
Documentation 
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

# devotee
A bit personal visualization engine.

`devotee` is directly based on:
- [winit](https://crates.io/crates/winit) - Rust windowing library;
- [rodio](https://crates.io/crates/rodio) - `cpal`-based audio playback library;

## Backends

`devotee` utilizes a backend to render data to.
It uses Rust feature system to select backend.
Currently there are two backends:

- `back-softbuffer` - [softbuffer](https://crates.io/crates/softbuffer)-based backend.
  This one is enabled by default;
- `back-pixels` - [pixels](https://crates.io/crates/pixels)-based backend.
  To select this one disable default features for `devotee` and add feature `back-pixels`.

## Goals

`devotee` aims to provide __simple__ pixel-perfect visualization and optional sound effects.

## Non-goals

`devotee` does not aim to provide
- ECS architecture;
- resource loading;
- scripting;

## Work in progress

`devotee` is totally a work in progress.
We'd suggest to avoid relying on it in a long term yet.

## Examples

To run examples first check which are available:

```
cargo run --example
```

Then run the desired one with

```
cargo run --example <example_name>
```

## License

`devotee` is distributed under the MIT license.