devela::_dep::sdl3::sys::iostream

Function SDL_ReadS16LE

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

Use this function to read 16 bits of little-endian data from an SDL_IOStream and return in native format.

SDL byteswaps the data only if necessary, so the data returned will be in the native byte order.

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 stream from which to read data.
  • value: a pointer filled in with the data read.

§Return value

Returns true on successful write or false on failure; call SDL_GetError() for more information.

§Thread safety

This function is not thread safe.

§Availability

This function is available since SDL 3.2.0.