Files
@ r19892:7529d3e7332a
Branch filter:
Location: cpp/openttd-patchpack/source/src/music/music_driver.hpp - annotation
r19892:7529d3e7332a
1.9 KiB
text/x-c++hdr
(svn r24847) -Cleanup (r24750): Remove unused strings.
r7170:38b143754b40 r7170:38b143754b40 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r12768:980ae0491352 r9111:983de9c5a848 r9111:983de9c5a848 r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r17629:21e9dfd343cd r7170:38b143754b40 r7170:38b143754b40 r17629:21e9dfd343cd r17629:21e9dfd343cd r17629:21e9dfd343cd r17629:21e9dfd343cd r7170:38b143754b40 r7170:38b143754b40 r17629:21e9dfd343cd r17629:21e9dfd343cd r17629:21e9dfd343cd r7170:38b143754b40 r7170:38b143754b40 r17629:21e9dfd343cd r17629:21e9dfd343cd r17629:21e9dfd343cd r17629:21e9dfd343cd r7170:38b143754b40 r7170:38b143754b40 r17629:21e9dfd343cd r17629:21e9dfd343cd r17629:21e9dfd343cd r17629:21e9dfd343cd r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r17629:21e9dfd343cd r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r17629:21e9dfd343cd r17629:21e9dfd343cd r17629:21e9dfd343cd r17629:21e9dfd343cd r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r7193:2cae66b95848 r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r7170:38b143754b40 r10615:151b5d3fccb0 r7170:38b143754b40 r7170:38b143754b40 | /* $Id$ */
/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file music_driver.hpp Base for all music playback. */
#ifndef MUSIC_MUSIC_DRIVER_HPP
#define MUSIC_MUSIC_DRIVER_HPP
#include "../driver.h"
/** Driver for all music playback. */
class MusicDriver: public Driver {
public:
/**
* Play a particular song.
* @param filename The name of file with the song to play.
*/
virtual void PlaySong(const char *filename) = 0;
/**
* Stop playing the current song.
*/
virtual void StopSong() = 0;
/**
* Are we currently playing a song?
* @return True if a song is being played.
*/
virtual bool IsSongPlaying() = 0;
/**
* Set the volume, if possible.
* @param vol The new volume.
*/
virtual void SetVolume(byte vol) = 0;
};
/** Base of the factory for the music drivers. */
class MusicDriverFactoryBase: public DriverFactoryBase {
};
/**
* Factory for the music drivers.
* @tparam T The type of the music factory to register.
*/
template <class T>
class MusicDriverFactory: public MusicDriverFactoryBase {
public:
MusicDriverFactory() { this->RegisterDriver(((T *)this)->GetName(), Driver::DT_MUSIC, ((T *)this)->priority); }
/**
* Get the long, human readable, name for the Driver-class.
*/
const char *GetName();
};
extern MusicDriver *_music_driver;
extern char *_ini_musicdriver;
#endif /* MUSIC_MUSIC_DRIVER_HPP */
|