SDL_FlushIO(3)

💖 SDL_FlushIO(3) — the SDL3 functions glow-up 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, where we're talking about SDL_FlushIO — aka the "pls just send it already" function 🫶

---

✨ NAME ✨

SDL_FlushIO — flush any buffered data in the stream. no cap, that's the whole job description 💅

---

✨ SYNOPSIS ✨

#include <SDL3/SDL_iostream.h>

bool SDL_FlushIO(SDL_IOStream *context);

---

✨ DESCRIPTION ✨

so here's the tea ☕ — this function makes sure that any buffered data is written to the stream. it's giving "bestie, hit send" energy 📨

normally this isn't necessary 🥱 — like, the stream handles its own business most of the time and you can just vibe. but if the stream is a pipe or a socket, this guarantees that any pending data is actually sent. that's the moment where SDL_FlushIO is literally the main character 👑

---

✨ FUNCTION PARAMETERS ✨

• context — the SDL_IOStream structure you wanna flush. yes, that one. the stream. give it a lil flush 🌊

---

✨ RETURN VALUE ✨

• returns true on success 🎉
• returns false on failure 😭 — and if that happens, call SDL_GetError() for more info, she'll tell you what went wrong 💀

---

✨ THREAD SAFETY ✨

🚨 do not use the same SDL_IOStream from two threads at once. i'm so serious. that's a vibe check you do NOT want to fail 🙈

---

✨ AVAILABILITY ✨

this function has been available since SDL 3.2.0 ⭐ so if you're on anything older, that's a you problem (respectfully) 💜

---

✨ SEE ALSO ✨

• SDL_OpenIO(3)
• SDL_WriteIO(3)

go read those too, they're iconic in their own right 🦋

---

and that's the whole page, bestie!! brought to you by Simple Directmedia Layer 🌈, running the SDL 3.4.18 era of the SDL 3 timeline ✨ — flush responsibly, mwah 💋🎀