From e3eb3cfd1098c9095b48373a93f0fbef8dc4df02 Mon Sep 17 00:00:00 2001 From: Ozkan Sezer Date: Sun, 22 Oct 2023 11:50:00 +0300 Subject: [PATCH] SDL_mixer.h: typo fixes and sysnc with SDL3 version --- include/SDL_mixer.h | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/include/SDL_mixer.h b/include/SDL_mixer.h index 3cc57d8da..6f3417fe4 100644 --- a/include/SDL_mixer.h +++ b/include/SDL_mixer.h @@ -294,7 +294,7 @@ typedef struct _Mix_Music Mix_Music; * it to the correct format on demand. * * That being said, if you have control of your audio data and you know its - * format ahead of time, you can save CPU time by opening the audio device in + * format ahead of time, you may save CPU time by opening the audio device in * that exact format so SDL_mixer does not have to spend time converting * anything behind the scenes, and can just pass the data straight through to * the hardware. On some platforms, where the hardware only supports specific @@ -1401,7 +1401,8 @@ extern DECLSPEC int SDLCALL Mix_UnregisterEffect(int channel, Mix_EffectFunc_t f * zero if there's an error, not on success. We apologize for the API design * inconsistency here. * - * \param channel the channel to unregister all effects on, or MIX_CHANNEL_POST. + * \param channel the channel to unregister all effects on, or + * MIX_CHANNEL_POST. * \returns zero if error (no such channel), nonzero if all effects removed. * Error messages can be retrieved from Mix_GetError(). * @@ -1473,7 +1474,7 @@ extern DECLSPEC int SDLCALL Mix_SetPanning(int channel, Uint8 left, Uint8 right) * Set the position of a channel. * * `angle` is an integer from 0 to 360, that specifies the location of the - * sound in relation to the listener. `angle` will be reduced as neccesary + * sound in relation to the listener. `angle` will be reduced as necessary * (540 becomes 180 degrees, -100 becomes 260). Angle 0 is due north, and * rotates clockwise as the value increases. For efficiency, the precision of * this effect may be limited (angles 1 through 7 might all produce the same @@ -1760,7 +1761,7 @@ extern DECLSPEC int SDLCALL Mix_GroupNewer(int tag); * \param channel the channel on which to play the new chunk. * \param chunk the new chunk to play. * \param loops the number of times the chunk should loop, -1 to loop (not - * actually) infinitely. + * actually) infinitely. * \returns which channel was used to play the sound, or -1 if sound could not * be played. * @@ -1792,7 +1793,7 @@ extern DECLSPEC int SDLCALL Mix_PlayChannel(int channel, Mix_Chunk *chunk, int l * \param channel the channel on which to play the new chunk. * \param chunk the new chunk to play. * \param loops the number of times the chunk should loop, -1 to loop (not - * actually) infinitely. + * actually) infinitely. * \param ticks the maximum number of milliseconds of this chunk to mix for * playback. * \returns which channel was used to play the sound, or -1 if sound could not @@ -1844,7 +1845,7 @@ extern DECLSPEC int SDLCALL Mix_PlayMusic(Mix_Music *music, int loops); * * \param music the new music object to play. * \param loops the number of times the chunk should loop, -1 to loop (not - * actually) infinitely. + * actually) infinitely. * \param ms the number of milliseconds to spend fading in. * \returns zero on success, -1 on error. * @@ -1881,7 +1882,7 @@ extern DECLSPEC int SDLCALL Mix_FadeInMusic(Mix_Music *music, int loops, int ms) * * \param music the new music object to play. * \param loops the number of times the chunk should loop, -1 to loop (not - * actually) infinitely. + * actually) infinitely. * \param ms the number of milliseconds to spend fading in. * \param position the start position within the music, in seconds, where * playback should start. @@ -1922,7 +1923,7 @@ extern DECLSPEC int SDLCALL Mix_FadeInMusicPos(Mix_Music *music, int loops, int * any available. * \param chunk the new chunk to play. * \param loops the number of times the chunk should loop, -1 to loop (not - * actually) infinitely. + * actually) infinitely. * \param ms the number of milliseconds to spend fading in. * \returns which channel was used to play the sound, or -1 if sound could not * be played. @@ -1965,7 +1966,7 @@ extern DECLSPEC int SDLCALL Mix_FadeInChannel(int channel, Mix_Chunk *chunk, int * any available. * \param chunk the new chunk to play. * \param loops the number of times the chunk should loop, -1 to loop (not - * actually) infinitely. + * actually) infinitely. * \param ms the number of milliseconds to spend fading in. * \param ticks the maximum number of milliseconds of this chunk to mix for * playback. @@ -2008,7 +2009,7 @@ extern DECLSPEC int SDLCALL Mix_Volume(int channel, int volume); * Set the volume for a specific chunk. * * In addition to channels having a volume setting, individual chunks also - * maintain a seperate volume. Both values are considered when mixing, so both + * maintain a separate volume. Both values are considered when mixing, so both * affect the final attenuation of the sound. This lets an app adjust the * volume for all instances of a sound in addition to specific instances of * that sound. @@ -2117,8 +2118,8 @@ extern DECLSPEC int SDLCALL Mix_HaltChannel(int channel); * This will stop further playback on all channels with a specific tag, until * a new chunk is started there. * - * A tag is an arbitary number that can be assigned to several mixer channels, - * to form groups of channels. + * A tag is an arbitrary number that can be assigned to several mixer + * channels, to form groups of channels. * * The default tag for a channel is -1. * @@ -2210,8 +2211,8 @@ extern DECLSPEC int SDLCALL Mix_FadeOutChannel(int which, int ms); * current volumes to silence over `ms` milliseconds. After that time, those * channels are halted. * - * A tag is an arbitary number that can be assigned to several mixer channels, - * to form groups of channels. + * A tag is an arbitrary number that can be assigned to several mixer + * channels, to form groups of channels. * * The default tag for a channel is -1. * @@ -2797,5 +2798,3 @@ extern DECLSPEC void SDLCALL Mix_CloseAudio(void); #include "close_code.h" #endif /* SDL_MIXER_H_ */ - -/* vi: set ts=4 sw=4 expandtab: */