Go to file
Osspial 6bec912961 Add optional Serde implementations and missing derivable traits (#652)
* Add optional serde feature

* Document features in README

* Add changelog entry

* Implement some missing derivable traits

* Add changelog entry for std derives

* Remove extraneous space on serde doc comments

* Add period to end of serde line in readme

* Remove serde impls from WindowAttributes

* Add serde impls for TouchPhase

* Add serde test file

* Add feature lines to testing CIs

* Remove WindowAttributes from changelog
2018-11-01 04:24:56 -04: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 update to image 0.20 (#683) 2018-10-23 20:29:11 -04:00
src Add optional Serde implementations and missing derivable traits (#652) 2018-11-01 04:24:56 -04:00
tests Add optional Serde implementations and missing derivable traits (#652) 2018-11-01 04:24:56 -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 Add optional Serde implementations and missing derivable traits (#652) 2018-11-01 04:24:56 -04:00
appveyor.yml Add optional Serde implementations and missing derivable traits (#652) 2018-11-01 04:24:56 -04:00
Cargo.toml Add optional Serde implementations and missing derivable traits (#652) 2018-11-01 04:24:56 -04:00
CHANGELOG.md Add optional Serde implementations and missing derivable traits (#652) 2018-11-01 04:24:56 -04:00
LICENSE Initial commit 2014-07-27 11:41:26 +02:00
README.md Add optional Serde implementations and missing derivable traits (#652) 2018-11-01 04:24:56 -04:00

winit - Cross-platform window creation and management in Rust

Docs.rs Build Status Build status

[dependencies]
winit = "0.17"

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.