SDL_ReadU16LE(3)

💖 SDL_ReadU16LE 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, page SDL_ReadU16LE(3), and yes we are about to read 16 bits of little-endian data out of an SDL_IOStream and hand it back to you in native format. slay.

---

✨ NAME ✨

SDL_ReadU16LE — use this function to read 16 bits of little-endian data from an SDL_IOStream and return in native format. it's giving "endianness? handled." 🦋

---

✨ SYNOPSIS ✨

#include <SDL3/SDL_iostream.h>

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

---

✨ DESCRIPTION ✨

so here's the tea: SDL byteswaps the data only if necessary, so the data you get back will be in the native byte order. no cap, it just does the right thing for your machine. 💅

this function will return false when the data stream is completely read, and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. and if false is returned but the stream is not at EOF, SDL_GetIOStatus() will return a different error value and SDL_GetError() will offer a human-readable message. so like… read the status, bestie, don't assume. 🙈

---

✨ FUNCTION PARAMETERS ✨

• src — the stream from which to read data. your source, your main character. 🎀
• value — a pointer filled in with the data read. this is where the 16 bits land. ✨

---

✨ RETURN VALUE ✨

returns true on successful read or false on failure; call SDL_GetError() for more information. simple as that. 👑

---

✨ THREAD SAFETY ✨

do not use the same SDL_IOStream from two threads at once. seriously. that's a whole mess you do not want. 💀

---

✨ AVAILABILITY ✨

this function is available since SDL 3.2.0. so if you're on something older, it's giving "not yet, babe." 🌸

---

and that's the whole vibe check, fr fr. this page came to you from Simple Directmedia Layer, rocking SDL 3.4.18 — thanks for reading, ily, go read your streams responsibly 🫶✨💜