SDL_ReadU8(3)

SDL_ReadU83

Use this function to read a byte from an sdl_iostream .

Usage

#include "SDL3/SDL.h"

bool SDL_ReadU8(SDL_IOStream *src, Uint8 *value);

Header file

Defined in SDL3/SDL_iostream.h

Overview

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.

Function parameters

src

the SDL_IOStream
to read from.

value

a pointer filled in with the data read.

Return value

Returns true on success or false on failure or EOF; call

SDL_GetError () for more information.

Thread safety

This function is not thread safe.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.