An easy-to-use, 2D GUI library written entirely in Rust.
Rust
Switch branches/tags
Nothing to show
Clone or download
mitchmindtree Merge pull request #1189 from mitchmindtree/publish
Update deps: winit 0.16, glutin 0.17, glium 0.22. Publish 0.61.
Latest commit 1cc4be2 Jul 18, 2018

README.md

Conrod Build Status Crates.io Crates.io docs.rs

An easy-to-use, 2D GUI library written entirely in Rust.

The API Documentation.

The Guide:

  1. What is Conrod?
  2. Getting Started
  3. Let's Create a GUI
    • Setup a Basic Window (using piston_window)
    • Conrod Setup
    • Instantiating Widgets
    • Widget Positioning and Layout
  4. Using and Customising Themes
    • What is a Theme?
    • Custom Themes
    • Serializing Themes
  5. Designing Custom Widgets (using the Widget trait)
    • The Widget trait
    • The widget_style! macro
    • The builder_methods! macro
    • Making a Button widget
  6. Custom Graphics and Window Backends
    • Demonstration of Backend Implementation (using glium and glutin)
  7. Internals
    • The Ui's Widget Graph
    • Ui::set_widgets - How does it work?
  8. FAQ

The Guide is a work-in-progress. If a section is not linked, it is likely not yet implemented.

Current State

We're just starting to reach a stable-ish API pattern! There will still be some large changes, however these are more likely to be new features than API overhauls.

To get a clearer idea of where we're at see the issues and in particular, the 1.0.0 milestone.

Contributing

Want to help out? See Piston's how to contribute guide.

License

Licensed under either of

at your option.

Contributions

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.

Example Assets