.\" Automatically generated by Pandoc 3.5
.\"
.TH "al_grab_mouse" "3" "" "Allegro reference manual"
.SH NAME
al_grab_mouse \- Allegro 5 API
.SH SYNOPSIS
.IP
.EX
#include \f[B]<allegro5/allegro.h>\f[R]

bool al_grab_mouse(ALLEGRO_DISPLAY *display)
.EE
.SH DESCRIPTION
Confine the mouse cursor to the given display.
The mouse cursor can only be confined to one display at a time.
.PP
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.
.RS
.PP
\f[I]Note:\f[R] not yet implemented on Mac OS X.
.RE
.SH SEE ALSO
al_ungrab_mouse(3)