SDL_GetWindowMouseGrab(3)

💖 SDL_GetWindowMouseGrab 💖

okay bestie so this is a page from the SDL3 FUNCTIONS manual, and today's main character is SDL_GetWindowMouseGrab — she's the one who tells you whether a window is currently grabbing the mouse. no cap. ✨

---

🌸 NAME 🌸

SDL_GetWindowMouseGrab — get a window's mouse grab mode. that's it, that's the whole job, and she does it flawlessly 💅

---

🎀 SYNOPSIS 🎀

#include <SDL3/SDL_video.h>

bool SDL_GetWindowMouseGrab(SDL_Window *window);

like, include the header, call the function, get a bool back. iconic. 🦋

---

✨ FUNCTION PARAMETERS ✨

• window — the window you're querying, aka the one you want the tea on 👀

---

💫 RETURN VALUE 💫

• Returns true if the mouse is grabbed 🫶
• Returns false otherwise 🙈

that's the whole vibe check, fr fr.

---

🔥 THREAD SAFETY 🔥

bestie. listen. this function should only be called on the main thread. do not try her on a worker thread, she will not be slaying there. 💀

---

🌈 AVAILABILITY 🌈

this one's been around since SDL 3.2.0 — so if you're on anything older, she simply does not exist for you 😭

---

👑 SEE ALSO 👑

• SDL_GetWindowMouseRect(3)
• SDL_SetWindowMouseRect(3)
• SDL_SetWindowMouseGrab(3)
• SDL_SetWindowKeyboardGrab(3)

go read those too, they're all part of the same friend group 💜

---

Simple Directmedia Layer wrote this, and it's from SDL 3.4.18 — mwah, thanks for coming to my TED talk, ily, go grab a mouse (or don't, that's literally what the function is for) 🎀✨🦋