OpenTTD Source  20240919-master-gdf0233f4c2
allegro_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_ALLEGRO_H
11 #define VIDEO_ALLEGRO_H
12 
13 #include "video_driver.hpp"
14 
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::vector<int> GetListOfMonitorRefreshRates() override;
35 
36  std::string_view GetName() const override { return "allegro"; }
37 
38 protected:
39  void InputLoop() override;
40  void Paint() override;
41  void CheckPaletteAnim() override;
42  bool PollEvent() override;
43 };
44 
47 public:
48  FVideoDriver_Allegro() : DriverFactoryBase(Driver::DT_VIDEO, 4, "allegro", "Allegro Video Driver") {}
49  Driver *CreateInstance() const override { return new VideoDriver_Allegro(); }
50 };
51 
52 #endif /* VIDEO_ALLEGRO_H */
VideoDriver
The base of all video drivers.
Definition: video_driver.hpp:34
FVideoDriver_Allegro
Factory for the allegro video driver.
Definition: allegro_v.h:46
DriverFactoryBase::DriverFactoryBase
DriverFactoryBase(Driver::Type type, int priority, const char *name, const char *description)
Construct a new DriverFactory.
Definition: driver.cpp:244
VideoDriver_Allegro::AfterBlitterChange
bool AfterBlitterChange() override
Callback invoked after the blitter was changed.
VideoDriver_Allegro::Start
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
VideoDriver_Allegro::Paint
void Paint() override
Paint the window.
VideoDriver_Allegro::ChangeResolution
bool ChangeResolution(int w, int h) override
Change the resolution of the window.
VideoDriver_Allegro::InputLoop
void InputLoop() override
Handle input logic, is CTRL pressed, should we fast-forward, etc.
VideoDriver_Allegro::GetListOfMonitorRefreshRates
std::vector< int > GetListOfMonitorRefreshRates() override
Get a list of refresh rates of each available monitor.
VideoDriver_Allegro::CheckPaletteAnim
void CheckPaletteAnim() override
Process any pending palette animation.
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60
VideoDriver_Allegro::MakeDirty
void MakeDirty(int left, int top, int width, int height) override
Mark a particular area dirty.
video_driver.hpp
Driver::DT_VIDEO
@ DT_VIDEO
A video driver.
Definition: driver.h:42
VideoDriver_Allegro::MainLoop
void MainLoop() override
Perform the actual drawing.
VideoDriver_Allegro::GetName
std::string_view GetName() const override
Get the name of this driver.
Definition: allegro_v.h:36
VideoDriver_Allegro
The allegro video driver.
Definition: allegro_v.h:16
VideoDriver_Allegro::ToggleFullscreen
bool ToggleFullscreen(bool fullscreen) override
Change the full screen setting.
VideoDriver_Allegro::Stop
void Stop() override
Stop this driver.
Driver
A driver for communicating with the user.
Definition: driver.h:21
VideoDriver_Allegro::PollEvent
bool PollEvent() override
Process a single system event.
DriverFactoryBase
Base for all driver factories.
Definition: driver.h:57
FVideoDriver_Allegro::CreateInstance
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: allegro_v.h:49