DragonFly On-Line Manual Pages

al_set_system_mouse_cursor(3)                    al_set_system_mouse_cursor(3)

NAME
       al_set_system_mouse_cursor - Allegro 5 API

SYNOPSIS

              #include <allegro5/allegro.h>

              bool al_set_system_mouse_cursor(ALLEGRO_DISPLAY *display,
                 ALLEGRO_SYSTEM_MOUSE_CURSOR cursor_id)

DESCRIPTION
       Set the given system mouse cursor to be the current mouse cursor for
       the given display.  If the cursor is currently 'shown' (as opposed to
       'hidden') the change is immediately visible.

       If the cursor doesn't exist on the current platform another cursor will
       be silently be substituted.

       The cursors are:

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_DEFAULT

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_ARROW

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_BUSY

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_QUESTION

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_EDIT

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_MOVE

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_N

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_W

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_S

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_E

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_NW

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_SW

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_SE

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_NE

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_PROGRESS

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_PRECISION

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_LINK

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_ALT_SELECT

       o ALLEGRO_SYSTEM_MOUSE_CURSOR_UNAVAILABLE

       Returns true on success, false on failure.

SEE ALSO
       al_set_mouse_cursor(3), al_show_mouse_cursor(3),
       al_hide_mouse_cursor(3)

Allegro reference manual                         al_set_system_mouse_cursor(3)