OpenTTD Source  20241121-master-g67a0fccfad
allegro_s.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 SOUND_ALLEGRO_H
11 #define SOUND_ALLEGRO_H
12 
13 #include "sound_driver.hpp"
14 
17 public:
18  std::optional<std::string_view> Start(const StringList &param) override;
19 
20  void Stop() override;
21 
22  void MainLoop() override;
23  std::string_view GetName() const override { return "allegro"; }
24 };
25 
28 public:
29  FSoundDriver_Allegro() : DriverFactoryBase(Driver::DT_SOUND, 4, "allegro", "Allegro Sound Driver (param hz,samples)") {}
30  Driver *CreateInstance() const override { return new SoundDriver_Allegro(); }
31 };
32 
33 #endif /* SOUND_ALLEGRO_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_SOUND
A sound driver.
Definition: driver.h:41
Factory for the allegro sound driver.
Definition: allegro_s.h:27
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: allegro_s.h:30
Implementation of the allegro sound driver.
Definition: allegro_s.h:16
void Stop() override
Stop this driver.
void MainLoop() override
Called once every tick.
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
std::string_view GetName() const override
Get the name of this driver.
Definition: allegro_s.h:23
Base for all sound drivers.
Base for all sound drivers.
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60