diff options
| author | Max Horn | 2003-09-18 16:01:33 +0000 |
|---|---|---|
| committer | Max Horn | 2003-09-18 16:01:33 +0000 |
| commit | 9470c9f66131d16ca19d111d21948ba57a1a8eb3 (patch) | |
| tree | 79aa7b664c9dcab922649ad552ef03fe6ba58e21 /sound/mixer.h | |
| parent | dcf77f7a1008e4a6b98c9face6cc7461c6347e1d (diff) | |
| download | scummvm-rg350-9470c9f66131d16ca19d111d21948ba57a1a8eb3.tar.gz scummvm-rg350-9470c9f66131d16ca19d111d21948ba57a1a8eb3.tar.bz2 scummvm-rg350-9470c9f66131d16ca19d111d21948ba57a1a8eb3.zip | |
changed & documented the premixer semantics
svn-id: r10294
Diffstat (limited to 'sound/mixer.h')
| -rw-r--r-- | sound/mixer.h | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/sound/mixer.h b/sound/mixer.h index 0e7e89bddf..6c9e9a4671 100644 --- a/sound/mixer.h +++ b/sound/mixer.h @@ -83,8 +83,14 @@ public: * to be generated */ bool bindToSystem(OSystem *syst); - /** Premix procedure, useful when using fmopl adlib */ - void setupPremix(void * param, PremixProc * proc); + /** + * Set the premix procedure. This is mainly used for the adlib music, but is not limited + * to it. The premix proc is invoked by the mixer whenever it needs to generate any + * data, before any other mixing takes place. The premixer than has a chanve to fill + * the mix buffer with data (usually music samples). It should generate the specified + * number of 16bit stereo samples (i.e. len * 4 bytes). + */ + void setupPremix(PremixProc *proc, void *param); // start playing a raw sound int playRaw(PlayingSoundHandle *handle, void *sound, uint32 size, uint rate, byte flags, |