NAME¶

SDL_SetWindowGrab - Set a window's input grab mode.

SYNOPSIS¶

#include "SDL3/SDL.h"

int SDL_SetWindowGrab(SDL_Window *window, SDL_bool grabbed);

DESCRIPTION¶

When input is grabbed, the mouse is confined to the window. This function will also grab the keyboard if

SDL_HINT_GRAB_KEYBOARD is set. To grab the keyboard without also grabbing the mouse, use

SDL_SetWindowKeyboardGrab ().

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 input grab mode should be set

grabbed

SDL_TRUE
to grab input or SDL_FALSE
to release input

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_GetGrabbedWindow(3), SDL_GetWindowGrab(3)