OpenTTD Source: src/sound/null_s.h Source File

OpenTTD Source 14.0-RC3

null_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_NULL_H
11 #define SOUND_NULL_H
12
13 #include "sound_driver.hpp"
14
16 class SoundDriver_Null : public SoundDriver {
17 public:
18 const char *Start(const StringList &) override { return nullptr; }
19
20 void Stop() override { }
21 const char *GetName() const override { return "null"; }
22 bool HasOutput() const override { return false; }
23 };
24
26 class FSoundDriver_Null : public DriverFactoryBase {
27 public:
28 FSoundDriver_Null() : DriverFactoryBase(Driver::DT_SOUND, 1, "null", "Null Sound Driver") {}
29 Driver *CreateInstance() const override { return new SoundDriver_Null(); }
30 };
31
32 #endif /* SOUND_NULL_H */
SoundDriver_Null
Implementation of the null sound driver.
Definition: null_s.h:16
DriverFactoryBase::DriverFactoryBase
DriverFactoryBase(Driver::Type type, int priority, const char *name, const char *description)
Construct a new DriverFactory.
Definition: driver.cpp:251
FSoundDriver_Null
Factory for the null sound driver.
Definition: null_s.h:26
SoundDriver_Null::Start
const char * Start(const StringList &) override
Start this driver.
Definition: null_s.h:18
SoundDriver_Null::GetName
const char * GetName() const override
Get the name of this driver.
Definition: null_s.h:21
StringList
std::vector< std::string > StringList
Type for a list of strings.
Definition: string_type.h:60
FSoundDriver_Null::CreateInstance
Driver * CreateInstance() const override
Create an instance of this driver-class.
Definition: null_s.h:29
SoundDriver_Null::HasOutput
bool HasOutput() const override
Whether the driver has an output from which the user can hear sound.
Definition: null_s.h:22
sound_driver.hpp
Driver::DT_SOUND
@ DT_SOUND
A sound driver.
Definition: driver.h:41
SoundDriver
Base for all sound drivers.
Definition: sound_driver.hpp:16
Driver
A driver for communicating with the user.
Definition: driver.h:21
DriverFactoryBase
Base for all driver factories.
Definition: driver.h:57
SoundDriver_Null::Stop
void Stop() override
Stop this driver.
Definition: null_s.h:20