table of contents
- experimental 3.1.0+ds-1
SDL_ReadIO(3) | SDL3 FUNCTIONS | SDL_ReadIO(3) |
NAME¶
SDL_ReadIO - Read from a data source.
SYNOPSIS¶
#include "SDL3/SDL.h"
size_t SDL_ReadIO(SDL_IOStream *context, void *ptr, size_t size);
DESCRIPTION¶
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 -1 on error. For streams that support non-blocking operation, if nothing was read because it would require blocking, this function returns -2 to distinguish that this is not an error or end-of-file, and the caller can try again later.
FUNCTION PARAMETERS¶
RETURN VALUE¶
Returns the number of bytes read, or 0 on end of file or other error.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SEE ALSO¶
SDL 3.1.0 | SDL |