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

SDL_GetWindowMouseGrab

Get a window's mouse grab mode.

Header File

Defined in SDL_video.h

Syntax

SDL_bool SDL_GetWindowMouseGrab(SDL_Window * window);

Function Parameters

window the window to query

Return Value

Returns SDL_TRUE if mouse is grabbed, and SDL_FALSE otherwise.

Version

This function is available since SDL 2.0.16.

See Also

CategoryAPI, CategoryAPIFunction, CategoryVideo