Repository files navigation

I'll no longer be maintaining conrod for the reasons discussedhere. If you'relooking for a similar yet nicer replacement GUI library, I recommendegui. If you're interested in taking overmaintenance, please express your interesthere.

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

1. What is Conrod?
   • A Brief Summary
   • Screenshots and Videos
   • Feature Overview
   • Available Widgets
     • Primitive Widgets
     • Common Use Widgets
   • Immediate Mode
     • What is it?
     • Why use it?
     • Is Conrod Immediate or Retained?
   • The Builder Pattern
2. Getting Started
   • Installing Rust and Cargo
   • Running the Conrod Examples
3. Hello World
   • Creating a new project
   • Conrod Setup-Back ends
   • Creating a Window
   • Event Handling
4. Using and Customising Themes
   • What is aTheme?
   • Custom Themes
   • Serializing Themes
5. Designing Custom Widgets (using the Widget trait)
   • TheWidget trait
   • Thewidget_style! macro
   • Thebuilder_methods! macro
   • Making aButton widget
6. Custom Graphics and Window Backends
   • Demonstration of Backend Implementation (using glium and glutin)
7. Internals
   • TheUi's WidgetGraph
   • 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.

Crate	Badges	Description
conrod_core		The fundamentals for any conrod project.
conrod_derive		Provides theWidgetCommon andWidgetStyle derive macros.
conrod_winit		Simplifies usingconrod_core withwinit
conrod_gfx		Simplifies usingconrod_core with the gfx ecosystem
conrod_wgpu		Simplifies usingconrod_core withwgpu
conrod_glium		Simplifies usingconrod_core withglium
conrod_piston		Simplifies usingconrod_core withpiston
conrod_vulkano		Simplifies usingconrod_core withvulkano

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

To get a clearer idea of where we're at see theissues and in particular, the1.0.0 milestone.

Want to help out? SeePiston's how to contribute guide.

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE orhttp://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT orhttp://opensource.org/licenses/MIT)

at your option.

Contributions

Unless you explicitly state otherwise, any contribution intentionally submittedfor inclusion in the work by you, as defined in the Apache-2.0 license, shall bedual licensed as above, without any additional terms or conditions.

Example Assets

• Google Noto (Apache2)