1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
/// A list of all available *Virtual-Key Codes*. /// /// The official definition can be found [here][vk_link]. /// /// [vk_link]: https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes #[repr(u8)] #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)] #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] pub enum Vk { /// Left mouse button /// /// **VK_LBUTTON** = 0x01 MouseLeft = 0x01, /// Right mouse button /// /// **VK_RBUTTON** = 0x02 MouseRight = 0x02, /// Control-break processing /// /// **CANCEL** = 0x03 Cancel = 0x03, /// Middle mouse button (three-button mouse) /// /// **VK_MBUTTON** = 0x04 MouseMiddle = 0x04, /// X1 mouse button /// /// **VK_XBUTTON1** = 0x05 MouseX1 = 0x05, /// X2 mouse button /// /// **VK_XBUTTON1** = 0x06 MouseX2 = 0x06, /// BACKSPACE key /// /// **VK_BACK** = 0x08 Backspace = 0x08, /// TAB key /// /// **VK_TAB** = 0x09 Tab = 0x09, /// CLEAR key /// /// **VK_CLEAR** = 0x0c Clear = 0x0c, /// ENTER key /// /// **VK_RETURN** = 0x0d Enter = 0x0d, /// SHIFT key /// /// **VK_SHIFT** = 0x10 Shift = 0x10, /// CTRL key /// /// **VK_CONTROL** = 0x11 Control = 0x11, /// ALT key /// /// **VK_MENU** = 0x12 Alt = 0x12, /// PAUSE key /// /// **VK_PAUSE** = 0x13 Pause = 0x13, /// CAPS LOCK key /// /// **VK_CAPITAL** = 0x14 CapsLock = 0x14, /// IME Kana mode & IME Hangul mode /// /// **VK_KANA** = **VK_HANGUL** = 0x15 Kana = 0x15, /// IME On /// /// **VK_IME_ON** = 0x16 ImeOn = 0x16, /// IME Junja mode /// /// **VK_JUNJA** = 0x17 Junja = 0x17, /// IME final mode /// /// **VK_FINAL** = 0x18 Final = 0x18, /// IME Kanji mode & IME Hanja mode /// /// **VK_KANJI** = **VK_HANJA** = 0x19 Kanji = 0x19, /// IME Off /// /// **VK_Ime** = 0x1a ImeOff = 0x1a, /// ESC key /// /// **VK_ESCAPE** = 0x1b Escape = 0x1b, /// IME convert /// /// **VK_CONVERT** = 0x1c Convert = 0x1c, /// IME nonconvert /// /// **VK_NONCONVERT** = 0x1d NonConvert = 0x1d, /// IME accept /// /// **VK_ACCEPT** = 0x1e Accept = 0x1e, /// IME mode change request /// /// **VK_MODECHANGE** = 0x1f ModeChange = 0x1f, /// SPACEBAR /// /// **VK_SPACE** = 0x20 Space = 0x20, /// PAGE UP key /// /// **VK_PRIOR** = 0x21 PageUp = 0x21, /// PAGE DOWN key /// /// **VK_NEXT** = 0x22 PageDown = 0x22, /// END key /// /// **VK_END** = 0x23 End = 0x23, /// HOME key /// /// **VK_HOME** = 0x24 Home = 0x24, /// LEFT ARROW key /// /// **VK_LEFT** = 0x25, LeftArrow = 0x25, /// UP ARROW key /// /// **VK_UP** = 0x26 UpArrow = 0x26, /// RIGHT ARROW key /// /// **VK_RIGHT** = 0x27 RightArrow = 0x27, /// DOWN ARROW key /// /// **VK_DOWN** = 0x28 DownArrow = 0x28, /// SELECT key /// /// **VK_SELECT** = 0x29 Select = 0x29, /// PRINT key /// /// **VK_PRINT** = 0x2a Print = 0x2a, /// EXECUTE key /// /// **VK_EXECUTE** = 0x2b Execute = 0x2b, /// PRINT SCREEN key /// /// **VK_SNAPSHOT** = 0x2c PrintScreen = 0x2c, /// INS key /// /// **VK_INSERT** = 0x2d Insert = 0x2d, /// DEL key /// /// **VK_DELETE** = 0x2e Delete = 0x2e, /// HELP key /// /// **VK_HELP** = 0x2f, Help = 0x2f, /// 0 key _0 = b'0', /// 1 key _1 = b'1', /// 2 key _2 = b'2', /// 3 key _3 = b'3', /// 4 key _4 = b'4', /// 5 key _5 = b'5', /// 6 key _6 = b'6', /// 7 key _7 = b'7', /// 8 key _8 = b'8', /// 9 key _9 = b'9', /// A key A = b'A', /// B key B = b'B', /// C key C = b'C', /// D key D = b'D', /// E key E = b'E', /// F key F = b'F', /// G key G = b'G', /// H key H = b'H', /// I key I = b'I', /// J key J = b'J', /// K key K = b'K', /// L key L = b'L', /// M key M = b'M', /// N key N = b'N', /// O key O = b'O', /// P key P = b'P', /// Q key Q = b'Q', /// R key R = b'R', /// S key S = b'S', /// T key T = b'T', /// U key U = b'U', /// V key V = b'V', /// W key W = b'W', /// X key X = b'X', /// Y key Y = b'Y', /// Z key Z = b'Z', /// Left Windows key (Natural keyboard) /// /// **VK_LWIN** = 0x5b, LeftWin = 0x5b, /// Right Windows key (Natural keyboard) /// /// **VK_RWIN** = 0x5c RightWin = 0x5c, /// Applications key (Natural keyboard) /// /// **VK_APPS** = 0x5d Apps = 0x5d, /// Computer Sleep key /// /// **VK_SLEEP** = 0x5f Sleep = 0x5f, /// Numeric keypad 0 key /// /// **VK_NUMPAD0** = 0x60 Numpad0 = 0x60, /// Numeric keypad 1 key /// /// **VK_NUMPAD1** = 0x61 Numpad1 = 0x61, /// Numeric keypad 2 key /// /// **VK_NUMPAD2** = 0x62 Numpad2 = 0x62, /// Numeric keypad 3 key /// /// **VK_NUMPAD3** = 0x63 Numpad3 = 0x63, /// Numeric keypad 4 key /// /// **VK_NUMPAD4** = 0x64 Numpad4 = 0x64, /// Numeric keypad 5 key /// /// **VK_NUMPAD5** = 0x65 Numpad5 = 0x65, /// Numeric keypad 6 key /// /// **VK_NUMPAD6** = 0x66 Numpad6 = 0x66, /// Numeric keypad 7 key /// /// **VK_NUMPAD7** = 0x67 Numpad7 = 0x67, /// Numeric keyapd 8 key /// /// **VK_NUMPAD8** = 0x68 Numpad8 = 0x68, /// Numeric keypad 9 key /// /// **VK_NUMPAD9** = 0x69 Numpad9 = 0x69, /// Multiply key /// /// **VK_MULTIPLY** = 0x6a Multiply = 0x6a, /// Add key /// /// **VK_ADD** = 0x6b, Add = 0x6b, /// Separator key /// /// **VK_SEPARATOR** = 0x6c, Separator = 0x6c, /// Subtract key /// /// **VK_SUBTRACT** = 0x6d Subtract = 0x6d, /// Decimal key /// /// **VK_DECIMAL** = 0x6e Decimal = 0x6e, /// Divide key /// /// **VK_DIVIDE** = 0x6f Divide = 0x6f, /// F1 key /// /// **VK_F1** = 0x70 F1 = 0x70, /// F2 key /// /// **VK_F2** = 0x71 F2 = 0x71, /// F3 key /// /// **VK_F3** = 0x72 F3 = 0x72, /// F4 key /// /// **VK_F4** = 0x73 F4 = 0x73, /// F5 key /// /// **VK_F5** = 0x74 F5 = 0x74, /// F6 key /// /// **VK_F6** = 0x75 F6 = 0x75, /// F7 key /// /// **VK_F7** = 0x76 F7 = 0x76, /// F8 key /// /// **VK_F8** = 0x77, F8 = 0x77, /// F9 key /// /// **VK_F9** = 0x78, F9 = 0x78, /// F10 key /// /// **VK_F10** = 0x79, F10 = 0x79, /// F11 key /// /// **VK_F11** = 0x7a F11 = 0x7a, /// F12 key /// /// **VK_F12** = 0x7b F12 = 0x7b, /// F13 key /// /// **VK_F13** = 0x7c F13 = 0x7c, /// F14 key /// /// **VK_F14** = 0x7d F14 = 0x7d, /// F15 key /// /// **VK_F15** = 0x7e F15 = 0x7e, /// F16 key /// /// **VK_F16** = 0x7f F16 = 0x7f, /// F17 key /// /// **VK_F17** = 0x80 F17 = 0x80, /// F18 key /// /// **VK_F18** = 0x81, F18 = 0x81, /// F19 key /// /// **VK_F19** = 0x82, F19 = 0x82, /// F20 key /// /// **VK_F20** = 0x83, F20 = 0x83, /// F21 key /// /// **VK_F21** = 0x84, F21 = 0x84, /// F22 key /// /// **VK_F22** = 0x85, F22 = 0x85, /// F23 key /// /// **VK_F23** = 0x86, F23 = 0x86, /// F24 key /// /// **VK_F24** = 0x87, F24 = 0x87, /// NUM LOCK key /// /// **VK_NUMLOCK** = 0x90 Numlock = 0x90, /// SCROLL LOCK key /// /// **VK_SCROLL** = 0x91 Scroll = 0x91, /// Left SHIFT key /// /// **VK_LSHIFT** = 0xa0 LeftShift = 0xa0, /// Right SHIFT key /// /// **VK_RSHIFT** = 0xa1 RightShift = 0xa1, /// Left CONTROL key /// /// **VK_LCONTROL** = 0xa2 LeftControl = 0xa2, /// Right CONTROL key /// /// **VK_RCONTROL** = 0xa3 RightControl = 0xa3, /// Left MENU key /// /// **VK_LMENU** = 0xa4 LeftMenu = 0xa4, /// Right MENU key /// /// **VK_RMENU** = 0xa5 RightMenu = 0xa5, /// Browser Back key /// /// **VK_BROWSER_BACK** = 0xa6 BrowserBack = 0xa6, /// Browser Forward key /// /// **VK_BROWSER_FORWARD** = 0xa7 BrowserForward = 0xa7, /// Browser Refresh key /// /// **VK_BROWSER_REFRESH** = 0xa8 BrowserRefresh = 0xa8, /// Browser Stop key /// /// **VK_BROWSER_STOP** = 0xa9 BrowserStop = 0xa9, /// Browser Search key /// /// **VK_BROWSER_SEARCH** = 0xaa BrowserSearch = 0xaa, /// Browser Favorites key /// /// **VK_BROWSER_FAVORITES** = 0xab BrowserFavorites = 0xab, /// Browser Start and Home key /// /// **VK_BROWSER_HOME** = 0xac BrowserHome = 0xac, /// Volume Mute key /// /// **VK_VOLUME_MUTE** = 0xad VolumeMute = 0xad, /// Volume Down key /// /// **VK_VOLUME_DOWN** = 0xae VolumeDown = 0xae, /// Volume Up key /// /// **VK_VOLUME_UP** = 0xaf VolumeUp = 0xaf, /// Next Track key /// /// **VK_MEDIA_NEXT_TRACK** = 0xb0 NextTrack = 0xb0, /// Prev Track key /// /// **VK_MEDIA_PREV_TRACK** = 0xb1 PrevTrack = 0xb1, /// Stop Media key /// /// **VK_MEDIA_STOP** = 0xb2 MediaStop = 0xb2, /// Play/Pause Media key /// /// **VK_MEDIA_PLAY_PAUSE** = 0xb3 MediaPlayPause = 0xb3, /// Start Mail key /// /// **VK_LAUNCH_MAIL** = 0xb4 StartMail = 0xb4, /// Select Media key /// /// **VK_LAUNCH_MEDIA_SELECT** = 0xb5 SelectMedia = 0xb5, /// Start Application 1 key /// /// **VK_LAUNCH_APP1** = 0xb6 StartApp1 = 0xb6, /// Start Application 2 key /// /// **VK_LAUNCH_APP2** = 0xb7 StartApp2 = 0xb7, /// Used for miscellaneous characters; it can vary by keyboard. For the US standard /// keyboard, the `;:` key. /// /// **VK_OEM_1** = 0xba Oem1 = 0xba, /// For any country/region, the `+` key. /// /// **VK_OEM_PLUS** = 0xbb Plus = 0xbb, /// For any country/region, the `,` key. /// /// **VK_OEM_COMMA** = 0xbc Comma = 0xbc, /// For any country/region, the `-` key. /// /// **VK_OEM_MINUS** = 0xbd Minus = 0xbd, /// For any country/region, the `.` key. /// /// **VK_OEM_PERIOD** = 0xbe Period = 0xbe, /// Used for miscellaneous characters; it can vary by keyboard. For the US standard /// keyboard, the `\?` key. /// /// **VK_OEM_2** = 0xbf Oem2 = 0xbf, /// Used for miscellaneous characters; it can vary by keyboard. For the US standard /// keyboard, the ``~` key. /// /// **VK_OEM_3** = 0xc0 Oem3 = 0xc0, /// Used for miscellaneous characters; it can vary by keyboard. For the US standard /// keyboard, the `[{` key. /// /// **VK_OEM_4** = 0xdb Oem4 = 0xdb, /// Used for miscellaneous characters; it can vary by keyboard. For the US standard /// keyboard, the `\|` key. /// /// **VK_OEM_5** = 0xdc Oem5 = 0xdc, /// Used for miscellaneous characters; it can vary by keyboard. For the US standard /// keyboard, the `]}` key. /// /// **VK_OEM_6** = 0xdd Oem6 = 0xdd, /// Used for miscellaneous characters; it can vary by keyboard. For the US standard /// keyboard, the `'"` key. /// /// **VK_OEM_7** = 0xde Oem7 = 0xde, /// Used for miscellaneous characters; it can vary by keyboard. /// /// **VK_OEM_8** = 0xdd Oem8 = 0xdf, /// Either the angle bracket key or the backslash key on the RT 102-key keyboard. /// /// **VK_OEM_102** = 0xe2 Oem102 = 0xe2, /// IME PROCESS key /// /// **VK_PROCESSKEY** = 0xe5 ImeProcess = 0xe5, /// Attn key /// /// **VK_ATTN** = 0xf6 Attn = 0xf6, /// CrSel key /// /// **VK_CRSEL** = 0xf7 CrSel = 0xf7, /// ExSel key /// /// **VK_EXSEL** = 0xf8 ExSel = 0xf8, /// Erase EOF key /// /// **VK_EREOR** = 0xf9 EraseEof = 0xf9, /// Play key /// /// **VK_PLAY** = 0xfa Play = 0xfa, /// Zoom key /// /// **VK_ZOOM** = 0xfb Zoom = 0xfb, /// PA1 key /// /// **VK_PA1** = 0xfd Pa1 = 0xfd, /// Clear key /// /// **VK_OEM_CLEAR** = 0xfe OemClear = 0xfe, } macro_rules! from_vk_for_num { ($($t:ty)+) => { $( impl From<Vk> for $t { #[inline(always)] fn from(vk: Vk) -> Self { vk as Self } } )+ }; } from_vk_for_num!(u8 u16 u32 u64 u128 i8 i16 i32 i64 i128); impl Vk { /// Creates a Virtual-Key Code from the given `u8`. /// /// ## Safety /// /// This function is safe as long as the given number `n` is a valid Virtual-Key Code. /// Providing a invalid number is *undefined behaviour*. /// /// ## Example /// /// ```rust /// use winput::Vk; /// /// // SAFETY: `0x0d` is a valid Virtual-Key Code. /// let vk = unsafe { Vk::from_u8(0x0d) }; /// assert_eq!(vk, Vk::Enter); /// ``` /// /// A safe way to use this function is to convert a Virtual-Key Code into a number. /// /// ```rust /// use winput::Vk; /// /// let n = Vk::Escape.into_u8(); /// /// // SAFETY: `n` is a valid Virtual-Key Code. /// let vk = unsafe { Vk::from_u8(n) }; /// assert_eq!(vk, Vk::Escape); /// ``` #[inline(always)] pub unsafe fn from_u8(n: u8) -> Self { // SAFETY: The caller must ensure that the given `u8` represents a valid // Virtual-Key Code. std::mem::transmute(n) } /// Converts this Virtual-Key Code into a `u8`. /// /// ## Example /// /// ```rust /// use winput::Vk; /// /// let value = Vk::Enter.into_u8(); /// assert_eq!(value, 0x0d); /// ``` #[inline(always)] pub fn into_u8(self) -> u8 { self.into() } /// Checks if this Virtual-Key Code is currently being pressed. /// /// ## Example /// /// ```rust, ignore /// use winput::Vk; /// /// if Vk::Z.is_down() { /// println!("The Z key is down!"); /// } else { /// println!("The Z key is not down :("); /// } /// ``` pub fn is_down(self) -> bool { use winapi::um::winuser::GetAsyncKeyState; const MASK: u16 = 0x8000; // Calling C code let state = unsafe { GetAsyncKeyState(self.into()) } as u16; state & MASK == MASK } /// Checks if the given key is currently toggled. /// /// For example, the `Vk::CapsLock` can be either on or off (appart from being /// down or up). /// /// ## Example /// /// ```rust, ignore /// use winput::Vk; /// /// if Vk::CapsLock.is_toggled() { /// println!("Do you like writing in all caps?"); /// } else { /// println!("I knew it! No one ever uses this key!"); /// } /// ``` pub fn is_toggled(self) -> bool { use winapi::um::winuser::GetKeyState; const MASK: u16 = 0x0001; // Calling C code let state = unsafe { GetKeyState(self.into()) } as u16; state & MASK == MASK } }