No description
Find a file
Mads Marquart dbcdb6f1b4
Add safe area and document coordinate systems (#3890)
Added `Window::safe_area`, which describes the area of the surface that
is unobstructed by notches, bezels etc. The drawing code in the examples
have been updated to draw a star inside the safe area, and the plain
background outside of it.

Also renamed `Window::inner_position` to `Window::surface_position`, and
changed it to from screen coordinates to window coordinates, to better
align how these coordinate systems work together.

Finally, added some SVG images and documentation to describe how all of
this works.

This is fully implemented on macOS and iOS, and partially on the web.

Co-authored-by: daxpedda <daxpedda@gmail.com>
2024-11-21 17:37:03 +01:00
.cargo Use Taplo for TOML formatting 2024-07-28 17:38:44 +02:00
.github Add support for MacOS ARM64 (#3862) 2024-08-13 23:01:17 +02:00
docs Add safe area and document coordinate systems (#3890) 2024-11-21 17:37:03 +01:00
dpi Add safe area and document coordinate systems (#3890) 2024-11-21 17:37:03 +01:00
examples Add safe area and document coordinate systems (#3890) 2024-11-21 17:37:03 +01:00
src Add safe area and document coordinate systems (#3890) 2024-11-21 17:37:03 +01:00
tests api: convert Window to dyn Window 2024-08-23 23:40:27 +03:00
.git-blame-ignore-revs Add to .git-blame-ignore-revs file 2024-07-28 17:39:04 +02:00
.gitattributes Update changelog guidelines to prevent conflicts from blocking PRs (#2145) 2022-01-23 13:55:33 +01:00
.gitignore Move to TypeScript (#3830) 2024-07-27 18:26:52 +02:00
build.rs Move iOS and macOS implementations into new apple module (#3756) 2024-06-24 13:26:49 +02:00
Cargo.toml Add safe area and document coordinate systems (#3890) 2024-11-21 17:37:03 +01:00
CHANGELOG.md chore(docs): make changelogs visible on docsrs 2024-03-15 17:19:19 +04:00
clippy.toml Use Taplo for TOML formatting 2024-07-28 17:38:44 +02:00
CODE_OF_CONDUCT.md docs: add a code of conduct 2024-03-07 17:32:06 +04:00
CONTRIBUTING.md docs: fix release steps in CONTRIBUTING.md 2024-04-18 20:27:31 +04:00
deny.toml ci: fix cargo deny 2024-11-21 10:28:32 +03:00
FEATURES.md Remove EventLoopExtIOS::idiom and ios::Idiom (#2924) 2024-06-24 22:56:20 +02:00
HALL_OF_CHAMPIONS.md Changes and improvements to the documentation (#3253) 2023-12-03 18:39:08 +01:00
LICENSE Initial commit 2014-07-27 11:41:26 +02:00
README.md Bump version on master 2024-08-08 21:40:08 +03:00
rustfmt.toml Use Taplo for TOML formatting 2024-07-28 17:38:44 +02:00
taplo.toml Use Taplo for TOML formatting 2024-07-28 17:38:44 +02:00
typos.toml Add safe area and document coordinate systems (#3890) 2024-11-21 17:37:03 +01:00

winit - Cross-platform window creation and management in Rust

Crates.io Docs.rs Master Docs CI Status

[dependencies]
winit = "0.30.5"

Documentation

For features within the scope of winit, see FEATURES.md.

For features outside the scope of winit, see Are we GUI Yet? and Are we game yet?, depending on what kind of project you're looking to do.

Contact Us

Join us in our Matrix room.

The maintainers have a meeting every friday at UTC 15. The meeting notes can be found here.

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 the 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.

MSRV Policy

This crate's Minimum Supported Rust Version (MSRV) is 1.73. Changes to the MSRV will be accompanied by a minor version bump.

As a tentative policy, the upper bound of the MSRV is given by the following formula:

min(sid, stable - 3)

Where sid is the current version of rustc provided by Debian Sid, and stable is the latest stable version of Rust. This bound may be broken in case of a major ecosystem shift or a security vulnerability.

An exception is made for the Android platform, where a higher Rust version must be used for certain Android features. In this case, the MSRV will be capped at the latest stable version of Rust minus three. This inconsistency is not reflected in Cargo metadata, as it is not powerful enough to expose this restriction.

Redox OS is also not covered by this MSRV policy, as it requires a Rust nightly toolchain to compile.

All crates in the rust-windowing organizations have the same MSRV policy.

Platform-specific usage

Check out the winit::platform module for platform-specific usage.