#windowing

winit

Cross-platform window creation library

52 releases

0.19.1 Apr 8, 2019
0.19.0 Mar 7, 2019
0.18.1 Jan 9, 2019
0.18.0 Nov 7, 2018
0.4.9 Mar 26, 2016

#2 in GUI

Download history 6600/week @ 2019-01-24 6543/week @ 2019-01-31 5882/week @ 2019-02-07 6622/week @ 2019-02-14 6235/week @ 2019-02-21 6159/week @ 2019-02-28 6971/week @ 2019-03-07 7018/week @ 2019-03-14 6457/week @ 2019-03-21 5959/week @ 2019-03-28 6811/week @ 2019-04-04 7622/week @ 2019-04-11 7833/week @ 2019-04-18 7924/week @ 2019-04-25 7003/week @ 2019-05-02

27,323 downloads per month
Used in 245 crates (56 directly)

Apache-2.0

1MB
17K SLoC

winit - Cross-platform window creation and management in Rust

Docs.rs Build Status Build status

[dependencies]
winit = "0.19.1"

Documentation

Contact Us

Join us in any of these:

Freenode Matrix Gitter

Usage

Winit is a window creation and management library. It can create windows and lets you handle events (for example: the window being resized, a key being pressed, a mouse movement, etc.) produced by window.

Winit is designed to be a low-level brick in a hierarchy of libraries. Consequently, in order to show something on the window you need to use the platform-specific getters provided by winit, or another library.

extern crate winit;

fn main() {
    let mut events_loop = winit::EventsLoop::new();
    let window = winit::Window::new(&events_loop).unwrap();

    events_loop.run_forever(|event| {
        match event {
            winit::Event::WindowEvent {
              event: winit::WindowEvent::CloseRequested,
              ..
            } => winit::ControlFlow::Break,
            _ => winit::ControlFlow::Continue,
        }
    });
}

Winit is only officially supported on the latest stable version of the Rust compiler.

Cargo Features

Winit provides the following features, which can be enabled in your Cargo.toml file:

  • icon_loading: Enables loading window icons directly from files. Depends on the image crate.
  • serde: Enables serialization/deserialization of certain types with Serde.

Platform-specific usage

Emscripten and WebAssembly

Building a binary will yield a .js file. In order to use it in an HTML file, you need to:

  • Put a <canvas id="my_id"></canvas> element somewhere. A canvas corresponds to a winit "window".
  • Write a Javascript code that creates a global variable named Module. Set Module.canvas to the element of the <canvas> element (in the example you would retrieve it via document.getElementById("my_id")). More information here.
  • Make sure that you insert the .js file generated by Rust after the Module variable is created.

Dependencies

~2MB
~33K SLoC