Merge pull request #278 from inexorgame/hanni/glfw_input_callback

Use glfw callbacks instead of polling events manually.

Author: IAmNotHanni

include/inexor/vulkan-renderer/application.hpp

@@ -1,5 +1,6 @@
 #pragma once
 
+#include "inexor/vulkan-renderer/input/keyboard_mouse_data.hpp"
 #include "inexor/vulkan-renderer/renderer.hpp"
 
 #include <GLFW/glfw3.h>
@@ -10,39 +11,72 @@
 #include <string>
 #include <vector>
 
+// forward declarations
+namespace inexor::vulkan_renderer::input {
+class KeyboardMouseInputData;
+}
+
 namespace inexor::vulkan_renderer {
 
 class Application : public VulkanRenderer {
     std::string m_application_name;
     std::string m_engine_name;
 
-    std::uint32_t m_application_version{};
-    std::uint32_t m_engine_version{};
+    std::uint32_t m_application_version;
+    std::uint32_t m_engine_version;
 
     std::vector<std::string> m_vertex_shader_files;
     std::vector<std::string> m_fragment_shader_files;
     std::vector<std::string> m_texture_files;
     std::vector<std::string> m_shader_files;
     std::vector<std::string> m_gltf_model_files;
 
+    std::unique_ptr<input::KeyboardMouseInputData> m_input_data;
+
     /// @brief Load the configuration of the renderer from a TOML configuration file.
     /// @brief file_name The TOML configuration file.
     /// @note It was collectively decided not to use JSON for configuration files.
     void load_toml_configuration_file(const std::string &file_name);
     void load_textures();
     void load_shaders();
     void load_octree_geometry();
+    void setup_window_and_input_callbacks();
     void update_imgui_overlay();
     void check_application_specific_features();
     void update_uniform_buffers();
-    void update_mouse_input();
-
-    // TODO: Refactor!
-    double m_cursor_x, m_cursor_y;
+    void process_mouse_input();
+    // TODO: Implement a method for processing keyboard input.
 
 public:
     Application(int argc, char **argv);
 
+    /// @brief Call glfwSetFramebufferSizeCallback.
+    /// @param window The window whose framebuffer was resized.
+    /// @param width The new width, in pixels, of the framebuffer.
+    /// @param height The new height, in pixels, of the framebuffer.
+    void frame_buffer_resize_callback(GLFWwindow *window, int width, int height);
+
+    /// @brief Call glfwSetKeyCallback.
+    /// @param window The window that received the event.
+    /// @param key The keyboard key that was pressed or released.
+    /// @param scancode The system-specific scancode of the key.
+    /// @param action GLFW_PRESS, GLFW_RELEASE or GLFW_REPEAT.
+    /// @param mods Bit field describing which modifier keys were held down.
+    void key_callback(GLFWwindow *window, int key, int scancode, int action, int mods);
+
+    /// @brief Call glfwSetCursorPosCallback.
+    /// @param window The window that received the event.
+    /// @param xpos The new x-coordinate, in screen coordinates, of the cursor.
+    /// @param ypos The new y-coordinate, in screen coordinates, of the cursor.
+    void cursor_position_callback(GLFWwindow *window, double xpos, double ypos);
+
+    /// @brief Call glfwSetMouseButtonCallback.
+    /// @param window The window that received the event.
+    /// @param button The mouse button that was pressed or released.
+    /// @param action One of GLFW_PRESS or GLFW_RELEASE.
+    /// @param mods Bit field describing which modifier keys were held down.
+    void mouse_button_callback(GLFWwindow *window, int button, int action, int mods);
+
     void run();
 };
 

include/inexor/vulkan-renderer/input/keyboard_mouse_data.hpp

@@ -0,0 +1,66 @@
+#pragma once
+
+#include <array>
+#include <unordered_map>
+
+namespace inexor::vulkan_renderer::input {
+
+/// @brief A wrapper for keyboard and mouse input data.
+/// @warning Not thread safe!
+class KeyboardMouseInputData {
+    std::array<std::int64_t, 2> m_previous_cursor_pos{0, 0};
+    std::array<std::int64_t, 2> m_current_cursor_pos{0, 0};
+    std::unordered_map<std::int32_t, bool> m_pressed_keys;
+    std::unordered_map<std::int32_t, bool> m_pressed_mouse_buttons;
+
+public:
+    KeyboardMouseInputData();
+    KeyboardMouseInputData(const KeyboardMouseInputData &) = delete;
+    KeyboardMouseInputData(KeyboardMouseInputData &&) = delete;
+
+    ~KeyboardMouseInputData() = default;
+
+    KeyboardMouseInputData &operator=(const KeyboardMouseInputData &) = delete;
+    KeyboardMouseInputData &operator=(KeyboardMouseInputData &&) = delete;
+
+    /// @brief Change the key's state to pressed.
+    /// @param button The key which was pressed.
+    void press_key(std::int32_t key);
+
+    /// @brief Change the key's state to unpressed.
+    /// @param button The key which was released.
+    void release_key(std::int32_t button);
+
+    /// @brief Change the mouse button's state to pressed.
+    /// @param button The mouse button which was pressed.
+    void press_mouse_button(std::int32_t button);
+
+    /// @brief Change the mouse button's state to unpressed.
+    /// @param button The mouse button which was released.
+    void release_mouse_button(std::int32_t button);
+
+    /// @brief Set the current cursor position.
+    /// @param cursor_pos_x The current x-coordinate of the cursor.
+    /// @param cursor_pos_y The current y-coordinate of the cursor.
+    void set_cursor_pos(double cursor_pos_x, double coursor_pos_y);
+
+    /// @return Return a std::array of size 2 which contains the x-position in index 0 and y-position in index 1.
+    [[nodiscard]] std::array<std::int64_t, 2> get_cursor_pos();
+
+    /// @brief Check if the given mouse button is currently pressed.
+    /// @param mouse_button The mouse button index.
+    /// @returm True if the mouse button is pressed, false otherwise.
+    [[nodiscard]] bool is_mouse_button_pressed(std::int32_t mouse_button);
+
+    /// @brief Check if the given key is currently pressed.
+    /// @param key The key index.
+    /// @retur True if the key is pressed, false otherwise.
+    [[nodiscard]] bool is_key_pressed(std::int32_t key);
+
+    /// @brief Calculate the change in x- and y-position of the cursor.
+    /// @return A std::array of size 2 which contains the change in x-position in index 0
+    /// and the change in y-position in index 1.
+    [[nodiscard]] std::array<double, 2> calculate_cursor_position_delta();
+};
+
+} // namespace inexor::vulkan_renderer::input

include/inexor/vulkan-renderer/wrapper/window.hpp

@@ -11,8 +11,8 @@ namespace inexor::vulkan_renderer::wrapper {
 /// @brief RAII wrapper class for GLFW windows.
 class Window {
     GLFWwindow *m_window;
-    std::uint32_t m_width{0};
-    std::uint32_t m_height{0};
+    std::uint32_t m_width;
+    std::uint32_t m_height;
 
 public:
     /// @brief Default constructor.
@@ -22,10 +22,8 @@ class Window {
     /// @param visible True if the window is visible after creation, false otherwise.
     /// @param resizable True if the window should be resizable, false otherwise.
     Window(const std::string &title, std::uint32_t width, std::uint32_t height, bool visible, bool resizable);
-
     Window(const Window &) = delete;
     Window(Window &&) noexcept;
-
     ~Window();
 
     Window &operator=(const Window &) = delete;
@@ -47,21 +45,24 @@ class Window {
     /// @param frame_buffer_resize_callback The window resize callback.
     void set_resize_callback(GLFWframebuffersizefun frame_buffer_resize_callback);
 
+    /// @brief Call glfwSetKeyCallback.
+    /// @param key_input_callback The keyboard input callback.
+    void set_keyboard_button_callback(GLFWkeyfun keyboard_button_callback);
+
+    /// @brief Call glfwSetCursorPosCallback.
+    /// @param cursor_pos_callback They cursor position callback.
+    void set_cursor_position_callback(GLFWcursorposfun cursor_pos_callback);
+
+    /// @brief Call glfwSetMouseButtonCallback.
+    /// @param mouse_button_callback The mouse button callback.
+    void set_mouse_button_callback(GLFWmousebuttonfun mouse_button_callback);
+
     /// @brief Call glfwShowWindow.
     void show();
 
     /// @brief Call glfwHideWindow.
     void hide();
 
-    /// @brief Returns the cursor position.
-    std::array<double, 2> cursor_pos();
-
-    /// @brief Check if a specifiy button is pressed.
-    /// @param button The button to check.
-    /// @return ``true`` if the button is pressed.
-    /// @todo: Use a callback instead!
-    bool is_button_pressed(int button);
-
     /// @brief Call glfwPollEvents.
     void poll();
 

src/CMakeLists.txt

@@ -12,6 +12,8 @@ set(INEXOR_SOURCE_FILES
     vulkan-renderer/settings_decision_maker.cpp
     vulkan-renderer/time_step.cpp
 
+	vulkan-renderer/input/keyboard_mouse_data.cpp
+
     vulkan-renderer/io/byte_stream.cpp
     vulkan-renderer/io/octree_parser.cpp