#imgui

imgui

High-level Rust bindings to dear imgui

27 releases

✓ Uses Rust 2018 edition

0.2.1 Sep 9, 2019
0.1.0 Jul 12, 2019
0.0.22 Feb 5, 2019
0.0.21 Oct 11, 2018
0.0.5 Nov 30, 2015

#3 in GUI

Download history 879/week @ 2019-05-27 741/week @ 2019-06-03 517/week @ 2019-06-10 631/week @ 2019-06-17 850/week @ 2019-06-24 670/week @ 2019-07-01 847/week @ 2019-07-08 468/week @ 2019-07-15 527/week @ 2019-07-22 485/week @ 2019-07-29 468/week @ 2019-08-05 633/week @ 2019-08-12 520/week @ 2019-08-19 748/week @ 2019-08-26 929/week @ 2019-09-02

2,762 downloads per month
Used in 24 crates

MIT/Apache

6.5MB
88K SLoC

C++ 36K SLoC // 0.1% comments Lua 29K SLoC // 0.0% comments Rust 18K SLoC // 0.1% comments Visual Studio Project 2.5K SLoC C 1.5K SLoC // 0.1% comments Objective-C++ 1K SLoC // 0.1% comments Visual Studio Solution 67 SLoC Batch 65 SLoC // 0.4% comments GLSL 31 SLoC Objective-C 22 SLoC Shell 2 SLoC // 0.9% comments

imgui-rs: Rust bindings for Dear ImGui

Still fairly experimental!

Minimum Rust version: 1.36

Wrapped Dear ImGui version: 1.72b

Build Status Latest release on crates.io Documentation on docs.rs

Hello world

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]));
    })

Main library crates

  • imgui: High-level safe API
  • imgui-glium-renderer: Renderer implementation that uses the glium crate
  • imgui-gfx-renderer: Renderer implementation that uses the gfx crate (not the new gfx-hal crate)
  • imgui-winit-support: Backend platform implementation that uses the winit crate (0.19 by default, but 0.20 is supported via the winit-20 feature)
  • imgui-sys: Low-level unsafe API (automatically generated)

Features

  • Bindings for Dear ImGui that can be used with safe Rust. Note: API coverage is not 100%, but will keep improving over time.
  • Builder structs for use cases where the original C++ library uses optional function parameters
  • &ImStr / ImString types and im_str! macro for defining and passing null-terminated UTF-8 to Dear ImGui, which doesn't accept Rust &str / String values. See issue #7 for more information and justification for this design.
  • Easy integration with Glium / pre-ll gfx (renderer)
  • Easy integration with winit (backend platform)

Choosing a backend platform and a renderer

Almost every application that uses imgui-rs needs two additional components in addition to the main imgui crate: a backend platform, and a renderer.

The backend platform is responsible for integrating imgui-rs with the operating system and its window management. Its responsibilities include the following:

  • Handling input events (e.g. keyboard, mouse) and updating imgui-rs state accordingly
  • Passing information about the OS window (e.g. size, DPI factor) to imgui-rs
  • Updating the OS-side mouse cursor when imgui-rs requests it

The renderer is responsible for taking generic, renderer-agnostic draw lists generated by imgui-rs, and rendering them using some graphics API. Its responsibilities include the following:

  • Rendering using vertex/index buffers and command lists
  • Handling of DPI factors and scissor rects
  • Texture management

The most tested platform/renderer combination is imgui-glium-renderer + glium + imgui-winit-support + winit, but this is not the only possible combination. There's also imgui-gfx-renderer, and you can find additional 3rd party crates that provide a wider support for more libraries (e.g. raw OpenGL, SDL2). You can also write your own support code if you have a more advanced use case, because imgui-rs is not tied to any specific graphics / OS API.

Compiling and running the demos

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.

How to contribute

  1. Change or add something

  2. Make sure you're using the latest stable Rust

  3. Run rustfmt to guarantee code style conformance

    rustup component add rustfmt
    cargo fmt
    
  4. Open a pull request in Github

License

Licensed under either of

at your option.

Uses Dear ImGui and cimgui.

Contribution

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.

Dependencies