Skip to content

Commit

Permalink
Add documentation to KeyCode for Mac users (#3331)
Browse files Browse the repository at this point in the history
# Objective

`KeyCode::*Win` and `KeyCode::*Alt` might be confusing for some Mac users.

## Solution

Added some small documentation to clarify the mappings for those developing on a Mac.

## Additional Context

Related issue: #3240
  • Loading branch information
MrGVSV committed Dec 15, 2021
1 parent 70c9165 commit add1818
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions crates/bevy_input/src/keyboard.rs
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,12 @@ pub enum KeyCode {
Grave,
Kana,
Kanji,
/// The left alt key. Maps to left option on Mac.
LAlt,
LBracket,
LControl,
LShift,
/// The left Windows key. Maps to left Command on Mac.
LWin,
Mail,
MediaSelect,
Expand All @@ -201,10 +203,12 @@ pub enum KeyCode {
PlayPause,
Power,
PrevTrack,
/// The right alt key. Maps to right option on Mac.
RAlt,
RBracket,
RControl,
RShift,
/// The right Windows key. Maps to right Command on Mac.
RWin,
Semicolon,
Slash,
Expand Down

0 comments on commit add1818

Please sign in to comment.