|
1 | 1 | # VKey |
| 2 | +[](https://crates.io/crates/vkey) |
| 3 | +[](https://docs.rs/vkey/latest/vkey/) |
| 4 | +[](https://github.com/clouds56/vkey-rs/actions/workflows/rust.yml) |
| 5 | + |
2 | 6 | This crates only contains various types of virtual keycodes, and conversions between them. |
3 | 7 |
|
4 | 8 | This crate is under heavy development, and subject to breaking changes. |
5 | 9 |
|
6 | | -- [x] Vk from [winput](https://github.com/gymore-io/winput) |
7 | | -- [x] VIRTUAL_KEY from [windows](https://github.com/microsoft/windows-rs) |
8 | | -- [ ] enigo::Key from [enigo](https://github.com/enigo-rs/enigo) (partially done) |
9 | | -- [x] CGKeyCode from [macos](https://github.com/phracker/MacOSX-SDKs) |
10 | | -- [x] Usage from [hut](https://github.com/hidutils/hut) |
11 | | -- [ ] winit::KeyCode from [winit](https://github.com/rust-windowing/winit) (only definitions) |
12 | | -- [x] xkeysym::KeyCode from [xkeysym](https://github.com/rust-windowing/xkeysym) |
| 10 | +- [x] [`winput::Vk`](https://docs.rs/winput/latest/winput/enum.Vk.html) from [`winput`](https://github.com/gymore-io/winput) |
| 11 | +- [x] [`VIRTUAL_KEY`](https://microsoft.github.io/windows-docs-rs/doc/windows/Win32/UI/Input/KeyboardAndMouse/struct.VIRTUAL_KEY.html) from [`windows`](https://github.com/microsoft/windows-rs) (or [mirrored](https://docs.rs/vkey/latest/vkey/mirror/winput/enum.Vk.html)) |
| 12 | +- [x] Wrapped [`Make1Scan`](https://docs.rs/vkey/latest/vkey/mirror/make1/struct.Make1Code.html) for [`MapVirtualKeyW`](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-mapvirtualkeyw) |
| 13 | +- [x] [`enigo::Key`](https://docs.rs/enigo/latest/enigo/enum.Key.html) from [`enigo`](https://github.com/enigo-rs/enigo) |
| 14 | +- [x] [`core_graphics::event::KeyCode`](https://docs.rs/core-graphics/0.24.0/core_graphics/event/struct.KeyCode.html) from [macos](https://github.com/servo/core-foundation-rs) (or [wrapped](https://docs.rs/vkey/latest/vkey/mirror/macos_ext/struct.CGKeyCode.html)) |
| 15 | +- [x] [`Usage`](https://docs.rs/hut/latest/hut/enum.Usage.html) from [`hut`](https://github.com/hidutils/hut) (both hut_03 and hut_04 supported) |
| 16 | +- [ ] [`winit::KeyCode`](https://docs.rs/winit/latest/winit/keyboard/enum.KeyCode.html) from [`winit`](https://github.com/rust-windowing/winit) (only definitions) |
| 17 | + * TODO: support for `winit::NamedKey`, `winit::NativeKey`, `winit::NativeKeyCode` and `winit::PhysicalKey` |
| 18 | +- [x] [`xkeysym::Keysym`](https://docs.rs/xkeysym/0.2.1/xkeysym/struct.Keysym.html) from [`xkeysym`](https://github.com/rust-windowing/xkeysym) |
| 19 | + * TODO: support for `xkeysym::KeyCode` |
13 | 20 |
|
14 | 21 | Following conditions are considered as BUG: |
15 | 22 | * If any type cannot be accessed from any platform. |
16 | 23 | * if any type could not be converted to another type. |
17 | | -* if any "mirrored" type is not synced with "underlying" type. |
| 24 | +* if any "mirror" type is not synced with "dep" type. |
18 | 25 |
|
19 | 26 | # Limitations |
20 | | -we would also like to add conversion between "mirrored" types and "underlying" types. |
| 27 | +we would also like to add conversion between "mirror" types and "dep" types. |
0 commit comments