From 6da4278d37f008553cf299dd1dafdb397b774c8e Mon Sep 17 00:00:00 2001
From: Sam Lantinga <[EMAIL REDACTED]>
Date: Sun, 4 Aug 2024 10:37:51 -0700
Subject: [PATCH] Clarify how to check for EOF in SDL_ReadIO() documentation.
Fixes https://github.com/libsdl-org/SDL/issues/8564
---
include/SDL3/SDL_iostream.h | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/include/SDL3/SDL_iostream.h b/include/SDL3/SDL_iostream.h
index 430cd3e40bc55..0194f272bfe3e 100644
--- a/include/SDL3/SDL_iostream.h
+++ b/include/SDL3/SDL_iostream.h
@@ -481,9 +481,7 @@ extern SDL_DECLSPEC Sint64 SDLCALL SDL_TellIO(SDL_IOStream *context);
*
* This function reads up `size` bytes from the data source to the area
* pointed at by `ptr`. This function may read less bytes than requested. It
- * will return zero when the data stream is completely read, or on error. To
- * determine if there was an error or all data was read, call
- * SDL_GetIOStatus().
+ * will return zero when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF, or on error, and SDL_GetIOStatus() will return SDL_IO_STATUS_ERROR.
*
* \param context a pointer to an SDL_IOStream structure.
* \param ptr a pointer to a buffer to read data into.