TGUI  1.3.0
Loading...
Searching...
No Matches
BackendGLFW.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2024 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25
26#ifndef TGUI_BACKEND_GLFW_HPP
27#define TGUI_BACKEND_GLFW_HPP
28
29#include <TGUI/Backend/Window/GLFW/BackendGuiGLFW.hpp>
30
31#if !TGUI_BUILD_AS_CXX_MODULE
32 #include <TGUI/Backend/Window/Backend.hpp>
33#endif
34
35#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
36 #include <unordered_map>
37 #include <map>
38#endif
39
41
42#if !TGUI_BUILD_AS_CXX_MODULE
43 using GLFWwindow = struct GLFWwindow;
44 using GLFWcursor = struct GLFWcursor;
45#endif
46
48
49TGUI_MODULE_EXPORT namespace tgui
50{
51 class TGUI_API BackendGLFW : public Backend
52 {
53 public:
54
58 ~BackendGLFW() override;
59
60
69 void setGuiWindow(BackendGui* gui, GLFWwindow* window);
70
71
76 void detatchGui(BackendGui* gui) override;
77
78
87 void setMouseCursorStyle(Cursor::Type type, const std::uint8_t* pixels, Vector2u size, Vector2u hotspot) override;
88
89
96
97
104 void setMouseCursor(BackendGui* gui, Cursor::Type type) override;
105
106
114 TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
115
116
122 void setClipboard(const String& contents) override;
123
124
130 TGUI_NODISCARD String getClipboard() const override;
131
132
134 private:
135
137 // Helper function to create a system cursor
139 TGUI_NODISCARD GLFWcursor* createSystemCursor(Cursor::Type type);
140
141
143 // Helper function to update the mouse cursors on all attached guis
145 void updateMouseCursorStyle(Cursor::Type type, GLFWcursor* cursor);
146
147
149 // Helper function to update the mouse cursor on a window
151 void updateShownMouseCursor(GLFWwindow* window, Cursor::Type type);
152
153
155 // Returns a window attached to any gui, for when a function needs access to some window
157 TGUI_NODISCARD GLFWwindow* getAnyWindow() const;
158
159
161 private:
162
163 struct GuiResources
164 {
165 GLFWwindow* window = nullptr;
166 Cursor::Type mouseCursor = Cursor::Type::Arrow;
167 };
168
169 std::unordered_map<BackendGui*, GuiResources> m_guiResources;
170 std::unordered_map<Cursor::Type, GLFWcursor*> m_mouseCursors;
171 };
172
174}
175
177
178#endif // TGUI_BACKEND_GLFW_HPP
Definition BackendGLFW.hpp:52
TGUI_NODISCARD String getClipboard() const override
Returns the contents of the clipboard.
void setMouseCursor(BackendGui *gui, Cursor::Type type) override
Changes the mouse cursor when the mouse is on top of the window to which the gui is attached.
void setMouseCursorStyle(Cursor::Type type, const std::uint8_t *pixels, Vector2u size, Vector2u hotspot) override
Changes the look of a certain mouse cursor by using a bitmap.
void setClipboard(const String &contents) override
Changes the contents of the clipboard.
TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override
Checks the state for one of the modifier keys.
void detatchGui(BackendGui *gui) override
Informs the backend that a gui object is being destroyed.
~BackendGLFW() override
Destructor.
void resetMouseCursorStyle(Cursor::Type type) override
Changes the look of a certain mouse cursor back to the system theme.
void setGuiWindow(BackendGui *gui, GLFWwindow *window)
Informs the backend which window belongs to the gui.
Base class for the Gui.
Definition BackendGui.hpp:47
Base class for the backend.
Definition Backend.hpp:91
Type
List of available cursors.
Definition Cursor.hpp:51
Wrapper class to store strings.
Definition String.hpp:101
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
KeyModifier
Modifiers keys.
Definition Event.hpp:158