(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_SetWindowMouseGrab

Set a window's mouse grab mode.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

bool SDL_SetWindowMouseGrab(SDL_Window *window, bool grabbed);

Function Parameters

SDL_Window *	window	the window for which the mouse grab mode should be set.
bool	grabbed	this is true to grab mouse, and false to release.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

Mouse grab confines the mouse cursor to the window.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetWindowMouseRect
• SDL_SetWindowMouseRect
• SDL_SetWindowMouseGrab
• SDL_SetWindowKeyboardGrab

---

CategoryAPI, CategoryAPIFunction, CategoryVideo, CategoryMouse,

[ 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.