(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_SetWindowMouseGrab

Set a window's mouse grab mode.

Header File

Defined in SDL_video.h, but apps should only #include "SDL.h"!

Syntax

void SDL_SetWindowMouseGrab(SDL_Window * window,
                            SDL_bool grabbed);

Function Parameters

window	The window for which the mouse grab mode should be set.
grabbed	This is SDL_TRUE to grab mouse, and SDL_FALSE to release.

Remarks

Mouse grab confines the mouse cursor to the window.

Version

This function is available since SDL 2.0.16.

See Also

• SDL_GetWindowMouseGrab
• SDL_SetWindowKeyboardGrab
• SDL_SetWindowGrab

---

CategoryAPI, CategoryAPIFunction

---

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.