Unexpected Logical Key Value

[Shute052]

Bevy version

The main Bevy (currently, commit #08654ad), but the bug actually comes from Bevy PR #10702: Update winit to 0.29

[Optional] Relevant system information

This might be able to reproduce on any machine in the version.

What you did

I am working on the updates of leafwing_input_manager to Bevy 0.13, but as the title says, the logical Key value seems to be incorrect.

Simple Case for Reproduction

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_systems(Update, read_keyboard_input)
        .run()
}

fn read_keyboard_input(mut keyboard_input: EventReader<KeyboardInput>) {
    for input in keyboard_input.read() {
        dbg!(input);
    }
}

What went wrong

The situation is:

• If you just press any letter keys, e.g., W key and then you will get a KeyboardInput(logical_key: "w"), an expected lowercase w letter.
• However, if CapsLock is activated or Shift is pressing, like normal text input, you will get a KeyboardInput(logical_key: "W"), "AN UPPERCASE W LETTER"!

[alice-i-cecile]

Hmm. I'm not sure if this is incorrect behavior. The logical key value seems well-suited to things like text input. Instead, we might want a to_uppercase method or the equivalent, either in Bevy or winit. Then, consumers like LWIM who want to use this for input mapping can normalize their received values.

[Shute052]

Hmm. I'm not sure if this is incorrect behavior. The logical key value seems well-suited to things like text input. Instead, we might want a to_uppercase method or the equivalent, either in Bevy or winit. Then, consumers like LWIM who want to use this for input mapping can normalize their received values.

In many game engines, logical letter keys are simply named enum variants or automatically normalized characters. I believe Bevy game developers who aren't using LWIM also have to address both cases when dealing with widely used letter keys.

[SpecificProtagonist]

Bevy follows the web standards for key codes and logical keys. Key codes identify the physical key location and are invariant of keyboard layout & modifiers, logical keys represent the meaning of the key.

So Bevy behaves as expected (though the distinction between the two could probably be documented better). When I press the KeyW key, whether that logically is w or W or something else depends not just on the keyboard layout, but also on whether shift, shift lock and caps lock are active (and reading Bevy's keyboard input events isn't enough to find out about whether they are) and I believe similarly on any IMEs.