OpenTTD Source  1.11.0-beta1
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 "video_driver.hpp"
14 
16 class VideoDriver_SDL : public VideoDriver {
17 public:
18  const char *Start(const StringList &param) override;
19 
20  void Stop() override;
21 
22  void MakeDirty(int left, int top, int width, int height) override;
23 
24  void MainLoop() override;
25 
26  bool ChangeResolution(int w, int h) override;
27 
28  bool ToggleFullscreen(bool fullscreen) override;
29 
30  bool AfterBlitterChange() override;
31 
32  void AcquireBlitterLock() override;
33 
34  void ReleaseBlitterLock() override;
35 
36  bool ClaimMousePointer() override;
37 
38  void EditBoxGainedFocus() override;
39 
40  void EditBoxLostFocus() override;
41 
42  const char *GetName() const override { return "sdl"; }
43 
44 protected:
45  Dimension GetScreenSize() const override;
46 
47 private:
48  int PollEvent();
49  void LoopOnce();
50  void MainLoopCleanup();
51  bool CreateMainSurface(uint w, uint h, bool resize);
52 
53 #ifdef __EMSCRIPTEN__
54  /* Convert a constant pointer back to a non-constant pointer to a member function. */
55  static void EmscriptenLoop(void *self) { ((VideoDriver_SDL *)self)->LoopOnce(); }
56 #endif
57 
62 
63  uint32 cur_ticks;
64  uint32 last_cur_ticks;
65  uint32 next_tick;
66 
67  int startup_display;
68  std::thread draw_thread;
69  std::unique_lock<std::recursive_mutex> draw_lock;
70 };
71 
74 public:
75  FVideoDriver_SDL() : DriverFactoryBase(Driver::DT_VIDEO, 5, "sdl", "SDL Video Driver") {}
76  Driver *CreateInstance() const override { return new VideoDriver_SDL(); }
77 };
78 
79 #endif /* VIDEO_SDL_H */
fullscreen
bool fullscreen
Whether to use (true) fullscreen mode.
Definition: win32_v.cpp:52
VideoDriver_SDL
The SDL video driver.
Definition: sdl2_v.h:16
VideoDriver_SDL::Start
const char * Start(const StringList &param) override
Start this driver.
Definition: sdl_v.cpp:601
VideoDriver
The base of all video drivers.
Definition: video_driver.hpp:24
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
VideoDriver_SDL::GetName
const char * GetName() const override
Get the name of this driver.
Definition: sdl2_v.h:42
DriverFactoryBase::DriverFactoryBase
DriverFactoryBase(Driver::Type type, int priority, const char *name, const char *description)
Construct a new DriverFactory.
Definition: driver.cpp:206
VideoDriver_SDL::ReleaseBlitterLock
void ReleaseBlitterLock() override
Release any lock(s) required to be held when changing blitters.
Definition: sdl_v.cpp:830
VideoDriver_SDL::ToggleFullscreen
bool ToggleFullscreen(bool fullscreen) override
Change the full screen setting.
Definition: sdl_v.cpp:803
VideoDriver_SDL::MainLoop
void MainLoop() override
Perform the actual drawing.
Definition: sdl_v.cpp:649
height
int height
Height in pixels of our display surface.
Definition: win32_v.cpp:49
VideoDriver_SDL::AcquireBlitterLock
void AcquireBlitterLock() override
Acquire any lock(s) required to be held when changing blitters.
Definition: sdl_v.cpp:825
VideoDriver_SDL::MakeDirty
void MakeDirty(int left, int top, int width, int height) override
Mark a particular area dirty.
Definition: sdl_v.cpp:53
VideoDriver_SDL::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:61
VideoDriver_SDL::EditBoxGainedFocus
void EditBoxGainedFocus() override
An edit box gained the input focus.
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:58
VideoDriver_SDL::ChangeResolution
bool ChangeResolution(int w, int h) override
Change the resolution of the window.
Definition: sdl_v.cpp:795
FVideoDriver_SDL
Factory for the SDL video driver.
Definition: sdl2_v.h:73
VideoDriver_SDL::AfterBlitterChange
bool AfterBlitterChange() override
Callback invoked after the blitter was changed.
Definition: sdl_v.cpp:820
video_driver.hpp
Driver::DT_VIDEO
@ DT_VIDEO
A video driver.
Definition: driver.h:44
width
int width
Width in pixels of our display surface.
Definition: win32_v.cpp:48
VideoDriver_SDL::EditBoxLostFocus
void EditBoxLostFocus() override
An edit box lost the input focus.
FVideoDriver_SDL::CreateInstance
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: sdl2_v.h:76
Driver
A driver for communicating with the user.
Definition: driver.h:23
VideoDriver_SDL::Stop
void Stop() override
Stop this driver.
Definition: sdl_v.cpp:641
DriverFactoryBase
Base for all driver factories.
Definition: driver.h:59