mirror of
https://github.com/italicsjenga/winit-sonoma-fix.git
synced 2024-10-17 23:41:33 +11:00
62 lines
2.4 KiB
Markdown
62 lines
2.4 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.18.1"
|
|
```
|
|
|
|
## [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 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](https://crates.io/crates/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](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.
|