plucky (3) SDL_ReadU8.3.gz

NAME

       SDL_ReadU8 - Use this function to read a byte from an SDL_IOStream .

HEADER FILE

       Defined in SDL3/SDL_iostream.h

SYNOPSIS

       #include "SDL3/SDL.h"

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

DESCRIPTION

       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.