From 9786d8ac402f05c44fdf9fa1d7984dcfed5c4ab4 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Tue, 9 May 2023 18:27:15 +0000
Subject: [PATCH] Sync SDL3 wiki -> header
---
include/SDL3/SDL_audio.h | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h
index 8bc393aef16e..544bd98fefe9 100644
--- a/include/SDL3/SDL_audio.h
+++ b/include/SDL3/SDL_audio.h
@@ -1224,16 +1224,15 @@ extern DECLSPEC void SDLCALL SDL_CloseAudioDevice(SDL_AudioDeviceID dev);
/**
* Convert some audio data of one format to another format.
*
- * Please note that this function is for convenience, but should not
- * be used to resample audio in blocks, as it will introduce audio
- * artifacts on the boundaries. You should only use this function if
- * you are converting audio data in its entirety in one call. If you
- * want to convert audio in smaller chunks, use an SDL_AudioStream,
- * which is designed for this situation.
- *
- * Internally, this function creates and destroys an SDL_AudioStream
- * on each use, so it's also less efficient than using one directly,
- * if you need to convert multiple times.
+ * Please note that this function is for convenience, but should not be used
+ * to resample audio in blocks, as it will introduce audio artifacts on the
+ * boundaries. You should only use this function if you are converting audio
+ * data in its entirety in one call. If you want to convert audio in smaller
+ * chunks, use an SDL_AudioStream, which is designed for this situation.
+ *
+ * Internally, this function creates and destroys an SDL_AudioStream on each
+ * use, so it's also less efficient than using one directly, if you need to
+ * convert multiple times.
*
* \param src_format The format of the source audio
* \param src_channels The number of channels of the source audio