Go to file
Osspial cf713bef31 Remove CircleCI (#915)
None of the platforms that use it are supported right now, so it seems
silly to fail builds for other platforms when these ones can't possibly
succeed.

This should be reverted in stages as the platforms regain support.
2019-06-13 00:34:21 -06:00
.github Fix link in PULL_REQUEST_TEMPLATE.md 2019-04-27 18:28:20 +02:00
examples Support listing available video modes for a monitor (#896) 2019-06-12 14:07:25 -04:00
src Change Monitor dimensions functions to size functions (#911) 2019-06-13 00:33:44 -06:00
tests Refine function names and type signatures (#886) 2019-05-29 21:29:54 -04:00
.gitattributes Initial commit 2014-07-27 11:41:26 +02:00
.gitignore X11+Windows: Guess initial DPI factor (#583) 2018-07-01 11:01:46 -04:00
.gitmodules Add basic support for Android 2014-09-11 18:28:07 +02:00
.travis.yml Remove icon loading feature (#799) 2019-02-23 20:59:00 -05:00
appveyor.yml Remove icon loading feature (#799) 2019-02-23 20:59:00 -05:00
Cargo.toml Support listing available video modes for a monitor (#896) 2019-06-12 14:07:25 -04:00
CHANGELOG.md Support listing available video modes for a monitor (#896) 2019-06-12 14:07:25 -04:00
CONTRIBUTING.md Makes changes to CONTRIBUTING.md's table as discussed in #830 (#841) 2019-04-27 18:28:40 +02:00
FEATURES.md Support listing available video modes for a monitor (#896) 2019-06-12 14:07:25 -04:00
HALL_OF_CHAMPIONS.md Makes changes to CONTRIBUTING.md's table as discussed in #830 (#841) 2019-04-27 18:28:40 +02:00
LICENSE Initial commit 2014-07-27 11:41:26 +02:00
README.md Fix CI links in README.md (#852) 2019-04-27 18:29:02 +02:00

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 event_loop = winit::EventLoop::new();
    let window = winit::Window::new(&event_loop).unwrap();

    event_loop.run(|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:

  • 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.