mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-06 03:18:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

include: a couple of documentation tweaks and typo fixes.

Browse Source
This commit is contained in:
Ryan C. Gordon
2025-06-15 22:12:21 -04:00
parent 42c9fe119d
commit 6c406dd122
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
include/SDL3/SDL_audio.h
View File

@@ -1149,14 +1149,14 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioStreamFrequencyRatio(SDL_AudioStre
* *
* The frequency ratio is used to adjust the rate at which input data is * The frequency ratio is used to adjust the rate at which input data is
* consumed. Changing this effectively modifies the speed and pitch of the * consumed. Changing this effectively modifies the speed and pitch of the
* audio. A value greater than 1.0 will play the audio faster, and at a higher * audio. A value greater than 1.0f will play the audio faster, and at a higher
* pitch. A value less than 1.0 will play the audio slower, and at a lower * pitch. A value less than 1.0f will play the audio slower, and at a lower
* pitch. * pitch. 1.0f means play at normal speed.
* *
* This is applied during SDL_GetAudioStreamData, and can be continuously * This is applied during SDL_GetAudioStreamData, and can be continuously
* changed to create various effects. * changed to create various effects.
* *
* \param stream the stream the frequency ratio is being changed. * \param stream the stream on which the frequency ratio is being changed.
* \param ratio the frequency ratio. 1.0 is normal speed. Must be between 0.01 * \param ratio the frequency ratio. 1.0 is normal speed. Must be between 0.01
* and 100. * and 100.
* \returns true on success or false on failure; call SDL_GetError() for more * \returns true on success or false on failure; call SDL_GetError() for more
@@ -1332,7 +1332,7 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamInputChannelMap(SDL_AudioStre
* Channel maps are optional; most things do not need them, instead passing * Channel maps are optional; most things do not need them, instead passing
* data in the [order that SDL expects](CategoryAudio#channel-layouts). * data in the [order that SDL expects](CategoryAudio#channel-layouts).
* *
* The output channel map reorders data that leaving a stream via * The output channel map reorders data that is leaving a stream via
* SDL_GetAudioStreamData. * SDL_GetAudioStreamData.
* *
* Each item in the array represents an input channel, and its value is the * Each item in the array represents an input channel, and its value is the