README.md

winit - Cross-platform window creation and management in Rust

[dependencies]
winit = "0.22.2"

Documentation

For features within the scope of winit, see FEATURES.md.

For features outside the scope of winit, see Missing features provided by other crates in the wiki.

Contact Us

Join us in any of these:

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.

use winit::{
    event::{Event, WindowEvent},
    event_loop::{ControlFlow, EventLoop},
    window::WindowBuilder,
};

fn main() {
    let event_loop = EventLoop::new();
    let window = WindowBuilder::new().build(&event_loop).unwrap();

    event_loop.run(move |event, _, control_flow| {
        *control_flow = ControlFlow::Wait;

        match event {
            Event::WindowEvent {
                event: WindowEvent::CloseRequested,
                window_id,
            } if window_id == window.id() => *control_flow = ControlFlow::Exit,
            _ => (),
        }
    });
}

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:

• serde: Enables serialization/deserialization of certain types with Serde.
• x11 (enabled by default): On Unix platform, compiles with the X11 backend
• wayland (enabled by default): On Unix platform, compiles with the Wayland backend

Platform-specific usage

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.

Android

This library makes use of the ndk-rs crates, refer to that repo for more documentation.

Running on an Android device needs a dynamic system library, add this to Cargo.toml:

[[example]]
name = "request_redraw_threaded"
crate-type = ["cdylib"]

And add this to the example file to add the native activity glue:

#[cfg(target_os = "android")]
ndk_glue::ndk_glue!(main);

And run the application with cargo apk run --example request_redraw_threaded