Git Product home page Git Product logo

imgui-rs's Introduction

imgui-rs: Rust bindings for ImGui

Still fairly experimental!

Minimum Rust version: 1.31

Wrapped Dear ImGui version: 1.66b

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

Hello world

ui.window(im_str!("Hello world"))
    .size((300.0, 100.0), ImGuiCond::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.imgui().mouse_pos();
        ui.text(im_str!("Mouse Position: ({:.1},{:.1})", mouse_pos.0, mouse_pos.1));
    })

Currently implemented things

  • 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 (examples/test_window_impl.rs)

Important but unimplemented things

  • Documentation (rustdoc)
  • Support passing a custom Program to Glium renderer (e.g. from a shader cache, or custom shader)

Core design questions and current choices

  • 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)

Compiling and running the demos

git clone https://github.com/Gekkio/imgui-rs
cd imgui-rs
git submodule update --init --recursive

Examples for gfx backend are under the imgui-examples directory.

cd imgui-examples
cargo test

cargo run --example hello_gfx

Examples for glium backend are located into the imgui-glium-examples directory.

# At the reposity root
cd imgui-glium-examples
cargo test

cargo run --example hello_world
cargo run --example test_window
cargo run --example test_window_impl

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. Run rustfmt to guarantee code style conformance

     rustup component add rustfmt-preview
     cargo fmt
    
  3. Open a pull request in Github

License

Licensed under either of

at your option.

Uses 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.

imgui-rs's People

Contributors

aberrantwolf avatar agersant avatar andystanton avatar bitshifter avatar bjadamson avatar brendanzab avatar byron avatar erethedaybreak avatar gekkio avatar informationsea avatar joshlambda avatar lymia avatar malikolivier avatar michaelfairley avatar michelson avatar mulimoen avatar not-fl3 avatar ocornut avatar onelson avatar orhanbalci avatar ostrosco avatar palmr avatar parasyte avatar repi avatar shadowice avatar shockham avatar spacemaniac avatar sumeet avatar thelearnerofcode avatar twinklebear avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.