---
name: "SDL_SetWindowMouseRect"
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_SetWindowMouseRect"
---

# SDL\_SetWindowMouseRect(3)

Confines the cursor to the specified area of a window.

## NAME

SDL\_SetWindowMouseRect - Confines the cursor to the specified area of a window.

## HEADER FILE

Defined in SDL3/SDL\_video.h

## SYNOPSIS

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

**bool SDL\_SetWindowMouseRect(SDL\_Window \*window, const SDL\_Rect \*rect);**

## DESCRIPTION

Note that this does NOT grab the cursor, it only defines the area a cursor is restricted to when the window has mouse focus.

## FUNCTION PARAMETERS

- *window*

  the window that will be associated with the barrier.

- *rect*

  a rectangle area in window-relative coordinates. If NULL the barrier for the specified window will be destroyed.

## 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\_GetWindowMouseGrab**(3)](/SDL_GetWindowMouseGrab/3.md), **•**(3), [**SDL\_SetWindowMouseGrab**(3)](/SDL_SetWindowMouseGrab/3.md)