winit-sonoma-fix/README.md

57 lines
2.1 KiB
Markdown
Raw Normal View History

2016-11-01 03:19:37 +11:00
# winit - Cross-platform window creation and management in Rust
2014-07-27 18:55:37 +10:00
2016-11-01 03:19:37 +11:00
[![](http://meritbadge.herokuapp.com/winit)](https://crates.io/crates/winit)
2015-05-04 23:18:03 +10:00
2016-11-01 03:19:37 +11:00
[![Docs.rs](https://docs.rs/winit/badge.svg)](https://docs.rs/winit)
2016-09-06 05:10:15 +10:00
[![Build Status](https://travis-ci.org/tomaka/winit.svg?branch=master)](https://travis-ci.org/tomaka/winit)
2016-11-01 03:19:37 +11:00
[![Build status](https://ci.appveyor.com/api/projects/status/5h87hj0g4q2xe3j9/branch/master?svg=true)](https://ci.appveyor.com/project/tomaka/winit/branch/master)
2014-09-20 03:51:54 +10:00
2015-02-16 04:28:12 +11:00
```toml
[dependencies]
winit = "0.17"
2015-02-16 04:28:12 +11:00
```
2016-11-01 03:19:37 +11:00
## [Documentation](https://docs.rs/winit)
2014-07-28 19:45:59 +10:00
2014-07-27 23:59:58 +10:00
## Usage
2016-11-01 03:33:36 +11:00
Winit is a window creation and management library. It can create windows and lets you handle
2017-12-18 06:13:16 +11:00
events (for example: the window being resized, a key being pressed, a mouse movement, etc.)
2016-11-01 03:19:37 +11:00
produced by window.
2015-02-22 21:31:27 +11:00
2016-11-01 03:19:37 +11:00
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.
2015-02-22 21:31:27 +11:00
2014-07-27 23:59:58 +10:00
```rust
2016-11-01 03:19:37 +11:00
extern crate winit;
2014-07-27 23:59:58 +10:00
fn main() {
let mut events_loop = winit::EventsLoop::new();
let window = winit::Window::new(&events_loop).unwrap();
2014-07-27 23:59:58 +10:00
events_loop.run_forever(|event| {
2015-06-16 21:48:08 +10:00
match event {
winit::Event::WindowEvent {
event: winit::WindowEvent::CloseRequested,
..
} => winit::ControlFlow::Break,
_ => winit::ControlFlow::Continue,
2015-06-16 21:48:08 +10:00
}
});
2014-07-27 23:59:58 +10:00
}
```
### 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](https://kripken.github.io/emscripten-site/docs/api_reference/module.html).
- Make sure that you insert the `.js` file generated by Rust after the `Module` variable is created.