SDL_GetWindowMouseRect(3)

💖 SDL_GetWindowMouseRect(3) — the SDL3 FUNCTIONS era 💖

okay bestie, listen. this is the manual page for SDL_GetWindowMouseRect, and it's giving "short but iconic." it does one (1) thing and it does it flawlessly. no notes. 👑

---

✨ NAME ✨

SDL_GetWindowMouseRect — grab the mouse confinement rectangle of a window. that's it, that's the whole job, and she eats every time. 🎀

---

✨ SYNOPSIS ✨

#include <SDL3/SDL_video.h>

const SDL_Rect * SDL_GetWindowMouseRect(SDL_Window *window);

look at her. one include, one function call, zero drama. 💅

---

✨ FUNCTION PARAMETERS ✨

• window — the window you wanna interrogate, bestie. this is the one you're asking "hey girl, where's your mouse confinement rectangle at?" 🔍

---

✨ RETURN VALUE ✨

• *) — returns a pointer to the mouse confinement rectangle of a window, or NULL if there isn't one. so like… if she comes back with NULL, that window simply doesn't have a confinement rectangle. no rectangle, no problem, we move on. 🦋

bestie PLEASE check for that NULL. it's not a vibe to dereference it. 😭

---

✨ THREAD SAFETY ✨

this one is main thread only, no cap. do not be calling this from some random worker thread, i am begging you. main thread. main character energy only. 👑

---

✨ AVAILABILITY ✨

she's been around since SDL 3.2.0. a modern queen. 🌸

---

✨ SEE ALSO ✨

• SDL_SetWindowMouseRect(3) — the setter to this getter. the other half of the duo. 🫶
• SDL_GetWindowMouseGrab(3) — grab, but getting. ✨
• SDL_SetWindowMouseGrab(3) — grab, but setting. ✨

---

and that's the whole page, bestie!! literally obsessed with how short this one is. fr fr. 💜

this little love letter to you came from the fine folks at Simple Directmedia Layer, and this is the SDL 3.4.18 version of the page. mwah. 🎀💖✨