logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_ReadS16LE - Use this function to read 16 bits of little-endian data from an SDL_IOStream

Availability

       This function is available since SDL 3.2.0.

Simple Directmedia Layer                           SDL 3.2.10                                   SDL_ReadS16LE(3)

Description

       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.

Function Parameters

src    the stream from which to read data.

       value  a pointer filled in with the data read.

Header File

       Defined in SDL3/SDL_iostream.h

Name

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

Return Value

       Returns true on successful write or false on failure; call

       SDL_GetError () for more information.

Synopsis

#include"SDL3/SDL.h"boolSDL_ReadS16LE(SDL_IOStream*src,Sint16*value);

Thread Safety

       This function is not thread safe.

See Also