eadd9a19b2
* Replace Closed event with CloseRequested and Destroyed Implements #434 The existing Closed event had ambiguous meaning, both in name and in cross-platform behavior. Closed is now split into two more precise events: * CloseRequested - the window has been requested to close, most commonly by having clicked the window's close button. Whether or not you respond by closing the window is up to you. * Destroyed - the window has been destroyed, and can no longer be safely used. Most notably, now you can reliably implement classic patterns like prompting the user to save their work before closing, and have the opportunity to perform any necessary cleanup. Migrating to the new API is straightforward. In most cases, you can simply replace all existing usages of Closed with CloseRequested. For more information, see the example programs, particularly handling_close and multiwindow. iOS applications must replace all usages of Closed with Destroyed, and require no other changes.
56 lines
2.1 KiB
Markdown
56 lines
2.1 KiB
Markdown
# winit - Cross-platform window creation and management in Rust
|
|
|
|
[](https://crates.io/crates/winit)
|
|
|
|
[](https://docs.rs/winit)
|
|
|
|
[](https://travis-ci.org/tomaka/winit)
|
|
[](https://ci.appveyor.com/project/tomaka/winit/branch/master)
|
|
|
|
```toml
|
|
[dependencies]
|
|
winit = "0.7"
|
|
```
|
|
|
|
## [Documentation](https://docs.rs/winit)
|
|
|
|
## 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.
|
|
|
|
```rust
|
|
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,
|
|
}
|
|
});
|
|
}
|
|
```
|
|
|
|
### 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.
|