From 2e451982990b6c7e6c02f77f3f0c1ee29b6a7490 Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Fri, 25 Apr 2025 18:14:48 +0000
Subject: [PATCH] Sync SDL3 wiki -> header
[ci skip]
---
include/SDL3/SDL_audio.h | 21 +++++++++++----------
1 file changed, 11 insertions(+), 10 deletions(-)
diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h
index 4bb75640356b3..484169a6b0411 100644
--- a/include/SDL3/SDL_audio.h
+++ b/include/SDL3/SDL_audio.h
@@ -1934,15 +1934,14 @@ extern SDL_DECLSPEC SDL_AudioStream * SDLCALL SDL_OpenAudioDeviceStream(SDL_Audi
/**
* A callback that fires around an audio device's processing work.
*
- * This callback fires when a logical audio device is about to start
- * accessing its bound audio streams, and fires again when it has
- * finished accessing them. It covers the range of one "iteration" of
- * the audio device.
+ * This callback fires when a logical audio device is about to start accessing
+ * its bound audio streams, and fires again when it has finished accessing
+ * them. It covers the range of one "iteration" of the audio device.
*
- * It can be useful to use this callback to update state that must
- * apply to all bound audio streams atomically: to make sure state
- * changes don't happen while half of the streams are already processed
- * for the latest audio buffer.
+ * It can be useful to use this callback to update state that must apply to
+ * all bound audio streams atomically: to make sure state changes don't happen
+ * while half of the streams are already processed for the latest audio
+ * buffer.
*
* This callback should run as quickly as possible and not block for any
* significant time, as this callback delays submission of data to the audio
@@ -1997,8 +1996,10 @@ typedef void (SDLCALL *SDL_AudioIterationCallback)(void *userdata, SDL_AudioDevi
* for both.
*
* \param devid the ID of an opened audio device.
- * \param start a callback function to be called at the start of an iteration. Can be NULL.
- * \param end a callback function to be called at the end of an iteration. Can be NULL.
+ * \param start a callback function to be called at the start of an iteration.
+ * Can be NULL.
+ * \param end a callback function to be called at the end of an iteration. Can
+ * be NULL.
* \param userdata app-controlled pointer passed to callback. Can be NULL.
* \returns true on success or false on failure; call SDL_GetError() for more
* information.