Skip to content

Commit 6c406dd

Browse files
committed
include: a couple of documentation tweaks and typo fixes.
1 parent 42c9fe1 commit 6c406dd

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

include/SDL3/SDL_audio.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1149,14 +1149,14 @@ extern SDL_DECLSPEC float SDLCALL SDL_GetAudioStreamFrequencyRatio(SDL_AudioStre
11491149
*
11501150
* The frequency ratio is used to adjust the rate at which input data is
11511151
* consumed. Changing this effectively modifies the speed and pitch of the
1152-
* audio. A value greater than 1.0 will play the audio faster, and at a higher
1153-
* pitch. A value less than 1.0 will play the audio slower, and at a lower
1154-
* pitch.
1152+
* audio. A value greater than 1.0f will play the audio faster, and at a higher
1153+
* pitch. A value less than 1.0f will play the audio slower, and at a lower
1154+
* pitch. 1.0f means play at normal speed.
11551155
*
11561156
* This is applied during SDL_GetAudioStreamData, and can be continuously
11571157
* changed to create various effects.
11581158
*
1159-
* \param stream the stream the frequency ratio is being changed.
1159+
* \param stream the stream on which the frequency ratio is being changed.
11601160
* \param ratio the frequency ratio. 1.0 is normal speed. Must be between 0.01
11611161
* and 100.
11621162
* \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
13321332
* Channel maps are optional; most things do not need them, instead passing
13331333
* data in the [order that SDL expects](CategoryAudio#channel-layouts).
13341334
*
1335-
* The output channel map reorders data that leaving a stream via
1335+
* The output channel map reorders data that is leaving a stream via
13361336
* SDL_GetAudioStreamData.
13371337
*
13381338
* Each item in the array represents an input channel, and its value is the

0 commit comments

Comments
 (0)