diff options
| author | Max Horn | 2007-03-02 15:22:38 +0000 |
|---|---|---|
| committer | Max Horn | 2007-03-02 15:22:38 +0000 |
| commit | d8cf10926b27c86e13755b0132fca4de6931f86c (patch) | |
| tree | 1030c96e7cd604daf1ca0ac0d307125f2a4a978c /sound | |
| parent | 8ab81824abad92269300a1647982dacb216bd68c (diff) | |
| download | scummvm-rg350-d8cf10926b27c86e13755b0132fca4de6931f86c.tar.gz scummvm-rg350-d8cf10926b27c86e13755b0132fca4de6931f86c.tar.bz2 scummvm-rg350-d8cf10926b27c86e13755b0132fca4de6931f86c.zip | |
Added a warning that the mixer FLAG_ enum should not be messed with, lest iMuseDigital saves will break
svn-id: r25925
Diffstat (limited to 'sound')
| -rw-r--r-- | sound/mixer.h | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/sound/mixer.h b/sound/mixer.h index 69f5aad1f3..ba6048a7d1 100644 --- a/sound/mixer.h +++ b/sound/mixer.h @@ -58,14 +58,26 @@ public: */ class Mixer { public: - enum { + /** + * Various flags which can be bit-ORed and then passed to + * Mixer::playRaw resp. makeLinearInputStream to control their + * behavior. + * + * Attention: The order/numbering of these *must not change*, as + * at least the SCUMM iMuse Digital code stores bitmasks made up + * from these flags in savegames. + * In general, though, doing so is a bad idea and engine authors + * are advised not to rely on a certain order of these flags + * (and hence not to store them verbatim in savestates. + */ + enum RawFlags { /** unsigned samples (default: signed) */ FLAG_UNSIGNED = 1 << 0, /** sound is 16 bits wide (default: 8bit) */ FLAG_16BITS = 1 << 1, - /** sample is little endian (default: big endian) */ + /** samples are little endian (default: big endian) */ FLAG_LITTLE_ENDIAN = 1 << 2, /** sound is in stereo (default: mono) */ |