OpenTTD Source  20240919-master-gdf0233f4c2
sdl_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_SDL_H
11 #define SOUND_SDL_H
12 
13 #include "sound_driver.hpp"
14 
16 class SoundDriver_SDL : public SoundDriver {
17 public:
18  std::optional<std::string_view> Start(const StringList &param) override;
19 
20  void Stop() override;
21  std::string_view GetName() const override { return "sdl"; }
22 };
23 
26 public:
27  FSoundDriver_SDL() : DriverFactoryBase(Driver::DT_SOUND, 5, "sdl", "SDL Sound Driver (param hz,samples)") {}
28  Driver *CreateInstance() const override { return new SoundDriver_SDL(); }
29 };
30 
31 #endif /* SOUND_SDL_H */
DriverFactoryBase::DriverFactoryBase
DriverFactoryBase(Driver::Type type, int priority, const char *name, const char *description)
Construct a new DriverFactory.
Definition: driver.cpp:244
SoundDriver_SDL::Start
std::optional< std::string_view > Start(const StringList &param) override
Start this driver.
Definition: sdl_s.cpp:33
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60
sound_driver.hpp
Driver::DT_SOUND
@ DT_SOUND
A sound driver.
Definition: driver.h:41
SoundDriver_SDL::GetName
std::string_view GetName() const override
Get the name of this driver.
Definition: sdl_s.h:21
SoundDriver
Base for all sound drivers.
Definition: sound_driver.hpp:16
FSoundDriver_SDL
Factory for the SDL sound driver.
Definition: sdl_s.h:25
FSoundDriver_SDL::CreateInstance
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: sdl_s.h:28
SoundDriver_SDL::Stop
void Stop() override
Stop this driver.
Definition: sdl_s.cpp:57
Driver
A driver for communicating with the user.
Definition: driver.h:21
SoundDriver_SDL
Implementation of the SDL sound driver.
Definition: sdl_s.h:16
DriverFactoryBase
Base for all driver factories.
Definition: driver.h:57