#windowing

winit

Cross-platform window creation library

48 releases (13 breaking)

0.17.2 Aug 19, 2018
0.16.2 Jul 7, 2018
0.11.3 Mar 28, 2018
0.10.0 Dec 27, 2017
0.4.9 Mar 26, 2016

#1 in GUI

Download history 4659/week @ 2018-09-19 5196/week @ 2018-09-26 5239/week @ 2018-10-03 4067/week @ 2018-10-10 6112/week @ 2018-10-17 4949/week @ 2018-10-24 5702/week @ 2018-10-31 5401/week @ 2018-11-07 7750/week @ 2018-11-14 6657/week @ 2018-11-21 5750/week @ 2018-11-28 6009/week @ 2018-12-05 4949/week @ 2018-12-12

21,383 downloads per month
Used in 194 crates (35 directly)

Apache-2.0

783KB
16K SLoC

winit - Cross-platform window creation and management in Rust

Docs.rs Build Status Build status

[dependencies]
winit = "0.18"

Documentation

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

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
~31K SLoC