Skip to content

Commit

Permalink
Sync SDL3_mixer header -> wiki
Browse files Browse the repository at this point in the history
  • Loading branch information
SDLWikiBot committed Dec 27, 2024
1 parent 493e6ec commit 76f753e
Show file tree
Hide file tree
Showing 8 changed files with 3 additions and 18 deletions.
4 changes: 0 additions & 4 deletions SDL3_mixer/Mix_ChannelFinished.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,6 @@ called as a result of [Mix_HaltChannel](Mix_HaltChannel)(), etc.
The callback has a single parameter, `channel`, which says what mixer
channel has just stopped.
Do not call SDL_LockAudio() from this callback; you will either be inside
the audio callback, or SDL_mixer will explicitly lock the audio before
calling your callback.
A NULL pointer will disable the callback.
## Version
Expand Down
2 changes: 0 additions & 2 deletions SDL3_mixer/Mix_EffectDone_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ This gets called if the buffer plays out normally, or if you call
[Mix_AllocateChannels](Mix_AllocateChannels)(), or unregister a callback
while it's still playing.
DO NOT EVER call SDL_LockAudio() from your callback function!
----
[CategoryAPI](CategoryAPI), [CategoryAPIDatatype](CategoryAPIDatatype), [CategorySDLMixer](CategorySDLMixer)
2 changes: 0 additions & 2 deletions SDL3_mixer/Mix_EffectFunc_t.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ 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!
----
[CategoryAPI](CategoryAPI), [CategoryAPIDatatype](CategoryAPIDatatype), [CategorySDLMixer](CategorySDLMixer)
2 changes: 1 addition & 1 deletion SDL3_mixer/Mix_GetSoundFonts.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ function:
- If the boolean _SDL hint_ `"SDL_FORCE_SOUNDFONTS"` is set, AND the
`"SDL_SOUNDFONTS"` _environment variable_ is also set, this function will
return that environment variable regardless of whether
[Mix_SetSoundFounts](Mix_SetSoundFounts)() was ever called.
[Mix_SetSoundFonts](Mix_SetSoundFonts)() was ever called.
- Otherwise, if [Mix_SetSoundFonts](Mix_SetSoundFonts)() was successfully
called with a non-NULL path, this function will return the string passed
to that function.
Expand Down
4 changes: 0 additions & 4 deletions SDL3_mixer/Mix_HookMusicFinished.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,6 @@ It is legal to start a new music object playing in this callback (or
restart the one that just stopped). If the music finished normally, this
can be used to loop the music without a gap in the audio playback.
Do not call SDL_LockAudio() from this callback; you will either be inside
the audio callback, or SDL_mixer will explicitly lock the audio before
calling your callback.
A NULL pointer will disable the callback.
## Version
Expand Down
2 changes: 1 addition & 1 deletion SDL3_mixer/Mix_MasterVolume.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ this function returns the previous (in this case, still-current) value.
Note that the master volume does not affect any playing music; it is only
applied when mixing chunks. Use [Mix_VolumeMusic](Mix_VolumeMusic)() for
that.\
that.
## Version
Expand Down
2 changes: 1 addition & 1 deletion SDL3_mixer/Mix_QuerySpec.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ bool Mix_QuerySpec(int *frequency, SDL_AudioFormat *format, int *channels);
## Return Value
(bool) Returns true if the audio device has been opened, true otherwise.
(bool) Returns true if the audio device has been opened, false otherwise.
## Remarks
Expand Down
3 changes: 0 additions & 3 deletions SDL3_mixer/Mix_RegisterEffect.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,6 @@ After all these effects have finished processing, the callback registered
through [Mix_SetPostMix](Mix_SetPostMix)() runs, and then the stream goes
to the audio device.
DO NOT EVER call SDL_LockAudio() from your callback function! You are
already running in the audio thread and the lock is already held!
Note that unlike most SDL and SDL_mixer functions, this function returns
zero if there's an error, not on success. We apologize for the API design
inconsistency here.
Expand Down

0 comments on commit 76f753e

Please sign in to comment.