Man page - sdl_setwindowmousegrab(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

SDL_SetWindowMouseGrab - Set a window’s mouse grab mode.

Defined in SDL3/SDL_video.h

#include "SDL3/SDL.h"

bool SDL_SetWindowMouseGrab(SDL_Window *window, bool grabbed);

Mouse grab confines the mouse cursor to the window.

window

the window for which the mouse grab mode should be set.

grabbed

this is true to grab mouse, and false to release.

Returns true on success or false on failure; call

SDL_GetError () for more information.

This function should only be called on the main thread.

This function is available since SDL 3.2.0.