TGUI  0.10-dev
BackendGLFW.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2021 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/Backend.hpp>
30#include <TGUI/Backend/Window/GLFW/BackendGuiGLFW.hpp>
31#include <unordered_map>
32#include <map>
33
35
36typedef struct GLFWwindow GLFWwindow;
37typedef struct GLFWcursor GLFWcursor;
38
40
41namespace tgui
42{
43 class TGUI_API BackendGLFW : public Backend
44 {
45 public:
46
51
52
61 void setGuiWindow(BackendGui* gui, GLFWwindow* window);
62
63
68 void attachGui(BackendGui* gui) override;
69
70
75 void detatchGui(BackendGui* gui) override;
76
77
86 void setMouseCursorStyle(Cursor::Type type, const std::uint8_t* pixels, Vector2u size, Vector2u hotspot) override;
87
88
95
96
103 void setMouseCursor(BackendGui* gui, Cursor::Type type) override;
104
105
114
115
121 void setClipboard(const String& contents) override;
122
123
129 String getClipboard() const override;
130
131
133 private:
134
136 // Helper function to create a system cursor
138 GLFWcursor* createSystemCursor(Cursor::Type type);
139
140
142 // Helper function to update the mouse cursors on all attached guis
144 void updateMouseCursorStyle(Cursor::Type type, GLFWcursor* cursor);
145
146
148 // Helper function to update the mouse cursor on a window
150 void updateShownMouseCursor(GLFWwindow* window, Cursor::Type type);
151
152
154 // Returns a window attached to any gui, for when a function needs access to some window
156 GLFWwindow* getAnyWindow() const;
157
158
160 private:
161
162 struct GuiResources
163 {
164 GLFWwindow* window = nullptr;
165 Cursor::Type mouseCursor = Cursor::Type::Arrow;
166 };
167
168 std::unordered_map<BackendGui*, GuiResources> m_guis;
169 std::map<Cursor::Type, GLFWcursor*> m_mouseCursors;
170 };
171
173}
174
176
177#endif // TGUI_BACKEND_GLFW_HPP
Definition: BackendGLFW.hpp:44
bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override
Checks the state for one of the modifier keys.
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.
void detatchGui(BackendGui *gui) override
Informs the backend that a gui object is being destroyed.
void resetMouseCursorStyle(Cursor::Type type) override
Changes the look of a certain mouse cursor back to the system theme.
~BackendGLFW()
Destructor.
void attachGui(BackendGui *gui) override
Informs the backend that a new gui object has been created.
void setGuiWindow(BackendGui *gui, GLFWwindow *window)
Informs the backend which window belongs to the gui.
Base class for the Gui.
Definition: BackendGui.hpp:45
Base class for the backend.
Definition: Backend.hpp:85
Type
List of available cursors.
Definition: Cursor.hpp:48
@ Arrow
Arrow cursor (default)
Wrapper class to store strings.
Definition: String.hpp:79
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
KeyModifier
Modifiers keys.
Definition: Event.hpp:156