mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-10-21 17:21:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify how to check for EOF in SDL_ReadIO() documentation.

Browse Source 
Fixes https://github.com/libsdl-org/SDL/issues/8564
This commit is contained in:
Sam Lantinga
2024-08-04 10:37:51 -07:00
parent 66cb2153cc
commit 6da4278d37
1 changed files with 1 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
include/SDL3/SDL_iostream.h
View File

@@ -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.