---
name: "al_grab_mouse"
section: "3"
platform: "linux"
package: "allegro"
version: "5.2.11.3-2"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/al_grab_mouse"
---

# al\_grab\_mouse(3)

Allegro 5 API

## NAME

al\_grab\_mouse - Allegro 5 API

## SYNOPSIS

-

  ```
  #include <allegro5/allegro.h>
  bool al_grab_mouse(ALLEGRO_DISPLAY *display)
  ```

## DESCRIPTION

Confine the mouse cursor to the given display. The mouse cursor can only be confined to one display at a time.

Returns true if successful, otherwise returns false. Do not assume that the cursor will remain confined until you call [al\_ungrab\_mouse(3)](/al_ungrab_mouse/3.md). It may lose the confined status at any time for other reasons.

*Note:* not yet implemented on Mac OS X.

## SEE ALSO

[al\_ungrab\_mouse(3)](/al_ungrab_mouse/3.md)