OpenTTD Source  20241121-master-g67a0fccfad
sdl_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  std::optional<std::string_view> 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  bool ClaimMousePointer() override;
33 
34  std::string_view GetName() const override { return "sdl"; }
35 
36 protected:
37  void InputLoop() override;
38  void Paint() override;
39  void CheckPaletteAnim() override;
40  bool PollEvent() override;
41 
42 private:
43  bool CreateMainSurface(uint w, uint h);
44  void SetupKeyboard();
45 };
46 
49 public:
50  FVideoDriver_SDL() : DriverFactoryBase(Driver::DT_VIDEO, 5, "sdl", "SDL Video Driver") {}
51  Driver *CreateInstance() const override { return new VideoDriver_SDL(); }
52 };
53 
54 #endif /* VIDEO_SDL_H */
Base for all driver factories.
Definition: driver.h:57
DriverFactoryBase(Driver::Type type, int priority, const char *name, const char *description)
Construct a new DriverFactory.
Definition: driver.cpp:244
A driver for communicating with the user.
Definition: driver.h:21
@ DT_VIDEO
A video driver.
Definition: driver.h:42
Factory for the SDL video driver.
Definition: sdl_v.h:48
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: sdl_v.h:51
The SDL video driver.
Definition: sdl_v.h:16
void MainLoop() override
Perform the actual drawing.
Definition: sdl_v.cpp:658
void CheckPaletteAnim() override
Process any pending palette animation.
Definition: sdl_v.cpp:113
void Paint() override
Paint the window.
Definition: sdl_v.cpp:136
void Stop() override
Stop this driver.
Definition: sdl_v.cpp:625
bool AfterBlitterChange() override
Callback invoked after the blitter was changed.
Definition: sdl_v.cpp:692
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
Definition: sdl_v.cpp:585
bool ChangeResolution(int w, int h) override
Change the resolution of the window.
Definition: sdl_v.cpp:672
void InputLoop() override
Handle input logic, is CTRL pressed, should we fast-forward, etc.
Definition: sdl_v.cpp:633
bool PollEvent() override
Process a single system event.
Definition: sdl_v.cpp:477
void MakeDirty(int left, int top, int width, int height) override
Mark a particular area dirty.
Definition: sdl_v.cpp:43
bool ToggleFullscreen(bool fullscreen) override
Change the full screen setting.
Definition: sdl_v.cpp:677
std::string_view GetName() const override
Get the name of this driver.
Definition: sdl_v.h:34
The base of all video drivers.
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60
Base of all video drivers.