1install_mouse(3) Allegro manual install_mouse(3)
2
3
4
6 install_mouse - Installs the Allegro mouse handler.
7
9 #include <allegro.h>
10
11
12 int install_mouse();
13
15 Installs the Allegro mouse handler. You must do this before using any
16 other mouse functions.
17
19 Returns -1 on failure, zero if the mouse handler is already installed
20 (in which case this function does nothing) and the number of buttons on
21 the mouse if the mouse handler has successfully been installed (ie.
22 this is the first time a handler is installed or you have removed the
23 previous one).
24
25 Note that the number of mouse buttons returned by this function is more
26 an indication than a physical reality. With most devices there is no
27 way of telling how many buttons there are, and any user can override
28 the number of mouse buttons returned by this function with a custom
29 configuration file and the variable num_buttons. Even if this value is
30 overridden by the user, the global mouse variables will still report
31 whatever the hardware is sending.
32
33
35 remove_mouse(3), poll_mouse(3), mouse_x(3), show_mouse(3),
36 get_mouse_mickeys(3), position_mouse(3), set_mouse_range(3),
37 set_mouse_speed(3)
38
39
40
41Allegro version 4.2.2 install_mouse(3)