amethyst-imgui 0.5.1

imgui library for amethyst
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

[![Latest release on crates.io](https://meritbadge.herokuapp.com/amethyst-imgui)](https://crates.io/crates/amethyst-imgui)
[![Documentation on docs.rs](https://docs.rs/amethyst-imgui/badge.svg)](https://docs.rs/amethyst-imgui)

# amethyst-imgui

Amethyst-imgui provides integration for the [imgui-rs crate](https://github.com/Gekkio/imgui-rs) within the [Amethyst](https://amethyst.rs) game engine.

ImGUI is known industry wide for its utility in fast prototyping and debug interfaces. 

## Integration

This crate proivdes an amethyst `RenderPlugin` (available since amethyst 0.12) which properly renders ImGUI windows which are rendered using the `imgui-rs` crate. This integration is accomplished by calling the `amethyst_imgui::with` function anywhere within an Amethyst (a `System` or `State` is appropriate), which will render within the immediate-mode context of ImGui. All synchronization, frame handling and Amethyst input is handled within this crate.

A minimal example is available at [examples/demo_window.rs](examples/demo_window.rs)

```
cargo run --example demo_window --features amethyst/vulkan
```

## Usage 

This crate currently requires including the amethyst crate; this may introduce a full recompilation of amethyst due to differing features. If this is the case, you'll need to clone this git repository and and set the appropriate features.

This create uses the amethyst `shader-compiler`, which relies on `shaderc` to compile its shaders at build  time. Finally, this crate exposes the same rendering features as amethyst, and will pass them along to amethyst.

Example Cargo.toml Usage:
```toml
amethyst-imgui = "0.5"
```


`RenderPlugin` usage:
```rust
fn main() -> amethyst::Result<()> {
    amethyst::start_logger(Default::default());
    let app_root = application_root_dir()?;
    let display_config_path = app_root.join("examples/display.ron");

    let game_data = GameDataBuilder::default()
        .with_barrier()
        .with(DemoSystem::default(), "imgui_use", &[])
        .with_bundle(amethyst::input::InputBundle::<amethyst::input::StringBindings>::default())?
        .with_bundle(
            RenderingBundle::<DefaultBackend>::new()
                .with_plugin(
                    RenderToWindow::from_config_path(display_config_path)
                        .with_clear([0.34, 0.36, 0.52, 1.0]),
                )
                .with_plugin(RenderImgui::<amethyst::input::StringBindings>::default()),
        )?;

    Application::build("/", Example)?.build(game_data)?.run();

    Ok(())
}

```

An example `System` using amethyst-imgui:
```rust
pub struct ImguiDemoSystem;
impl<'s> amethyst::ecs::System<'s> for ImguiDemoSystem {
    type SystemData = ();
    fn run(&mut self, _: Self::SystemData) {
        amethyst_imgui::with(|ui| {
            ui.show_demo_window(&mut true);
        });
    }
}
```