SDL_ReadIO(3)

Usage

#include "SDL3/SDL.h"

size_t SDL_ReadIO(SDL_IOStream *context, void *ptr, size_t size);

Header file

Defined in SDL3/SDL_iostream.h

Overview

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.

This function will return zero when the data stream is completely read, and

SDL_GetIOStatus () will return

SDL_IO_STATUS_EOF . If zero is returned and the stream is not at EOF, SDL_GetIOStatus () will return a different error value and SDL_GetError () will offer a human-readable message.

Function parameters

`context`	a pointer to an `SDL_IOStream` structure.
`ptr`	a pointer to a buffer to read data into.
`size`	the number of bytes to read from the data source.

Return value

Returns the number of bytes read, or 0 on end of file or other failure; call SDL_GetError () for more information.

Thread safety

This function is not thread safe.

Referred to by

SDL_WriteIO(3) Write to an SDL_IOStream data stream. SDL_IOFromMem(3) Use this function to prepare a read-write memory buffer for use with SDL_IOStream . SDL_IOFromFile(3) Use this function to create a new SDL_IOStream structure for reading from and/or writing to a named file. SDL_IOFromConstMem(3) Use this function to prepare a read-only memory buffer for use with SDL_IOStream . SDL_IOFromDynamicMem(3) Use this function to create an SDL_IOStream that is backed by dynamically allocated memory.