SDL_SetWindowMouseGrab(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💖 SDL_SetWindowMouseGrab(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, where we're talking about SDL_SetWindowMouseGrab — the little function that decides whether your mouse cursor is allowed to escape your window or not. it's giving gatekeeper energy, but for cursors. 🦋

✨ NAME ✨

SDL_SetWindowMouseGrab — set a window's mouse grab mode. that's it, that's the whole job. iconic. 💅

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_video.h>

bool SDL_SetWindowMouseGrab(SDL_Window *window, bool grabbed);

yes bestie, you get a bool back. we love a return value that tells us how it went. 🫶

🎀 DESCRIPTION 🎀

so here's the tea: mouse grab confines the mouse cursor to the window. that's literally the entire vibe. cursor stays inside, no sneaking off to another monitor or another app. it's in its lane, fr fr. 🐭➡️🚫

💜 FUNCTION PARAMETERS 💜

  • window — the window for which the mouse grab mode should be set. the main character, basically. 👑
  • grabbed — this is true to grab mouse, and false to release. two moods, one bool. pick your fighter. ✨

🌈 RETURN VALUE 🌈

returns true on success or false on failure — and if it fails, call SDL_GetError() for more information. do not just sit there wondering what went wrong, bestie, the error message is right there. go get it. 😭

🔥 THREAD SAFETY 🔥

This function should only be called on the main thread. no side quests, no background threads, no sneaky little worker thread trying to be cute. main thread only. periodt. 💀

⭐ AVAILABILITY ⭐

this function is available since SDL 3.2.0. if you're on anything older, sorry bestie, it's not there. 🥺

🦋 SEE ALSO 🦋

go read those too, they're all in the same friend group. iykyk. 💖

and that's the whole page, bestie!! mwah. this one came from Simple Directmedia Layer, running SDL 3.4.18, and it's the SDL_SetWindowMouseGrab(3) page — go grab (or release) those cursors responsibly. no cap. 🎀✨💅

📦 where this page comes from