mirror of
https://github.com/italicsjenga/winit-sonoma-fix.git
synced 2024-12-25 14:51:30 +11:00
769d4fe897
* partial implementation for emscripten
this pull request contain a partial but working implementation of emscripten backend
some implementations may be controversial.
here some implementation detail:
* cursor state:
* on grab: emscripten request pointer lock deferred and also set a callback when pointer lock change
the callback request pointer lock deferred.
* on hide: `emscripten_hide_mouse` exist but not `emscripten_show_mouse`
a pull request has been open on october 2016 but never been merged
so I copied the javascript function and put it in emscripten_asm_const function
* fullscreen: if fullscreen is requested then it request fullscreen deferred and set a callback on fullscreen change
the callback request fullscreen deferred
* run forever: this method use emscripten main loop to run an infinite loop
* keyboard callback doesn't consume the event. I think it is more apopriate as in desktop environment it is the same, is it ?
* emscripten dir is added in example and contains html pages
Some things that are not implemented:
* lots of events
* min and max dimension can be implemented with a callback that listen to size change and resize if dimension out of bound
* title may be implemented using javascript to change document.title
* Use std::os::raw in the emscripten bindings
* Fix emscripten code
* Update code
* Add CI
* Remove the emscripten-specific examples
* Add some information to the README
56 lines
2 KiB
Markdown
56 lines
2 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 mouvement, 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::Closed, .. } => {
|
|
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 ID of the `<canvas>` element (in the example this would be `"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.
|