Mouse routines

Allegro provides functions for reading the mouse state and displaying a mouse cursor on-screen. You can read the absolute position of the mouse and the state of the mouse buttons from global variables. Additionally, you can read the mouse position difference as mouse mickeys, which is the number of pixels the cursor moved since the last time this information was read.

Allegro offers three ways to display the mouse cursor:

Standard Allegro cursor
Allegro is responsible for drawing the mouse cursor from a timer. Use set_mouse_sprite() and show_mouse() to define your own cursor and display it on the screen. You need to call scare_mouse()/unscare_mouse() to hide the mouse cursor whenever you draw to the screen.
Custom operating system cursor (hardware cursor)
Allegro will let the operating system draw the mouse cursor. Use set_mouse_sprite() and show_mouse() (or show_os_cursor) to define your own cursor and display it on the screen. Not all graphics drivers are capable of this and some may only be able to display cursors upto a certain size. Allegro will fall back on its own cursor drawing if it cannot let the OS handle this. On some platforms, the hardware cursor is incompatible with get_mouse_mickeys() and it is therefor disabled by default. In such cases you need to call enable_hardware_cursor() to enable it explicitly.
Default operating system cursor
Allegro will not draw its own cursor, but use the operating system default cursor. You can use the select_mouse_cursor() function to select the cursor shape to display. As with custom operating system cursors, you need to call enable_hardware_cursor() before you can use this. Or you can use the low level show_os_cursor() function.

Not all drivers will support all functionality. See the platform specific information for more details.

install_mouse - Installs the Allegro mouse handler.
remove_mouse - Removes the mouse handler.
poll_mouse - Polls the mouse.
mouse_needs_poll - Tells if the mouse driver requires polling.
enable_hardware_cursor - Enables the OS hardware cursor.
disable_hardware_cursor - Disables the OS hardware cursor.
select_mouse_cursor - Tells Allegro to select software or hardware cursor drawing.
set_mouse_cursor_bitmap - Changes the image Allegro uses for mouse cursors.
mouse_x
mouse_y
mouse_z
mouse_b
mouse_pos - Global variable with the mouse position/button state.
mouse_sprite
mouse_x_focus
mouse_y_focus - Global variable with the mouse sprite and focus point.
show_mouse - Tells Allegro to display a mouse pointer on the screen.
scare_mouse - Helper for hiding the mouse pointer before drawing.
scare_mouse_area - Helper for hiding the mouse cursor before drawing in an area.
unscare_mouse - Undoes the effect of scare_mouse() or scare_mouse_area().
show_os_cursor - Low level function to display the operating system cursor.
freeze_mouse_flag - Flag to avoid redrawing the mouse pointer.
position_mouse - Moves the mouse to the specified screen position.
position_mouse_z - Sets the mouse wheel position global variable.
set_mouse_range - Sets the area of the screen restricting mouse movement.
set_mouse_speed - Sets the mouse speed.
set_mouse_sprite - Sets the mouse sprite.
set_mouse_sprite_focus - Sets the mouse sprite focus.
get_mouse_mickeys - How far the mouse has moved since the last call to this function.
mouse_callback - User specified mouse callback.

Allegro Manual

API

Mouse routines