logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_SetWindowKeyboardGrab - Set a window's keyboard grab mode.

Availability

       This function is available since SDL 3.2.0.

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 true to grab keyboard, and false to release.

Header File

       Defined in SDL3/SDL_video.h

Name

       SDL_SetWindowKeyboardGrab - Set a window's keyboard grab mode.

Return Value

       Returns true on success or false on failure; call

       SDL_GetError () for more information.

See Also

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

Simple Directmedia Layer                           SDL 3.2.10                       SDL_SetWindowKeyboardGrab(3)

Synopsis

#include"SDL3/SDL.h"boolSDL_SetWindowKeyboardGrab(SDL_Window*window,boolgrabbed);

Thread Safety

       This function should only be called on the main thread.

See Also