OpenTTD Source  20240919-master-gdf0233f4c2
null_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_NULL_H
11 #define VIDEO_NULL_H
12 
13 #include "video_driver.hpp"
14 
16 class VideoDriver_Null : public VideoDriver {
17 private:
18  uint ticks;
19 
20 public:
21  std::optional<std::string_view> Start(const StringList &param) override;
22 
23  void Stop() override;
24 
25  void MakeDirty(int left, int top, int width, int height) override;
26 
27  void MainLoop() override;
28 
29  bool ChangeResolution(int w, int h) override;
30 
31  bool ToggleFullscreen(bool fullscreen) override;
32  std::string_view GetName() const override { return "null"; }
33  bool HasGUI() const override { return false; }
34 };
35 
38 public:
39  FVideoDriver_Null() : DriverFactoryBase(Driver::DT_VIDEO, 0, "null", "Null Video Driver") {}
40  Driver *CreateInstance() const override { return new VideoDriver_Null(); }
41 };
42 
43 #endif /* VIDEO_NULL_H */
VideoDriver
The base of all video drivers.
Definition: video_driver.hpp:34
DriverFactoryBase::DriverFactoryBase
DriverFactoryBase(Driver::Type type, int priority, const char *name, const char *description)
Construct a new DriverFactory.
Definition: driver.cpp:244
VideoDriver_Null::ToggleFullscreen
bool ToggleFullscreen(bool fullscreen) override
Change the full screen setting.
Definition: null_v.cpp:68
VideoDriver_Null::ticks
uint ticks
Amount of ticks to run.
Definition: null_v.h:18
VideoDriver_Null::GetName
std::string_view GetName() const override
Get the name of this driver.
Definition: null_v.h:32
FVideoDriver_Null::CreateInstance
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: null_v.h:40
VideoDriver_Null::Start
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
Definition: null_v.cpp:22
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60
VideoDriver_Null::ChangeResolution
bool ChangeResolution(int w, int h) override
Change the resolution of the window.
Definition: null_v.cpp:66
video_driver.hpp
Driver::DT_VIDEO
@ DT_VIDEO
A video driver.
Definition: driver.h:42
VideoDriver_Null
The null video driver.
Definition: null_v.h:16
VideoDriver_Null::MakeDirty
void MakeDirty(int left, int top, int width, int height) override
Mark a particular area dirty.
Definition: null_v.cpp:47
FVideoDriver_Null
Factory the null video driver.
Definition: null_v.h:37
VideoDriver_Null::Stop
void Stop() override
Stop this driver.
Definition: null_v.cpp:45
Driver
A driver for communicating with the user.
Definition: driver.h:21
VideoDriver_Null::HasGUI
bool HasGUI() const override
Whether the driver has a graphical user interface with the end user.
Definition: null_v.h:33
VideoDriver_Null::MainLoop
void MainLoop() override
Perform the actual drawing.
Definition: null_v.cpp:49
DriverFactoryBase
Base for all driver factories.
Definition: driver.h:57