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 \[aq]shown\[aq] (as opposed to \[aq]hidden\[aq]) the change is immediately visible.

If the cursor doesn\[aq]t exist on the current platform another cursor will be silently be substituted.

The cursors are:

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_DEFAULT

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_ARROW

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_BUSY

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_QUESTION

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_EDIT

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_MOVE

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_N

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_W

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_S

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_E

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_NW

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_SW

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_SE

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_NE

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_PROGRESS

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_PRECISION

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_LINK

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_ALT_SELECT

\[bu]

ALLEGRO_SYSTEM_MOUSE_CURSOR_UNAVAILABLE

Returns true on success, false on failure.

RELATED TO al_set_system_mouse_cursor…

al_set_mouse_cursor(3alleg5), al_show_mouse_cursor(3alleg5), al_hide_mouse_cursor(3alleg5)