TGUI  1.1
Loading...
Searching...
No Matches
BackendGuiSDL.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2023 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_GUI_SDL_HPP
27#define TGUI_BACKEND_GUI_SDL_HPP
28
29#include <TGUI/extlibs/IncludeSDL.hpp>
30#if SDL_MAJOR_VERSION < 3
31 #include <SDL_touch.h>
32#endif
33
34#include <TGUI/Config.hpp>
35#if TGUI_BUILD_AS_CXX_MODULE
36 import tgui;
37#else
38 #include <TGUI/Backend/Window/BackendGui.hpp>
39#endif
40
42
43TGUI_MODULE_EXPORT namespace tgui
44{
46
47 class TGUI_API BackendGuiSDL : public BackendGui
48 {
49 public:
50
56 BackendGuiSDL() = default;
57
58
75 bool handleEvent(const SDL_Event& event);
76 using BackendGui::handleEvent;
77
78
106 void mainLoop(Color clearColor = {240, 240, 240}) override;
107
108
117 TGUI_NODISCARD bool convertEvent(const SDL_Event& eventSDL, Event& eventTGUI);
118
119
125 SDL_Window* getWindow() const;
126
127
134 void startTextInput(FloatRect inputRect) override;
135
136
141 void stopTextInput() override;
142
143
151 void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos) override;
152
153
155 protected:
156
162 void setGuiWindow(SDL_Window* window);
163
164
166 // Updates the view and changes the size of the root container when needed
168 void updateContainerSize() override;
169
170
172 protected:
173
177 virtual void presentScreen() = 0;
178
179#if ((SDL_MAJOR_VERSION == 2) && (SDL_MINOR_VERSION < 26))
183 virtual void updateFramebufferSize() = 0;
184#endif
185
187 protected:
188
189 SDL_Window* m_window = nullptr;
190 float m_dpiScale = 1;
191
192 bool m_textInputStarted = false;
193 SDL_Rect m_textInputRect = {};
194
195 bool m_touchFirstFingerDown = false;
196 SDL_FingerID m_touchFirstFingerId = 0; // Only valid if m_touchFirstFingerDown is true
197 SDL_TouchID m_touchFirstFingerTouchId = 0; // Only valid if m_touchFirstFingerDown is true
198
200 };
201}
202
204
205#endif // TGUI_BACKEND_GUI_SDL_HPP
Definition BackendGuiSDL.hpp:48
void startTextInput(FloatRect inputRect) override
This function is called by TGUI when focusing a text field (EditBox or TextArea). It may result in th...
TGUI_NODISCARD bool convertEvent(const SDL_Event &eventSDL, Event &eventTGUI)
Helper function that converts an SDL event to a TGUI event.
void mainLoop(Color clearColor={240, 240, 240}) override
Give the gui control over the main loop.
BackendGuiSDL()=default
Default constructor.
SDL_Window * getWindow() const
Returns the window that was provided to the gui.
void setGuiWindow(SDL_Window *window)
Sets the window on which the gui should be drawn.
void stopTextInput() override
This function is called by TGUI when unfocusing a text field (EditBox or TextArea)....
bool handleEvent(const SDL_Event &event)
Passes the event to the widgets.
virtual void presentScreen()=0
Shows the drawn content with SDL_GL_SwapWindow or SDL_RenderPresent, depending on the renderer.
void updateTextCursorPosition(FloatRect inputRect, Vector2f caretPos) override
This function is called by TGUI when the position of the caret changes in a text field (EditBox or Te...
Base class for the Gui.
Definition BackendGui.hpp:48
Wrapper for colors.
Definition Color.hpp:72
Namespace that contains all TGUI functions and classes.
Definition AbsoluteOrRelativeValue.hpp:39
Definition Event.hpp:39