TGUI  1.4.0
Loading...
Searching...
No Matches
BackendSFML.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#ifndef TGUI_BACKEND_SFML_HPP
26#define TGUI_BACKEND_SFML_HPP
27
28#include <TGUI/Config.hpp>
29#if !TGUI_BUILD_AS_CXX_MODULE
30 #include <TGUI/Backend/Window/Backend.hpp>
31#endif
32
33#include <TGUI/Backend/Window/SFML/BackendGuiSFML.hpp>
34
35#include <SFML/Window.hpp>
36
37#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
38 #include <unordered_map>
39 #include <map>
40#endif
41
43
44TGUI_IGNORE_DEPRECATED_WARNINGS_START // Required for VS2017 due to inheriting a function that we deprecated
45
46TGUI_MODULE_EXPORT namespace tgui
47{
48 class TGUI_API BackendSFML : public Backend
49 {
50 public:
51
60 void setGuiWindow(BackendGui* gui, sf::Window* window);
61
66 void detatchGui(BackendGui* gui) override;
67
76 void setMouseCursorStyle(Cursor::Type type, const std::uint8_t* pixels, Vector2u size, Vector2u hotspot) override;
77
84
91 void setMouseCursor(BackendGui* gui, Cursor::Type type) override;
92
93#ifndef TGUI_REMOVE_DEPRECATED_CODE
100 TGUI_DEPRECATED("Use BackendGui::startTextInput instead") void openVirtualKeyboard(const FloatRect& inputRect) override;
101
107 TGUI_DEPRECATED("Use BackendGui::stopTextInput instead") void closeVirtualKeyboard() override;
108#endif
109
117 TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
118
124 void setClipboard(const String& contents) override;
125
131 TGUI_NODISCARD String getClipboard() const override;
132
133#ifdef TGUI_SYSTEM_ANDROID
142 TGUI_NODISCARD std::unique_ptr<std::uint8_t[]> readFileFromAndroidAssets(const String& filename, std::size_t& fileSize) const override;
143#endif
144
156 static void cleanupLeakedCursors();
157
159 protected:
160
162 // Helper function to create a system cursor
164 TGUI_NODISCARD std::unique_ptr<sf::Cursor> createSystemCursor(Cursor::Type type);
165
167 // Helper function to update the mouse cursors on all attached guis
169 void updateMouseCursor(Cursor::Type type, std::unique_ptr<sf::Cursor> cursor);
170
172 // Helper function to update the mouse cursor on a window
174 void updateMouseCursor(sf::Window* window, Cursor::Type type);
175
177 protected:
178
179 struct GuiResources
180 {
181 sf::Window* window = nullptr;
182 Cursor::Type mouseCursor = Cursor::Type::Arrow;
183 };
184
185 std::unordered_map<BackendGui*, GuiResources> m_guiResources;
186 std::unordered_map<Cursor::Type, std::unique_ptr<sf::Cursor>> m_mouseCursors;
187
188 static std::vector<std::unique_ptr<sf::Cursor>> m_leakedCursors;
189 };
190
192}
193
194TGUI_IGNORE_DEPRECATED_WARNINGS_END
195
197
198#endif // TGUI_BACKEND_SFML_HPP
Base class for the Gui.
Definition BackendGui.hpp:47
Definition BackendSFML.hpp:49
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.
TGUI_NODISCARD String getClipboard() const override
Returns the contents of the clipboard.
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 setGuiWindow(BackendGui *gui, sf::Window *window)
Informs the backend which window belongs to the gui.
void resetMouseCursorStyle(Cursor::Type type) override
Changes the look of a certain mouse cursor back to the system theme.
void detatchGui(BackendGui *gui) override
Informs the backend that a gui object is being destroyed.
static void cleanupLeakedCursors()
Destroys any leaked cursors.
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.
Base class for the backend.
Definition Backend.hpp:87
Type
List of available cursors.
Definition Cursor.hpp:50
Wrapper class to store strings.
Definition String.hpp:96
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:38
KeyModifier
Modifiers keys.
Definition Event.hpp:157