Antkeeper  0.0.1
keyboard-events.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2023 Christopher J. Howard
3  *
4  * This file is part of Antkeeper source code.
5  *
6  * Antkeeper source code is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * Antkeeper source code is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with Antkeeper source code. If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef ANTKEEPER_INPUT_KEYBOARD_EVENTS_HPP
21 #define ANTKEEPER_INPUT_KEYBOARD_EVENTS_HPP
22 
23 #include <engine/input/scancode.hpp>
24 #include <engine/input/modifier-key.hpp>
25 #include <cstdint>
26 
27 namespace input {
28 
29 class keyboard;
30 
34 struct key_pressed_event
35 {
37  keyboard* keyboard{nullptr};
38 
40  scancode scancode{0};
41 
43  std::uint16_t modifiers{0};
44 
46  bool repeat{false};
47 };
48 
52 struct key_released_event
53 {
55  keyboard* keyboard{nullptr};
56 
58  scancode scancode{0};
59 
61  std::uint16_t modifiers{0};
62 };
63 
64 } // namespace input
65 
66 #endif // ANTKEEPER_INPUT_KEYBOARD_EVENTS_HPP
input::keyboard
A virtual keyboard which generates keyboard-related input events.
Definition: keyboard.hpp:35
input
Input devices, events, and mapping.
Definition: action-events.hpp:23
input::scancode
scancode
Keyboard scancodes.
Definition: scancode.hpp:33
input::device_type::keyboard
@ keyboard
Keyboard input device.
input::key_pressed_event
Event generated when a keyboard key has been pressed.
Definition: keyboard-events.hpp:35
input::key_pressed_event::repeat
bool repeat
true if the key press was generated by a key repeat, false otherwise.
Definition: keyboard-events.hpp:46
input::key_pressed_event::modifiers
std::uint16_t modifiers
Bit mask containing the active modifier keys.
Definition: keyboard-events.hpp:43
input::key_released_event
Event generated when a keyboard key has been released.
Definition: keyboard-events.hpp:53
input::key_released_event::modifiers
std::uint16_t modifiers
Bit mask containing the active modifier keys.
Definition: keyboard-events.hpp:61