OpenTTD Source: SoundDriver Class Reference

OpenTTD Source 13.2.1

Public Member Functions | Static Public Member Functions
SoundDriver Class Reference

Base for all sound drivers. More...

`#include <sound_driver.hpp>`

Inheritance diagram for SoundDriver:

## Public Member Functions
virtual void | MainLoop ()
| Called once every tick.
virtual bool | HasOutput () const
| Whether the driver has an output from which the user can hear sound. More...
Public Member Functions inherited from Driver
virtual const char * | Start (const StringList &parm)=0
| Start this driver. More...
virtual void | Stop ()=0
| Stop this driver.
virtual const char * | GetName () const =0
| Get the name of this driver. More...

## Static Public Member Functions
static SoundDriver * | GetInstance ()
| Get the currently active instance of the sound driver.

## Additional Inherited Members
Public Types inherited from Driver
enum | Type { DT_BEGIN = 0, DT_MUSIC = 0, DT_SOUND, DT_VIDEO, DT_END }
| The type of driver. More...

## Detailed Description

Base for all sound drivers.

Definition at line 16 of file sound_driver.hpp.

## Member Function Documentation

## ◆ HasOutput()

virtual bool SoundDriver::HasOutput | ( |  | ) | const
| inlinevirtual

Whether the driver has an output from which the user can hear sound.

Or in other words, whether we should warn the user if no soundset is loaded and that loading one would fix the sound problems.

Returns
  True for all drivers except null.

Reimplemented in SoundDriver_Null.

Definition at line 27 of file sound_driver.hpp.

The documentation for this class was generated from the following file:

- src/sound/sound_driver.hpp