Go to file
Christian Duerr 20b09c4514 Add additional numpad key mappings (#805)
* Add additional numpad key mappings

Since some platforms have already used the existing `Add`, `Subtract`
and `Divide` codes to map numpad keys, the X11 and Wayland platform has
been updated to achieve parity between platforms. On macOS only the
`Subtract` numpad key had to be added.

Since the numpad key is different from the normal keys, an alternative
option would be to add new `NumpadAdd`, `NumpadSubtract` and
`NumpadDivide` actions, however I think in this case it should be fine
to map them to the same virtual key code.

* Add Numpad PageUp/Down, Home and End on Wayland
2019-04-07 16:41:52 +02:00
.circleci Implement virtual key translation for emscripten (#289) 2017-09-16 15:46:53 +02:00
.github Added a GitHub PULL_REQUEST_TEMPLATE (#542) 2018-06-02 11:04:08 -04:00
examples Remove icon loading feature (#799) 2019-02-23 20:59:00 -05:00
src Add additional numpad key mappings (#805) 2019-04-07 16:41:52 +02:00
tests Wayland's eventloop 2.0 (#790) 2019-02-21 10:51:43 +01: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 Update winit to 0.19.0 (#798) 2019-04-07 16:41:52 +02:00
CHANGELOG.md Add additional numpad key mappings (#805) 2019-04-07 16:41:52 +02:00
CONTRIBUTING.md Change francesca64 to maintainer for macOS and Android (#744) 2018-12-24 13:08:33 -05:00
LICENSE Initial commit 2014-07-27 11:41:26 +02:00
README.md Add contact info. (#818) 2019-04-07 16:41:52 +02:00

winit - Cross-platform window creation and management in Rust

Docs.rs Build Status Build status

[dependencies]
winit = "0.19.0"

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.