Skip to content

Commit

Permalink
Sync SDL3_mixer wiki -> header
Browse files Browse the repository at this point in the history
  • Loading branch information
SDLWikiBot committed Apr 11, 2024
1 parent 1d7ab02 commit e645f79
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions include/SDL3_mixer/SDL_mixer.h
Expand Up @@ -1115,29 +1115,29 @@ extern DECLSPEC void SDLCALL Mix_ChannelFinished(void (SDLCALL *channel_finished
/**
* This is the format of a special effect callback:
*
* myeffect(int chan, void *stream, int len, void *udata);
*
* (chan) is the channel number that your effect is affecting. (stream) is
* the buffer of data to work upon. (len) is the size of (stream), and
* (udata) is a user-defined bit of data, which you pass as the last arg of
* Mix_RegisterEffect(), and is passed back unmolested to your callback.
* Your effect changes the contents of (stream) based on whatever parameters
* are significant, or just leaves it be, if you prefer. You can do whatever
* you like to the buffer, though, and it will continue in its changed state
* down the mixing pipeline, through any other effect functions, then finally
* to be mixed with the rest of the channels and music for the final output
* stream.
* myeffect(int chan, void *stream, int len, void *udata);
*
* (chan) is the channel number that your effect is affecting. (stream) is the
* buffer of data to work upon. (len) is the size of (stream), and (udata) is
* a user-defined bit of data, which you pass as the last arg of
* Mix_RegisterEffect(), and is passed back unmolested to your callback. Your
* effect changes the contents of (stream) based on whatever parameters are
* significant, or just leaves it be, if you prefer. You can do whatever you
* like to the buffer, though, and it will continue in its changed state down
* the mixing pipeline, through any other effect functions, then finally to be
* mixed with the rest of the channels and music for the final output stream.
*
* DO NOT EVER call SDL_LockAudio() from your callback function!
*/
typedef void (SDLCALL *Mix_EffectFunc_t)(int chan, void *stream, int len, void *udata);

/**
* This is a callback that signifies that a channel has finished all its
* loops and has completed playback. This gets called if the buffer
* plays out normally, or if you call Mix_HaltChannel(), implicitly stop
* a channel via Mix_AllocateChannels(), or unregister a callback while
* it's still playing.
* This is a callback that signifies that a channel has finished all its loops
* and has completed playback.
*
* This gets called if the buffer plays out normally, or if you call
* Mix_HaltChannel(), implicitly stop a channel via Mix_AllocateChannels(), or
* unregister a callback while it's still playing.
*
* DO NOT EVER call SDL_LockAudio() from your callback function!
*/
Expand Down

0 comments on commit e645f79

Please sign in to comment.