SDL_ReadS8

Use this function to read a signed byte from an SDL_IOStream.

Header File

Defined in <SDL3/SDL_iostream.h>

Syntax

bool SDL_ReadS8(SDL_IOStream *src, Sint8 *value);

Function Parameters

SDL_IOStream * src the SDL_IOStream to read from.
Sint8 * value a pointer filled in with the data read.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

This function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false 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.

Thread Safety

This function is not thread safe.

Version

This function is available since SDL 3.2.0.

CategoryAPI, CategoryAPIFunction, CategoryIOStream