(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetWindowKeyboardGrab

Get a window's keyboard grab mode.

Header File

Defined in <SDL3/SDL_video.h>

Syntax

SDL_bool SDL_GetWindowKeyboardGrab(SDL_Window *window);

Function Parameters

window

the window to query

Return Value

Returns SDL_TRUE if keyboard is grabbed, and SDL_FALSE otherwise.

Version

This function is available since SDL 3.0.0.

See Also

SDL_SetWindowKeyboardGrab

CategoryAPI, CategoryAPIFunction, CategoryVideo