SDL_GetWindowSafeArea(3)

💖 SDL_GetWindowSafeArea 💖

okay bestie, so this is a page from the SDL3 FUNCTIONS manual, and today's main character is SDL_GetWindowSafeArea(3). no cap, she's lowkey the reason your UI isn't living under a camera notch. let's get into it 🫶

---

✨ NAME ✨

SDL_GetWindowSafeArea — grab the safe area for this window, babes. that's it, that's the whole vibe. 🎀

---

✨ SYNOPSIS ✨

#include <SDL3/SDL_video.h>

bool SDL_GetWindowSafeArea(SDL_Window *window, SDL_Rect *rect);

look at her. two args, one bool, absolutely iconic. 👑

---

✨ DESCRIPTION ✨

okay so picture this: some devices have parts of the screen that are partially obscured or just straight-up not interactive. why?? so many reasons, and they're all valid:

• on-screen controls taking up space
• curved edges (the screen is curvy, she's serving looks but she's also in the way)
• camera notches (the little black blob era 💀)
• TV overscan

this function hands you back the chunk of the window that is safe to have interactable content in. like, the zone where your buttons can actually be pressed and your text can actually be read.

but bestie, listen carefully: you should continue rendering into the rest of the window. don't just stop at the safe area. just don't put anything visually important or interactable out there, okay?? the safe area is for the important stuff, the rest is decor. periodt. 💅

---

✨ FUNCTION PARAMETERS ✨

• window — the window we're querying. the one we're asking about. the subject of the vibe check. 🪟
• rect — a pointer that gets filled in with the client area that is safe for interactive content. she's an out-param, she gets written to, that's her whole job. ✨

---

✨ RETURN VALUE ✨

returns true on success or false on failure. if it's a fail era, call SDL_GetError() for more information, because she will tell you what went wrong. 😭

---

✨ THREAD SAFETY ✨

this function should only be called on the main thread. that's the rule, bestie. don't be out here calling her from a worker thread, that's not her thing. 🚫🧵

---

✨ AVAILABILITY ✨

this function is available since SDL 3.2.0. so if you're on something older… babe. upgrade. 🌈

---

and that's the whole page, no notes, she ate and left no crumbs 💜

this has been your girlie signing off from the Simple Directmedia Layer docs, SDL 3.4.18 edition — go be safe out there (in the safe area specifically) 🦋🌸💖