TGUI  1.2.0
Loading...
Searching...
No Matches
BackendSDL.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_SDL_HPP
27#define TGUI_BACKEND_SDL_HPP
28
29#include <TGUI/extlibs/IncludeSDL.hpp>
30#include <TGUI/Backend/Window/SDL/BackendGuiSDL.hpp>
31
32#if !TGUI_BUILD_AS_CXX_MODULE
33 #include <TGUI/Backend/Window/Backend.hpp>
34#endif
35
36#if !TGUI_EXPERIMENTAL_USE_STD_MODULE
37 #include <unordered_map>
38 #include <map>
39#endif
40
42
43TGUI_IGNORE_DEPRECATED_WARNINGS_START // Required for VS2017 due to inheriting a function that we deprecated
44
45TGUI_MODULE_EXPORT namespace tgui
46{
47 class TGUI_API BackendSDL : public Backend
48 {
49 public:
50
54 ~BackendSDL() override;
55
56
65 void setGuiWindow(BackendGui* gui, SDL_Window* window);
66
67
72 void detatchGui(BackendGui* gui) override;
73
74
83 void setMouseCursorStyle(Cursor::Type type, const std::uint8_t* pixels, Vector2u size, Vector2u hotspot) override;
84
85
92
93
100 void setMouseCursor(BackendGui* gui, Cursor::Type type) override;
101
102#ifndef TGUI_REMOVE_DEPRECATED_CODE
109 TGUI_DEPRECATED("Use BackendGui::startTextInput instead") void openVirtualKeyboard(const FloatRect& inputRect) override;
110
111
117 TGUI_DEPRECATED("Use BackendGui::stopTextInput instead") void closeVirtualKeyboard() override;
118#endif
119
127 TGUI_NODISCARD bool isKeyboardModifierPressed(Event::KeyModifier modifierKey) override;
128
129
135 void setClipboard(const String& contents) override;
136
137
143 TGUI_NODISCARD String getClipboard() const override;
144
145#ifdef TGUI_SYSTEM_ANDROID
154 TGUI_NODISCARD std::unique_ptr<std::uint8_t[]> readFileFromAndroidAssets(const String& filename, std::size_t& fileSize) const override;
155#endif
156
158 private:
159
161 // Helper function to create a system cursor
163 TGUI_NODISCARD SDL_Cursor* createSystemCursor(Cursor::Type type);
164
165
167 // Helper function to update the mouse cursors on all attached guis
169 void updateMouseCursorStyle(Cursor::Type type, SDL_Cursor* cursor);
170
171
173 // Helper function to update the mouse cursor on a window
175 void updateShownMouseCursor(SDL_Window* window, Cursor::Type type);
176
177
179 private:
180
181 struct GuiResources
182 {
183 SDL_Window* window = nullptr;
184 Cursor::Type mouseCursor = Cursor::Type::Arrow;
185 };
186
187 std::unordered_map<BackendGui*, GuiResources> m_guiResources;
188 std::unordered_map<Cursor::Type, SDL_Cursor*> m_mouseCursors;
189 };
190
192}
193
194TGUI_IGNORE_DEPRECATED_WARNINGS_END
195
197
198#endif // TGUI_BACKEND_SDL_HPP
Base class for the Gui.
Definition BackendGui.hpp:48
Definition BackendSDL.hpp:48
void resetMouseCursorStyle(Cursor::Type type) override
Changes the look of a certain mouse cursor back to the system theme.
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.
void setClipboard(const String &contents) override
Changes 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.
TGUI_NODISCARD String getClipboard() const override
Returns the contents of the clipboard.
~BackendSDL() override
Destructor.
void setGuiWindow(BackendGui *gui, SDL_Window *window)
Informs the backend which window belongs to the gui.
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