(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_ReadS16LE

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

Header File

Defined in <SDL3/SDL_iostream.h>

Syntax

bool SDL_ReadS16LE(SDL_IOStream *src, Sint16 *value);

Function Parameters

SDL_IOStream *	src	the stream from which to read data.
Sint16 *	value	a pointer filled in with the data read.

Return Value

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

Remarks

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.

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryIOStream

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.