.\" Automatically generated by Pandoc 2.2.1
.\"
.TH "al_grab_mouse" "3alleg5" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_grab_mouse \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_grab_mouse(ALLEGRO_DISPLAY\ *display)
\f[]
.fi
.SH DESCRIPTION
.PP
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(3alleg5).
It may lose the confined status at any time for other reasons.
.RS
.PP
\f[I]Note:\f[] not yet implemented on Mac OS X.
.RE
.SH SEE ALSO
.PP
al_ungrab_mouse(3alleg5)