###### (This is the legacy documentation for SDL2, the previous stable version; [SDL3](https://wiki.libsdl.org/SDL3/) is the current stable version.)
# SDL_SetWindowGrab

Set a window's input grab mode.

## Header File

Defined in [SDL_video.h](https://github.com/libsdl-org/SDL/blob/SDL2/include/SDL_video.h)

## Syntax

```c
void SDL_SetWindowGrab(SDL_Window * window,
                       SDL_bool grabbed);
```

## Function Parameters

|                            |             |                                                                                |
| -------------------------- | ----------- | ------------------------------------------------------------------------------ |
| [SDL_Window](SDL_Window) * | **window**  | the window for which the input grab mode should be set.                        |
| [SDL_bool](SDL_bool)       | **grabbed** | [SDL_TRUE](SDL_TRUE) to grab input or [SDL_FALSE](SDL_FALSE) to release input. |

## Remarks

When input is grabbed, the mouse is confined to the window. This function
will also grab the keyboard if
[`SDL_HINT_GRAB_KEYBOARD`](SDL_HINT_GRAB_KEYBOARD) is set. To grab the
keyboard without also grabbing the mouse, use
[SDL_SetWindowKeyboardGrab](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.

## Version

This function is available since SDL 2.0.0.

## See Also

- [SDL_GetGrabbedWindow](SDL_GetGrabbedWindow)
- [SDL_GetWindowGrab](SDL_GetWindowGrab)

----
[CategoryAPI](CategoryAPI), [CategoryAPIFunction](CategoryAPIFunction), [CategoryVideo](CategoryVideo)