Enum PhysicalKey

Source

#[non_exhaustive]pub enum PhysicalKey {
Show 127 variants    Backquote,
    Backslash,
    BracketLeft,
    BracketRight,
    Comma,
    Digit0,
    Digit1,
    Digit2,
    Digit3,
    Digit4,
    Digit5,
    Digit6,
    Digit7,
    Digit8,
    Digit9,
    Equal,
    IntlBackslash,
    IntlRo,
    IntlYen,
    KeyA,
    KeyB,
    KeyC,
    KeyD,
    KeyE,
    KeyF,
    KeyG,
    KeyH,
    KeyI,
    KeyJ,
    KeyK,
    KeyL,
    KeyM,
    KeyN,
    KeyO,
    KeyP,
    KeyQ,
    KeyR,
    KeyS,
    KeyT,
    KeyU,
    KeyV,
    KeyW,
    KeyX,
    KeyY,
    KeyZ,
    Minus,
    Period,
    Quote,
    Semicolon,
    Slash,
    AltLeft,
    AltRight,
    Backspace,
    CapsLock,
    ContextMenu,
    ControlLeft,
    ControlRight,
    Enter,
    MetaLeft,
    MetaRight,
    ShiftLeft,
    ShiftRight,
    Space,
    Tab,
    Delete,
    End,
    Help,
    Home,
    Insert,
    PageDown,
    PageUp,
    ArrowDown,
    ArrowLeft,
    ArrowRight,
    ArrowUp,
    NumLock,
    Numpad0,
    Numpad1,
    Numpad2,
    Numpad3,
    Numpad4,
    Numpad5,
    Numpad6,
    Numpad7,
    Numpad8,
    Numpad9,
    NumpadAdd,
    NumpadBackspace,
    NumpadClear,
    NumpadComma,
    NumpadDecimal,
    NumpadDivide,
    NumpadEnter,
    NumpadEqual,
    NumpadMultiply,
    NumpadParenLeft,
    NumpadParenRight,
    NumpadSubtract,
    Escape,
    PrintScreen,
    ScrollLock,
    Pause,
    F1,
    F2,
    F3,
    F4,
    F5,
    F6,
    F7,
    F8,
    F9,
    F10,
    F11,
    F12,
    F13,
    F14,
    F15,
    F16,
    F17,
    F18,
    F19,
    F20,
    F21,
    F22,
    F23,
    F24,
    Unidentified,
}

Expand description

The physical key — the layout-independent position on the board, mirroring the W3C UI Events KeyboardEvent.code set (KeyA, Numpad1, ShiftRight, F14). Unlike LogicalKey this does not change with keyboard layout or held modifiers: the key west of KeyS is KeyA on QWERTY, AZERTY, and Dvorak alike.

This is the right facet for rebindable controls, WASD-style movement, global hotkeys, and telling duplicate keys apart (numpad Enter vs the main Enter, ShiftLeft vs ShiftRight) — none of which the logical key or the modifier mask can distinguish.

Hosts that cannot report a position use PhysicalKey::Unidentified. Names follow the W3C code spelling (e.g. MetaLeft/MetaRight, not winit’s SuperLeft/SuperRight).

#[non_exhaustive]: match with a wildcard arm, and test mapper coverage against PhysicalKey::ALL. Per-variant docs are omitted — the names are the W3C code spec names and self-describing.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

§

Unidentified

The host could not report a physical position for this key.

Implementations§

Source §

impl PhysicalKey

Source

pub const ALL: &'static [PhysicalKey]

Every variant, in declaration order.

The enum is #[non_exhaustive], so a host input mapper cannot prove coverage with an exhaustive match; its totality test iterates this slice instead (see damascene-winit’s tests for the pattern).