diff options
Diffstat (limited to 'src/crepe/facade/SDLContext.h')
-rw-r--r-- | src/crepe/facade/SDLContext.h | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/src/crepe/facade/SDLContext.h b/src/crepe/facade/SDLContext.h index b65ba9c..5182dca 100644 --- a/src/crepe/facade/SDLContext.h +++ b/src/crepe/facade/SDLContext.h @@ -110,7 +110,19 @@ public: MouseData mouse_data; WindowData window_data; }; - + /** + * \brief Retrieves the current state of the keyboard. + * + * This method returns the state of all keys on the keyboard, represented as a + * `std::array` of boolean values. Each element of the array corresponds to a + * specific key defined in the `Keycode` enum, and the value indicates whether + * the key is currently pressed (true) or not pressed (false). + * + * \return A `std::array<bool, Keycode::NUM_KEYCODES>` representing the state of + * each key on the keyboard, where `true` means the key is pressed, and + * `false` means it is not pressed. + */ + std::array<bool, Keycode::NUM_KEYCODES> get_keyboard_state(); /** * \brief Gets the singleton instance of SDLContext. * \return Reference to the SDLContext instance. @@ -144,28 +156,16 @@ private: void handle_window_event(const SDL_WindowEvent & window_event, std::vector<SDLContext::EventData> & event_list); /** - * \brief Converts an SDL key code to the custom Keycode type. + * \brief Converts an SDL scan code to the custom Keycode type. * - * This method maps an SDL key code to the corresponding `Keycode` enum value, + * This method maps an SDL scan code to the corresponding `Keycode` enum value, * which is used internally by the system to identify the keys. * - * \param sdl_key The SDL key code to convert. + * \param sdl_key The SDL scan code to convert. * \return The corresponding `Keycode` value or `Keycode::NONE` if the key is unrecognized. */ - Keycode sdl_to_keycode(SDL_Keycode sdl_key); - /** - * \brief Retrieves the current state of the keyboard. - * - * This method returns the state of all keys on the keyboard, represented as a - * `std::array` of boolean values. Each element of the array corresponds to a - * specific key defined in the `Keycode` enum, and the value indicates whether - * the key is currently pressed (true) or not pressed (false). - * - * \return A `std::array<bool, Keycode::NUM_KEYCODES>` representing the state of - * each key on the keyboard, where `true` means the key is pressed, and - * `false` means it is not pressed. - */ - std::array<bool, Keycode::NUM_KEYCODES> get_keyboard_state(); + Keycode sdl_to_keycode(SDL_Scancode sdl_key); + /** * \brief Converts an SDL mouse button code to the custom MouseButton type. * |