NAME¶

SDL_SetWindowKeyboardGrab - Set a window's keyboard grab mode.

SYNOPSIS¶

#include "SDL3/SDL.h"

int SDL_SetWindowKeyboardGrab(SDL_Window *window, SDL_bool grabbed);

DESCRIPTION¶

Keyboard grab enables capture of system keyboard shortcuts like Alt+Tab or the Meta/Super key. Note that not all system keyboard shortcuts can be captured by applications (one example is Ctrl+Alt+Del on Windows).

This is primarily intended for specialized applications such as VNC clients or VM frontends. Normal games should not use keyboard grab.

When keyboard grab is enabled, SDL will continue to handle Alt+Tab when the window is full-screen to ensure the user is not trapped in your application. If you have a custom keyboard shortcut to exit fullscreen mode, you may suppress this behavior with

SDL_HINT_ALLOW_ALT_TAB_WHILE_GRABBED .

If the caller enables a grab while another window is currently grabbed, the other window loses its grab in favor of the caller's window.

FUNCTION PARAMETERS¶

window

The window for which the keyboard grab mode should be set.

grabbed

This is SDL_TRUE
to grab keyboard, and SDL_FALSE
to release.

RETURN VALUE¶

Returns 0 on success or a negative error code on failure; call

SDL_GetError () for more information.

AVAILABILITY¶

This function is available since SDL 3.0.0.

SEE ALSO¶

SDL_GetWindowKeyboardGrab(3), SDL_SetWindowMouseGrab(3), SDL_SetWindowGrab(3)