.\" Generated by the Allegro makedoc utility
.TH poll_mouse 3alleg4 "version 4.4.3" "Allegro" "Allegro manual"
.SH NAME
poll_mouse \- Polls the mouse. Allegro game programming library.\&
.SH SYNOPSIS
.B #include <allegro.h>

.sp
.B int poll_mouse();
.SH DESCRIPTION
Wherever possible, Allegro will read the mouse input asynchronously (ie. 
from inside an interrupt handler), but on some platforms that may not be 
possible, in which case you must call this routine at regular intervals 
to update the mouse state variables. To help you test your mouse polling 
code even if you are programming on a platform that doesn't require it, 
after the first time that you call this function Allegro will switch into 
polling mode, so from that point onwards you will have to call this 
routine in order to get any mouse input at all, regardless of whether the 
current driver actually needs to be polled or not. 
.SH "RETURN VALUE"
Returns zero on success, or a negative number on failure (ie. no mouse 
driver installed).

.SH SEE ALSO
.BR mouse_needs_poll (3alleg4),
.BR install_mouse (3alleg4),
.BR mouse_x (3alleg4),
.BR exlights (3alleg4),
.BR exmouse (3alleg4),
.BR exshade (3alleg4),
.BR exspline (3alleg4),
.BR extrans (3alleg4)