al_grab_mouse(3alleg5)

al_grab_mouse3alleg5

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

Note: not yet implemented on Mac OS X.

Releases

6 releases since Debian 8 (Jessie); the text changed 5 times.

  1. 8
  2. 9
  3. 10
  4. 11
  5. 12
  6. 13

From allegro5-doc 2:5.2.10.1+dfsg-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.