aboutsummaryrefslogtreecommitdiff
path: root/audio/mididrv.h
diff options
context:
space:
mode:
authormd52011-03-01 10:32:17 +0200
committermd52011-03-01 10:32:17 +0200
commit4a5b30e21f4c4158caf0e3e7b08cb379bb2cb8e7 (patch)
tree90a53d6925bce2f90bcfb61e4b2a6f356c2605a2 /audio/mididrv.h
parent22ebc2b724df5d8d717dec0d225e802d57514f79 (diff)
downloadscummvm-rg350-4a5b30e21f4c4158caf0e3e7b08cb379bb2cb8e7.tar.gz
scummvm-rg350-4a5b30e21f4c4158caf0e3e7b08cb379bb2cb8e7.tar.bz2
scummvm-rg350-4a5b30e21f4c4158caf0e3e7b08cb379bb2cb8e7.zip
MIDI: Updated documentation on MDT_PREFER_MT32 and MDT_PREFER_GM
Diffstat (limited to 'audio/mididrv.h')
-rw-r--r--audio/mididrv.h16
1 files changed, 13 insertions, 3 deletions
diff --git a/audio/mididrv.h b/audio/mididrv.h
index 9e649cba3d..6a8d174342 100644
--- a/audio/mididrv.h
+++ b/audio/mididrv.h
@@ -71,9 +71,19 @@ enum MusicType {
* A set of flags to be passed to detectDevice() which can be used to
* specify what kind of music driver is preferred / accepted.
*
- * The flags (except for MDT_PREFER_MT32 and MDT_PREFER_GM) indicate whether a given driver
- * type is acceptable. E.g. the TOWNS music driver could be returned by
- * detectDevice if and only if MDT_TOWNS is specified.
+ * The flags (except for MDT_PREFER_MT32 and MDT_PREFER_GM) indicate whether a
+ * given driver type is acceptable. E.g. the TOWNS music driver could be
+ * returned by detectDevice if and only if MDT_TOWNS is specified.
+ *
+ * MDT_PREFER_MT32 and MDT_PREFER_GM indicate the MIDI device type to use when
+ * no device is selected in the music options, or when the MIDI device selected
+ * does not match the requirements of a game engine. With these flags, more
+ * priority is given to an MT-32 device, or a GM device respectively.
+ *
+ * In desktop systems (where the MT-32 emulator is enabled), if no music driver
+ * is selected in the options, MDT_PREFER_MT32 results in ending up with the
+ * MT-32 emulator being chosen as the "optimal" music setting (unless, of course,
+ * a real MT-32 is present in the user's system).
*
* @todo Rename MidiDriverFlags to MusicDriverFlags
*/