OpenTTD Source: src/video/sdl2_v.h Source File

OpenTTD Source 1.11.0-RC1

sdl2_v.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef VIDEO_SDL_H
11 #define VIDEO_SDL_H
12
13 #include <condition_variable>
14
15 #include "video_driver.hpp"
16
18 class VideoDriver_SDL_Base : public VideoDriver {
19 public:
20 VideoDriver_SDL_Base() : sdl_window(nullptr) {}
21
22 const char *Start(const StringList &param) override;
23
24 void Stop() override;
25
26 void MakeDirty(int left, int top, int width, int height) override;
27
28 void MainLoop() override;
29
30 bool ChangeResolution(int w, int h) override;
31
32 bool ToggleFullscreen(bool fullscreen) override;
33
34 bool AfterBlitterChange() override;
35
36 bool ClaimMousePointer() override;
37
38 void EditBoxGainedFocus() override;
39
40 void EditBoxLostFocus() override;
41
42 std::vector<int> GetListOfMonitorRefreshRates() override;
43
44 const char *GetName() const override { return "sdl"; }
45
46 protected:
47 struct SDL_Window *sdl_window;
48 Palette local_palette;
49 bool buffer_locked;
50 Rect dirty_rect;
51
52 Dimension GetScreenSize() const override;
53 void InputLoop() override;
54 bool LockVideoBuffer() override;
55 void UnlockVideoBuffer() override;
56 void CheckPaletteAnim() override;
57 bool PollEvent() override;
58
60 void ClientSizeChanged(int w, int h, bool force);
61
63 virtual bool AllocateBackingStore(int w, int h, bool force = false) = 0;
65 virtual void *GetVideoPointer() = 0;
67 virtual void ReleaseVideoPointer() = 0;
69 virtual bool CreateMainWindow(uint w, uint h, uint flags = 0);
70
71 private:
72 void LoopOnce();
73 void MainLoopCleanup();
74 bool CreateMainSurface(uint w, uint h, bool resize);
75 const char *Initialize();
76
77 #ifdef __EMSCRIPTEN__
78 /* Convert a constant pointer back to a non-constant pointer to a member function. */
79 static void EmscriptenLoop(void *self) { ((VideoDriver_SDL_Base *)self)->LoopOnce(); }
80 #endif
81
85 bool edit_box_focused;
86
87 int startup_display;
88 };
89
90 #endif /* VIDEO_SDL_H */
VideoDriver_SDL_Base::UnlockVideoBuffer
void UnlockVideoBuffer() override
Unlock a previously locked video buffer.
Definition: sdl2_v.cpp:730
VideoDriver
The base of all video drivers.
Definition: video_driver.hpp:33
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
VideoDriver_SDL_Base::ReleaseVideoPointer
virtual void ReleaseVideoPointer()=0
Hand video buffer back to the painting backend.
VideoDriver_SDL_Base::MakeDirty
void MakeDirty(int left, int top, int width, int height) override
Mark a particular area dirty.
Definition: sdl2_v.cpp:38
VideoDriver_SDL_Base::GetListOfMonitorRefreshRates
std::vector< int > GetListOfMonitorRefreshRates() override
Get a list of refresh rates of each available monitor.
Definition: sdl2_v.cpp:240
VideoDriver_SDL_Base::LockVideoBuffer
bool LockVideoBuffer() override
Make sure the video buffer is ready for drawing.
Definition: sdl2_v.cpp:719
VideoDriver_SDL_Base::EditBoxGainedFocus
void EditBoxGainedFocus() override
This is called to indicate that an edit box has gained focus, text input mode should be enabled.
Definition: sdl2_v.cpp:221
VideoDriver_SDL_Base::AllocateBackingStore
virtual bool AllocateBackingStore(int w, int h, bool force=false)=0
(Re-)create the backing store.
VideoDriver_SDL_Base::MainLoop
void MainLoop() override
Perform the actual drawing.
Definition: sdl2_v.cpp:651
VideoDriver_SDL_Base::GetName
const char * GetName() const override
Get the name of this driver.
Definition: sdl2_v.h:44
VideoDriver_SDL_Base::Stop
void Stop() override
Stop this driver.
Definition: sdl2_v.cpp:585
VideoDriver_SDL_Base::InputLoop
void InputLoop() override
Handle input logic, is CTRL pressed, should we fast-forward, etc.
Definition: sdl2_v.cpp:593
VideoDriver_SDL_Base::AfterBlitterChange
bool AfterBlitterChange() override
Callback invoked after the blitter was changed.
Definition: sdl2_v.cpp:703
VideoDriver_SDL_Base::local_palette
Palette local_palette
Copy of _cur_palette.
Definition: sdl2_v.h:48
VideoDriver_SDL_Base::PollEvent
bool PollEvent() override
Process a single system event.
Definition: sdl2_v.cpp:377
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:58
VideoDriver_SDL_Base::ToggleFullscreen
bool ToggleFullscreen(bool fullscreen) override
Change the full screen setting.
Definition: sdl2_v.cpp:672
VideoDriver_SDL_Base::CheckPaletteAnim
void CheckPaletteAnim() override
Process any pending palette animation.
Definition: sdl2_v.cpp:44
VideoDriver_SDL_Base::CreateMainWindow
virtual bool CreateMainWindow(uint w, uint h, uint flags=0)
Create the main window.
Definition: sdl2_v.cpp:145
VideoDriver_SDL_Base::ClientSizeChanged
void ClientSizeChanged(int w, int h, bool force)
Indicate to the driver the client-side might have changed.
Definition: sdl2_v.cpp:130
VideoDriver_SDL_Base::EditBoxLostFocus
void EditBoxLostFocus() override
This is called to indicate that an edit box has lost focus, text input mode should be disabled.
Definition: sdl2_v.cpp:232
video_driver.hpp
VideoDriver_SDL_Base::dirty_rect
Rect dirty_rect
Rectangle encompassing the dirty area of the video buffer.
Definition: sdl2_v.h:50
VideoDriver_SDL_Base
The SDL video driver.
Definition: sdl2_v.h:18
VideoDriver_SDL_Base::edit_box_focused
bool edit_box_focused
This is true to indicate that keyboard input is in text input mode, and SDL_TEXTINPUT events are enab...
Definition: sdl2_v.h:85
VideoDriver_SDL_Base::buffer_locked
bool buffer_locked
Video buffer was locked by the main thread.
Definition: sdl2_v.h:49
VideoDriver_SDL_Base::ChangeResolution
bool ChangeResolution(int w, int h) override
Change the resolution of the window.
Definition: sdl2_v.cpp:667
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
Palette
Information about the currently used palette.
Definition: gfx_type.h:313
VideoDriver_SDL_Base::GetScreenSize
Dimension GetScreenSize() const override
Get the resolution of the main screen.
Definition: sdl2_v.cpp:711
VideoDriver_SDL_Base::sdl_window
struct SDL_Window * sdl_window
Main SDL window.
Definition: sdl2_v.h:47
VideoDriver_SDL_Base::GetVideoPointer
virtual void * GetVideoPointer()=0
Get a pointer to the video buffer.
VideoDriver_SDL_Base::Start
const char * Start(const StringList &param) override
Start this driver.
Definition: sdl2_v.cpp:555