From 8714de9f462dde792b6272116df5633f3e209996 Mon Sep 17 00:00:00 2001
From: Anonymous Maarten <[EMAIL REDACTED]>
Date: Thu, 8 Aug 2024 00:42:57 +0200
Subject: [PATCH] SDL_GetAudioStreamAvailable and SDL_GetAudioStreamAvailable
return error codes
---
include/SDL3/SDL_audio.h | 6 ++++--
1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h
index f25959c3b09fc..d15bbaa6f5145 100644
--- a/include/SDL3/SDL_audio.h
+++ b/include/SDL3/SDL_audio.h
@@ -1309,7 +1309,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamData(SDL_AudioStream *stream,
* clamped.
*
* \param stream the audio stream to query.
- * \returns the number of converted/resampled bytes available.
+ * \returns the number of converted/resampled bytes available or a negative
+ * error code on failure; call SDL_GetError() for more information.
*
* \threadsafety It is safe to call this function from any thread.
*
@@ -1341,7 +1342,8 @@ extern SDL_DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *str
* clamped.
*
* \param stream the audio stream to query.
- * \returns the number of bytes queued.
+ * \returns the number of bytes queued or a negative error code on failure;
+ * call SDL_GetError() for more information.
*
* \threadsafety It is safe to call this function from any thread.
*