Update winit dependency to 0.29

[Vrixyz]

Objective

• Update winit dependency to 0.29

Changelog

KeyCode changes

• Removed ScanCode, as it was replaced by KeyCode.
• ReceivedCharacter.char is now a SmolStr, relevant doc.
• Changed most KeyCode values, and added more.

KeyCode has changed meaning. With this PR, it refers to physical position on keyboard rather than the printed letter on keyboard keys.

In practice this means:

• On QWERTY keyboard layouts, nothing changes
• On any other keyboard layout, KeyCode no longer reflects the label on key.
  • This is "good". In bevy 0.12, when you used WASD for movement, users with non-QWERTY keyboards couldn't play your game! This was especially bad for non-latin keyboards. Now, WASD represents the physical keys. A French player will press the ZQSD keys, which are near each other, Kyrgyz players will use "Цфыв".
  • This is "bad" as well. You can't know in advance what the label of the key for input is. Your UI says "press WASD to move", even if in reality, they should be pressing "ZQSD" or "Цфыв". You also no longer can use KeyCode for text inputs. In any case, it was a pretty bad API for text input. You should use ReceivedCharacter now instead.

Other changes

• Use web-time rather than instant crate. (Replace instant with web-time rust-windowing/winit#2836)
• winit did split run_return in run_onDemand and pump_events, I did the same change in bevy_winit and used pump_events.
• Removed return_from_run from WinitSettings as winit::run now returns on supported platforms.
  • I left the example "return_after_run" as I think it's still useful.
  • This winit change is done partly to allow to create a new window after quitting all windows: eframe: create multiple windows in sequence emilk/egui#1918 ; this PR doesn't address.
• added width and height properties in the canvas from wasm example (Update winit dependency to 0.29 #10702 (comment))

Known regressions (important follow ups?)

• Provide an API for reacting when a specific key from current layout was released.
  • possible solutions: use winit::Key from winit::KeyEvent ; mapping between KeyCode and Key ; or .
• We don't receive characters through alt+numpad (e.g. alt + 151 = "ù") anymore ; reproduced on winit example "ime". maybe related to Pressing Alt on Windows discards key information rust-windowing/winit#2945
• (windows) Window content doesn't refresh at all when resizing. By reading EventLoop 3.0 Changes rust-windowing/winit#2900 ; I suspect we should just fire a window.request_redraw(); from AboutToWait, and handle actual redrawing within RedrawRequested. I'm not sure how to move all that code so I'd appreciate it to be a follow up.
• (windows) unreleased winit fix for using set_control_flow in AboutToWait Windows: set_control_flow has no effect from AboutToWait event rust-windowing/winit#3215 ; ⚠️ I'm not sure what the implications are, but that feels bad 🤔

Follow up

I'd like to avoid bloating this PR, here are a few follow up tasks worthy of a separate PR, or new issue to track them once this PR is closed, as they would either complicate reviews, or at risk of being controversial:

• remove CanvasParentResizePlugin (Update winit dependency to 0.29 #10702 (comment))
• avoid mentionning explicitly winit in docs from bevy_window ?
• NamedKey integration on bevy_input: Revise Key, KeyCode enums rust-windowing/winit#3143 introduced a new NamedKey variant. I implemented it only on the converters but we'd benefit making the same changes to bevy_input.
• Add more info in KeyboardInput Update winit dependency to 0.29 #10702 (review)
• macOS Sonoma (14.0) / Xcode 15.0 — Compatibility Fixes + Docs #9905 added a workaround on a bug allegedly fixed by winit 0.29. We should check if it's still necessary.
• update to raw_window_handle 0.6
  • blocked by wgpu
• Rename KeyCode to PhysicalKeyCode Update winit dependency to 0.29 #10702 (comment)
• remove instant dependency, replaced by web_time), we'd need to update to :
  • fastrand >= 2.0
    • async-executor >= 1.7
    • futures-lite >= 2.0
• Verify license, see discussion
  • we might be missing a short notice or description of changes made
• Consider using https://github.com/rust-windowing/cursor-icon directly rather than vendoring it in bevy.
• investigate this unwrap (winit_window.canvas().unwrap();)
• Use more good things about winit's update
  • KeyCode::key_char #10689 (comment)

Migration Guide

This PR should have one.

[Shute052]

Is there any ways can translate a KeyCode into its logical Key or ReceivedCharacter?

[Vrixyz]

No, I'm guessing you're asking in the context of mvlabat/bevy_egui#236 ; what we'll probably want is to hook on KeyboardInput to retrieve the logical key.

[Shute052]

No, I'm guessing you're asking in the context of mvlabat/bevy_egui#236 ; what we'll probably want is to hook on KeyboardInput to retrieve the logical key.

The problem is listed in the leafwing-input-manager PR for updates with Bevy 0.13