mirror of
https://github.com/italicsjenga/winit-sonoma-fix.git
synced 2024-12-23 22:01:31 +11:00
72509b5b42
* Update example in README.md and add move prefix to window.rs example * Make Window and README example trivially capture window * Update README.md
73 lines
3.1 KiB
Markdown
73 lines
3.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/rust-windowing/winit)
|
|
[](https://ci.appveyor.com/project/Osspial/winit/branch/master)
|
|
|
|
```toml
|
|
[dependencies]
|
|
winit = "0.19.1"
|
|
```
|
|
|
|
## [Documentation](https://docs.rs/winit)
|
|
|
|
## Contact Us
|
|
|
|
Join us in any of these:
|
|
|
|
[](http://webchat.freenode.net?channels=%23glutin&uio=MTY9dHJ1ZSYyPXRydWUmND10cnVlJjExPTE4NSYxMj10cnVlJjE1PXRydWU7a)
|
|
[](https://matrix.to/#/#Glutin:matrix.org)
|
|
[](https://gitter.im/tomaka/glutin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
## 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;
|
|
use winit::window::WindowBuilder;
|
|
use winit::event::{Event, WindowEvent};
|
|
use winit::event_loop::{EventLoop, ControlFlow};
|
|
|
|
fn main() {
|
|
let event_loop = EventLoop::new();
|
|
let window = WindowBuilder::new().build(&event_loop).unwrap();
|
|
|
|
event_loop.run(move |event, _, control_flow| {
|
|
match event {
|
|
Event::WindowEvent {
|
|
event: WindowEvent::CloseRequested,
|
|
window_id,
|
|
} if window_id == window.id() => *control_flow = ControlFlow::Exit,
|
|
_ => *control_flow = ControlFlow::Wait,
|
|
}
|
|
});
|
|
}
|
|
```
|
|
|
|
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.
|