BackendGuiGLFW.hpp

//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2026 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef TGUI_BACKEND_GUI_GLFW_HPP
#define TGUI_BACKEND_GUI_GLFW_HPP
 
#include <TGUI/Config.hpp>
 
#include <TGUI/Backend/Window/BackendGui.hpp>
 
#include <TGUI/Optional.hpp>

 
using GLFWwindow = struct GLFWwindow;

 
TGUI_IGNORE_DEPRECATED_WARNINGS_START // Required for VS2017 due to inheriting a function that we deprecated
 
    namespace tgui
{
 
    class TGUI_API BackendGuiGLFW : public BackendGui
    {
    public:
        BackendGuiGLFW();

        ~BackendGuiGLFW() override;

        bool windowFocusCallback(int focused);

        bool sizeCallback(int width, int height);

        bool charCallback(unsigned int codepoint);

        bool keyCallback(int key, int scancode, int action, int mods);

        bool scrollCallback(double xoffset, double yoffset);

        bool cursorPosCallback(double xpos, double ypos);

        bool mouseButtonCallback(int button, int action, int mods);

        bool cursorEnterCallback(int entered);

        void mainLoop(Color clearColor = {240, 240, 240}) override;

        [[nodiscard]] Optional<Event> convertWindowFocusEvent(int focused);

        [[nodiscard]] Optional<Event> convertSizeEvent(int width, int height);

        [[nodiscard]] Optional<Event> convertCharEvent(unsigned int codepoint);

        [[nodiscard]] Optional<Event> convertKeyEvent(int key, int scancode, int action, int mods);

        [[nodiscard]] Optional<Event> convertScrollEvent(double xoffset, double yoffset);

        [[nodiscard]] Optional<Event> convertCursorPosEvent(double xpos, double ypos);

        [[nodiscard]] Optional<Event> convertMouseButtonEvent(int button, int action, int mods);

        [[nodiscard]] Optional<Event> convertCursorEnterEvent(int entered);

        GLFWwindow* getWindow() const;

        void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos) override;

        [[nodiscard]] bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) const override;

 
    protected:
        void setGuiWindow(GLFWwindow* window);

        // Updates the view and changes the size of the root container when needed
        void updateContainerSize() override;

 
    protected:
        GLFWwindow* m_window = nullptr;
    };
} // namespace tgui
 
TGUI_IGNORE_DEPRECATED_WARNINGS_END
 
#endif // TGUI_BACKEND_GUI_GLFW_HPP