Provided by: allegro4-doc_4.4.3.1-4.1build3_all bug

NAME

       poll_mouse - Polls the mouse. Allegro game programming library.

SYNOPSIS

       #include <allegro.h>

       int poll_mouse();

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.

RETURN VALUE

       Returns zero on success, or a negative number on failure (ie. no mouse driver installed).

SEE ALSO

       mouse_needs_poll(3alleg4), install_mouse(3alleg4), mouse_x(3alleg4), exlights(3alleg4), exmouse(3alleg4),
       exshade(3alleg4), exspline(3alleg4), extrans(3alleg4)