Function SDL_ReadU8

pub unsafe extern "C" fn SDL_ReadU8(
    src: *mut SDL_IOStream,
    value: *mut u8,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Use this function to read a byte from an SDL_IOStream.

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.

§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.