imgui-vulkan-renderer-rs 0.1.1

Vulkan renderer for imgui-rs
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

# imgui-vulkan-renderer-rs

Vulkan renderer for [Dear ImGui](https://github.com/ocornut/imgui) via the
[imgui](https://crates.io/crates/imgui) Rust bindings and
[ash](https://crates.io/crates/ash).

Pair with [imgui-glfw-rs](https://crates.io/crates/imgui-glfw-rs) for a
complete GLFW + Vulkan + Dear ImGui integration.

## Usage

Add to your `Cargo.toml`:

```toml
[dependencies]
imgui-vulkan-renderer-rs = "0.1"
```

Then in your code:

```rust
use imgui::Context;
use imgui_vulkan_renderer_rs::{Renderer, RendererCreateInfo};

let mut imgui = Context::create();

let create_info = RendererCreateInfo {
    device: device.clone(),
    memory_properties: mem_props,
    render_pass,
    command_pool,
    queue,
};
let mut renderer = Renderer::new(&mut imgui, &create_info)
    .expect("Failed to initialize renderer");

// In your main loop, after building the imgui frame:
let draw_data = imgui.render();
renderer.render(draw_data, command_buffer).unwrap();
```

## Requirements

- Vulkan 1.0 or later
- A valid `ash::Device` and compatible `VkRenderPass` when calling `Renderer::new`
- A command buffer in the recording state inside a compatible render pass when calling `Renderer::render`

## License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE_APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT License ([LICENSE-MIT](LICENSE_MIT) or <http://opensource.org/licenses/MIT>)

at your option.