SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_ReadU16LE

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

SDL_bool SDL_ReadU16LE(SDL_IOStream *src, Uint16 *value);

Function Parameters

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

Return Value

(SDL_bool) Returns SDL_TRUE on successful write, SDL_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.

Version

This function is available since SDL 3.0.0.


CategoryAPI, CategoryAPIFunction, CategoryIOStream


[ edit | delete | history | feedback | raw ]

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