SDL_SetWindowMouseGrab - Man Page
Set a window's mouse grab mode.
Synopsis
#include <SDL3/SDL_video.h> bool SDL_SetWindowMouseGrab(SDL_Window *window, bool grabbed);
Description
Mouse grab confines the mouse cursor to the window.
Function Parameters
- window
the window for which the mouse grab mode should be set.
- grabbed
this is true to grab mouse, and false to release.
Return Value
for more information.
Thread Safety
This function should only be called on the main thread.
Availability
This function is available since SDL 3.2.0.
See Also
SDL_GetWindowMouseRect(3), SDL_SetWindowMouseRect(3), SDL_SetWindowMouseGrab(3), SDL_SetWindowKeyboardGrab(3)
Referenced By
SDL_GetGrabbedWindow(3), SDL_GetWindowFlags(3), SDL_GetWindowMouseGrab(3), SDL_GetWindowMouseRect(3), SDL_SetWindowKeyboardGrab(3), SDL_SetWindowMouseRect(3).
SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS