


install_mouse(3)          Allegro manual         install_mouse(3)


NNAAMMEE
       install_mouse - Installs the Allegro mouse handler.

SSYYNNOOPPSSIISS
       ##iinncclluuddee <<aalllleeggrroo..hh>>


       iinntt iinnssttaallll__mmoouussee(());;

DDEESSCCRRIIPPTTIIOONN
       Installs  the  Allegro mouse handler. You must do this before using any
       other mouse functions.

RREETTUURRNN VVAALLUUEE
       Returns -1 on failure, zero if the mouse handler is  already  installed
       (in which case this function does nothing) and the number of buttons on
       the mouse if the mouse handler has  successfully  been  installed  (ie.
       this  is  the first time a handler is installed or you have removed the
       previous one).

       Note that the number of mouse buttons returned by this function is more
       an  indication  than  a physical reality. With most devices there is no
       way of telling how many buttons there are, and any  user  can  override
       the  number  of  mouse  buttons returned by this function with a custom
       configuration file and the variable num_buttons. Even if this value  is
       overridden  by  the  user, the global mouse variables will still report
       whatever the hardware is sending.


SSEEEE AALLSSOO
       rreemmoovvee__mmoouussee(3),     ppoollll__mmoouussee(3),     mmoouussee__xx(3),      sshhooww__mmoouussee(3),
       ggeett__mmoouussee__mmiicckkeeyyss(3),       ppoossiittiioonn__mmoouussee(3),      sseett__mmoouussee__rraannggee(3),
       sseett__mmoouussee__ssppeeeedd(3)
























Allegro                   version 4.2.3                         1


