BackendGLFW.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 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_GLFW_HPP
#define TGUI_BACKEND_GLFW_HPP
 
#include <TGUI/Backend/Window/GLFW/BackendGuiGLFW.hpp>
 
#if !TGUI_BUILD_AS_CXX_MODULE
 #include <TGUI/Backend/Window/Backend.hpp>
#endif
 
#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
 #include <unordered_map>
 #include <map>
#endif
 
 
#if !TGUI_BUILD_AS_CXX_MODULE
 using GLFWwindow = struct GLFWwindow;
 using GLFWcursor = struct GLFWcursor;
#endif
 
 
TGUI_MODULE_EXPORT namespace tgui
{
 class TGUI_API BackendGLFW : public Backend
 {
 public:
 
 ~BackendGLFW() override;
 
 
 void setGuiWindow(BackendGui* gui, GLFWwindow* window);
 
 
 void detatchGui(BackendGui* gui) override;
 
 
 void setMouseCursorStyle(Cursor::Type type, const std::uint8_t* pixels, Vector2u size, Vector2u hotspot) override;
 
 
 void resetMouseCursorStyle(Cursor::Type type) override;
 
 
 void setMouseCursor(BackendGui* gui, Cursor::Type type) override;
 
 
 TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
 
 
 void setClipboard(const String& contents) override;
 
 
 TGUI_NODISCARD String getClipboard() const override;
 
 
 private:
 
 // Helper function to create a system cursor
 TGUI_NODISCARD GLFWcursor* createSystemCursor(Cursor::Type type);
 
 
 // Helper function to update the mouse cursors on all attached guis
 void updateMouseCursorStyle(Cursor::Type type, GLFWcursor* cursor);
 
 
 // Helper function to update the mouse cursor on a window
 void updateShownMouseCursor(GLFWwindow* window, Cursor::Type type);
 
 
 // Returns a window attached to any gui, for when a function needs access to some window
 TGUI_NODISCARD GLFWwindow* getAnyWindow() const;
 
 
 private:
 
 struct GuiResources
 {
 GLFWwindow* window = nullptr;
 Cursor::Type mouseCursor = Cursor::Type::Arrow;
 };
 
 std::unordered_map<BackendGui*, GuiResources> m_guiResources;
 std::unordered_map<Cursor::Type, GLFWcursor*> m_mouseCursors;
 };
 
}
 
 
#endif // TGUI_BACKEND_GLFW_HPP