Still fairly experimental!
Minimum Rust version: 1.36
Wrapped Dear ImGui version: 1.71
ui.window(im_str!("Hello world"))
.size([300.0, 100.0], Condition::FirstUseEver)
.build(|| {
ui.text(im_str!("Hello world!"));
ui.text(im_str!("こんにちは世界！"));
ui.text(im_str!("This...is...imgui-rs!"));
ui.separator();
let mouse_pos = ui.io().mouse_pos;
ui.text(im_str!("Mouse Position: ({:.1},{:.1})", mouse_pos[0], mouse_pos[1]));
})- Low-level API (imgui-sys)
- Renderer for easy integration with Glium projects (optional)
- Parts of high-level API
- Not horrible way of defining and passing null-terminated UTF-8 to ImGui.
The macro
im_str!needs to be used most of the time. For more information and justification for this design, please see issue #7 - Parts of imgui_demo.cpp reimplemented in Rust as an API usage example (imgui-examples/examples/test_window_impl.rs)
- Documentation (rustdoc)
- Support passing a custom Program to Glium renderer (e.g. from a shader cache, or custom shader)
- Closures VS begin/end pairs (current choice: closures)
- Mutable references VS return values (current choice: mutable references)
- Passing around Ui<'ui> VS passing around &'ui Ui (current choice: Ui<'ui>)
- Splitting the API to smaller pieces VS all draw calls in Ui (current choice: all draw calls in Ui)
- Builder pattern for optional arguments VS something else (current choice: builder)
- Mutation functions in builders VS self-consuming functions in builders (current choice: self-consuming)
git clone https://github.com/Gekkio/imgui-rs
cd imgui-rs
git submodule update --init --recursive
Main examples are located in the imgui-examples directory.
# At the reposity root
cd imgui-examples
cargo test
cargo run --example hello_world
cargo run --example test_window
cargo run --example test_window_impl
Examples for the gfx backend are under the imgui-gfx-examples directory.
cd imgui-gfx-examples
cargo test
cargo run --example hello_world
cargo run --example test_window
Note to Windows users: You will need to use the MSVC ABI version of the Rust compiler along with its associated dependencies to build this libary and run the examples.
-
Change or add something
-
Run rustfmt to guarantee code style conformance
rustup component add rustfmt cargo fmt -
Open a pull request in Github
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
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.