winit - Cross-platform window creation and management in Rust
[]
= "0.18.1"
Documentation
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.
extern crate winit;
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:
icon_loading
: Enables loading window icons directly from files. Depends on theimage
crate.serde
: Enables serialization/deserialization of certain types with 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
. SetModule.canvas
to the element of the<canvas>
element (in the example you would retrieve it viadocument.getElementById("my_id")
). More information here. - Make sure that you insert the
.js
file generated by Rust after theModule
variable is created.