(svn r27950) -Merge: Documentation updates from 1.7 branch
[openttd.git] / src / sound / sound_driver.hpp
blob0df69b8b4518c8d80d3670d608bfd31823ed88cc
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
10 /** @file sound_driver.hpp Base for all sound drivers. */
12 #ifndef SOUND_SOUND_DRIVER_HPP
13 #define SOUND_SOUND_DRIVER_HPP
15 #include "../driver.h"
17 /** Base for all sound drivers. */
18 class SoundDriver : public Driver {
19 public:
20 /** Called once every tick */
21 virtual void MainLoop() {}
23 /**
24 * Get the currently active instance of the sound driver.
26 static SoundDriver *GetInstance() {
27 return static_cast<SoundDriver*>(*DriverFactoryBase::GetActiveDriver(Driver::DT_SOUND));
31 extern char *_ini_sounddriver;
33 #endif /* SOUND_SOUND_DRIVER_HPP */