al_grab_mouse(3)

al_grab_mouse3

Allegro 5 api

Usage

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

Overview

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). It may lose the confined status at any time for other reasons.

Note: not yet implemented on Mac OS X.

From allegro 5.2.11.3-2 in Arch Linux 2026-11-01. Parsed by carta from the page's man source.