From 26440a92bb2da42919563ccd3e9feca715e2c2c3 Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Sun, 29 Dec 2024 08:03:49 +0000 Subject: [PATCH] Sync SDL3_mixer header -> wiki --- SDL3_mixer/Mix_RegisterEffect.md | 4 ---- SDL3_mixer/Mix_SetDistance.md | 4 ---- SDL3_mixer/Mix_SetPanning.md | 4 ---- SDL3_mixer/Mix_SetReverseStereo.md | 4 ---- SDL3_mixer/Mix_SetSoundFonts.md | 4 ---- SDL3_mixer/Mix_UnregisterAllEffects.md | 4 ---- SDL3_mixer/Mix_UnregisterEffect.md | 4 ---- 7 files changed, 28 deletions(-) diff --git a/SDL3_mixer/Mix_RegisterEffect.md b/SDL3_mixer/Mix_RegisterEffect.md index b73910c46..feccd99d0 100644 --- a/SDL3_mixer/Mix_RegisterEffect.md +++ b/SDL3_mixer/Mix_RegisterEffect.md @@ -77,10 +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. -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. - ## Version This function is available since SDL_mixer 3.0.0. diff --git a/SDL3_mixer/Mix_SetDistance.md b/SDL3_mixer/Mix_SetDistance.md index 4001f1219..f7730de39 100644 --- a/SDL3_mixer/Mix_SetDistance.md +++ b/SDL3_mixer/Mix_SetDistance.md @@ -48,10 +48,6 @@ mixed stream before passing it on to the audio device. This uses the [Mix_RegisterEffect](Mix_RegisterEffect)() API internally. -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. - ## Version This function is available since SDL_mixer 3.0.0. diff --git a/SDL3_mixer/Mix_SetPanning.md b/SDL3_mixer/Mix_SetPanning.md index 9bd9b0edd..3d7491a6a 100644 --- a/SDL3_mixer/Mix_SetPanning.md +++ b/SDL3_mixer/Mix_SetPanning.md @@ -53,10 +53,6 @@ Note that an audio device in mono mode is a no-op, but this call will return successful in that case. Error messages can be retrieved from [Mix_GetError](Mix_GetError)(). -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. - ## Version This function is available since SDL_mixer 3.0.0. diff --git a/SDL3_mixer/Mix_SetReverseStereo.md b/SDL3_mixer/Mix_SetReverseStereo.md index b36a2ff7e..ed937479e 100644 --- a/SDL3_mixer/Mix_SetReverseStereo.md +++ b/SDL3_mixer/Mix_SetReverseStereo.md @@ -44,10 +44,6 @@ If you specify [MIX_CHANNEL_POST](MIX_CHANNEL_POST) for `channel`, then this effect is used on the final mixed stream before sending it on to the audio device (a posteffect). -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. - ## Version This function is available since SDL_mixer 3.0.0. diff --git a/SDL3_mixer/Mix_SetSoundFonts.md b/SDL3_mixer/Mix_SetSoundFonts.md index 8fc489f87..a2bcf0690 100644 --- a/SDL3_mixer/Mix_SetSoundFonts.md +++ b/SDL3_mixer/Mix_SetSoundFonts.md @@ -33,10 +33,6 @@ This function replaces any previously-specified paths. Passing a NULL path will remove any previously-specified paths. -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. - ## Version This function is available since SDL_mixer 3.0.0. diff --git a/SDL3_mixer/Mix_UnregisterAllEffects.md b/SDL3_mixer/Mix_UnregisterAllEffects.md index 141111819..236d5568d 100644 --- a/SDL3_mixer/Mix_UnregisterAllEffects.md +++ b/SDL3_mixer/Mix_UnregisterAllEffects.md @@ -36,10 +36,6 @@ Posteffects are never implicitly unregistered as they are for channels, but they may be explicitly unregistered through this function by specifying [MIX_CHANNEL_POST](MIX_CHANNEL_POST) for a channel. -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. - ## Version This function is available since SDL_mixer 3.0.0. diff --git a/SDL3_mixer/Mix_UnregisterEffect.md b/SDL3_mixer/Mix_UnregisterEffect.md index 3419bfda8..27fd85453 100644 --- a/SDL3_mixer/Mix_UnregisterEffect.md +++ b/SDL3_mixer/Mix_UnregisterEffect.md @@ -35,10 +35,6 @@ the output stream does not have an end), but they may be explicitly unregistered through this function by specifying [MIX_CHANNEL_POST](MIX_CHANNEL_POST) for a channel. -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. - ## Version This function is available since SDL_mixer 3.0.0.