diff options
Diffstat (limited to 'engines/sci/sfx/core.h')
| -rw-r--r-- | engines/sci/sfx/core.h | 31 |
1 files changed, 15 insertions, 16 deletions
diff --git a/engines/sci/sfx/core.h b/engines/sci/sfx/core.h index a65197a2e7..1f2f53a051 100644 --- a/engines/sci/sfx/core.h +++ b/engines/sci/sfx/core.h @@ -64,67 +64,66 @@ public: // FIXME, make private /* General */ /***********/ -void sfx_init(SfxState *self, ResourceManager *resmgr, int flags); /* Initializes the sound engine ** Parameters: (ResourceManager *) resmgr: Resource manager for initialization ** (int) flags: SFX_STATE_FLAG_* */ +void sfx_init(SfxState *self, ResourceManager *resmgr, int flags); +/** Deinitializes the sound subsystem. */ void sfx_exit(SfxState *self); -/* Deinitializes the sound subsystem -*/ -void sfx_suspend(SfxState *self, int suspend); /* Suspends/unsuspends the sound sybsystem ** Parameters: (int) suspend: Whether to suspend (non-null) or to unsuspend */ +void sfx_suspend(SfxState *self, int suspend); -int sfx_poll(SfxState *self, song_handle_t *handle, int *cue); /* Polls the sound server for cues etc. ** Returns : (int) 0 if the cue queue is empty, SI_LOOP, SI_CUE, or SI_FINISHED otherwise ** (song_handle_t) *handle: The affected handle ** (int) *cue: The sound cue number (if SI_CUE), or the loop number (if SI_LOOP) */ +int sfx_poll(SfxState *self, song_handle_t *handle, int *cue); -int sfx_poll_specific(SfxState *self, song_handle_t handle, int *cue); /* Polls the sound server for cues etc. ** Parameters: (song_handle_t) handle: The handle to poll ** Returns : (int) 0 if the cue queue is empty, SI_LOOP, SI_CUE, or SI_FINISHED otherwise ** (int) *cue: The sound cue number (if SI_CUE), or the loop number (if SI_LOOP) */ +int sfx_poll_specific(SfxState *self, song_handle_t handle, int *cue); -int sfx_get_volume(SfxState *self); /* Determines the current global volume settings ** Returns : (int) The global volume, between 0 (silent) and 127 (max. volume) */ +int sfx_get_volume(SfxState *self); -void sfx_set_volume(SfxState *self, int volume); /* Determines the current global volume settings ** Parameters: (int) volume: The new global volume, between 0 and 127 (see above) */ +void sfx_set_volume(SfxState *self, int volume); -void sfx_all_stop(SfxState *self); /* Stops all songs currently playing, purges song library */ +void sfx_all_stop(SfxState *self); /*****************/ /* Song basics */ /*****************/ -int sfx_add_song(SfxState *self, SongIterator *it, int priority, song_handle_t handle, int resnum); /* Adds a song to the internal sound library ** Parameters: (SongIterator *) it: The iterator describing the song ** (int) priority: Initial song priority (higher <-> more important) ** (song_handle_t) handle: The handle to associate with the song ** Returns : (int) 0 on success, nonzero on error */ +int sfx_add_song(SfxState *self, SongIterator *it, int priority, song_handle_t handle, int resnum); -void sfx_remove_song(SfxState *self, song_handle_t handle); /* Deletes a song and its associated song iterator from the song queue ** Parameters: (song_handle_t) handle: The song to remove */ +void sfx_remove_song(SfxState *self, song_handle_t handle); /**********************/ @@ -132,37 +131,37 @@ void sfx_remove_song(SfxState *self, song_handle_t handle); /**********************/ -void sfx_song_set_status(SfxState *self, song_handle_t handle, int status); /* Sets the song status, i.e. whether it is playing, suspended, or stopped. ** Parameters: (song_handle_t) handle: Handle of the song to modify ** (int) status: The song status the song should assume ** WAITING and PLAYING are set implicitly and essentially describe the same state ** as far as this function is concerned. */ +void sfx_song_set_status(SfxState *self, song_handle_t handle, int status); -void sfx_song_renice(SfxState *self, song_handle_t handle, int priority); /* Sets the new song priority ** Parameters: (song_handle_t) handle: The handle to modify ** (int) priority: The priority to set */ +void sfx_song_renice(SfxState *self, song_handle_t handle, int priority); -void sfx_song_set_loops(SfxState *self, song_handle_t handle, int loops); /* Sets the number of loops for the specified song ** Parameters: (song_handle_t) handle: The song handle to reference ** (int) loops: Number of loops to set */ +void sfx_song_set_loops(SfxState *self, song_handle_t handle, int loops); -void sfx_song_set_hold(SfxState *self, song_handle_t handle, int hold); /* Sets the number of loops for the specified song ** Parameters: (song_handle_t) handle: The song handle to reference ** (int) hold: Number of loops to setn */ +void sfx_song_set_hold(SfxState *self, song_handle_t handle, int hold); -void sfx_song_set_fade(SfxState *self, song_handle_t handle, fade_params_t *fade_setup); /* Instructs a song to be faded out ** Parameters: (song_handle_t) handle: The song handle to reference ** (fade_params_t *) fade_setup: The precise fade-out configuration to use */ +void sfx_song_set_fade(SfxState *self, song_handle_t handle, fade_params_t *fade_setup); // Previously undocumented: |