Browse Source

Sync SDL3 wiki -> header

SDL Wiki Bot 1 year ago
parent
commit
36b5f3e35c
1 changed files with 12 additions and 10 deletions
  1. 12 10
      include/SDL3/SDL_audio.h

+ 12 - 10
include/SDL3/SDL_audio.h

@@ -726,17 +726,19 @@ extern DECLSPEC float SDLCALL SDL_GetAudioStreamFrequencyRatio(SDL_AudioStream *
 
 /**
  * Change the frequency ratio of an audio stream.
- * 
- * 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 audio.
- * A value greater than 1.0 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.
- * 
- * This is applied during SDL_GetAudioStreamData, and can be continuously changed
- * to create various effects.
- * 
+ *
+ * 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
+ * audio. A value greater than 1.0 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.
+ *
+ * This is applied during SDL_GetAudioStreamData, and can be continuously
+ * changed to create various effects.
+ *
  * \param stream The stream the frequency ratio is being changed
- * \param ratio The frequency ratio. 1.0 is normal speed. Must be between 0.01 and 100.
+ * \param ratio The frequency ratio. 1.0 is normal speed. Must be between 0.01
+ *              and 100.
  * \returns 0 on success, or -1 on error.
  *
  * \threadsafety It is safe to call this function from any thread, as it holds