918430979f
Overhaul the keyboard API in winit to mimic the W3C specification
to achieve better crossplatform parity. The `KeyboardInput` event
is now uses `KeyEvent` which consists of:
- `physical_key` - a cross platform way to refer to scancodes;
- `logical_key` - keysym value, which shows your key respecting the
layout;
- `text` - the text produced by this keypress;
- `location` - the location of the key on the keyboard;
- `repeat` - whether the key was produced by the repeat.
And also a `platform_specific` field which encapsulates extra
information on desktop platforms, like key without modifiers
and text with all modifiers.
The `Modifiers` were also slightly reworked as in, the information
whether the left or right modifier is pressed is now also exposed
on platforms where it could be queried reliably. The support was
also added for the web and orbital platforms finishing the API
change.
This change made the `OptionAsAlt` API on macOS redundant thus it
was removed all together.
Co-authored-by: Artúr Kovács <kovacs.artur.barnabas@gmail.com>
Co-authored-by: Kirill Chibisov <contact@kchibisov.com>
Co-authored-by: daxpedda <daxpedda@gmail.com>
Fixes: #2631.
Fixes: #2055.
Fixes: #2032.
Fixes: #1904.
Fixes: #1810.
Fixes: #1700.
Fixes: #1443.
Fixes: #1343.
Fixes: #1208.
Fixes: #1151.
Fixes: #812.
Fixes: #600.
Fixes: #361.
Fixes: #343.
28 lines
1.1 KiB
Rust
28 lines
1.1 KiB
Rust
#![cfg(any(windows_platform, macos_platform, x11_platform, wayland_platform))]
|
|
|
|
// TODO: Maybe merge this with `modifier_supplement` if the two are indeed supported on the same
|
|
// set of platforms
|
|
|
|
use crate::keyboard::KeyCode;
|
|
|
|
/// Additional methods for the [`KeyCode`] type that allow the user to access the platform-specific
|
|
/// scancode.
|
|
///
|
|
/// [`KeyCode`]: crate::keyboard::KeyCode
|
|
pub trait KeyCodeExtScancode {
|
|
/// The raw value of the platform-specific physical key identifier.
|
|
///
|
|
/// Returns `Some(key_id)` if the conversion was succesful; returns `None` otherwise.
|
|
///
|
|
/// ## Platform-specific
|
|
/// - **Windows:** A 16bit extended scancode
|
|
/// - **Wayland/X11**: A 32-bit X11-style keycode.
|
|
// TODO: Describe what this value contains for each platform
|
|
fn to_scancode(self) -> Option<u32>;
|
|
|
|
/// Constructs a `KeyCode` from a platform-specific physical key identifier.
|
|
///
|
|
/// Note that this conversion may be lossy, i.e. converting the returned `KeyCode` back
|
|
/// using `to_scancode` might not yield the original value.
|
|
fn from_scancode(scancode: u32) -> KeyCode;
|
|
}
|