---
name: "SDL_SetWindowMouseGrab"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_SetWindowMouseGrab"
---

# SDL\_SetWindowMouseGrab(3)

Set a window's mouse grab mode.

## NAME

SDL\_SetWindowMouseGrab - Set a window's mouse grab mode.

## HEADER FILE

Defined in SDL3/SDL\_video.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**bool SDL\_SetWindowMouseGrab(SDL\_Window \*window, bool grabbed);**

## DESCRIPTION

Mouse grab confines the mouse cursor to the window.

## FUNCTION PARAMETERS

- *window*

  the window for which the mouse grab mode should be set.

- *grabbed*

  this is true to grab mouse, and false to release.

## RETURN VALUE

Returns true on success or false on failure; call

**SDL\_GetError** () for more information.

## THREAD SAFETY

This function should only be called on the main thread.

## AVAILABILITY

This function is available since SDL 3.2.0.

## SEE ALSO

**•**(3), [**SDL\_GetWindowMouseRect**(3)](/SDL_GetWindowMouseRect/3.md), **•**(3), [**SDL\_SetWindowMouseRect**(3)](/SDL_SetWindowMouseRect/3.md), **•**(3), [**SDL\_SetWindowMouseGrab**(3)](/SDL_SetWindowMouseGrab/3.md), **•**(3), [**SDL\_SetWindowKeyboardGrab**(3)](/SDL_SetWindowKeyboardGrab/3.md)