plucky (3) select_mouse_cursor.3alleg4.gz

NAME

       select_mouse_cursor - Tells Allegro to select software or hardware cursor drawing.

SYNOPSIS

       #include <allegro.h>

       void select_mouse_cursor(int cursor);

DESCRIPTION

       This  function  allows  you  to  use  the operating system's native mouse cursors rather than some custom
       cursor. You will need to enable this functionality by calling enable_hardware_cursor() beforehand. If the
       operating  system  does  not support this functionality, or if it has not been enabled, then Allegro will
       substitute   its   own   cursor   images.    You   can   change    these    substitute    images    using
       set_mouse_cursor_bitmap().

       Note that the effects of this function are not apparent until show_mouse() is called.

       To  know  whether  the  operating  system's  native  cursor  is  being  used,  or  if  Allegro has made a
       substitution, you can check the GFX_SYSTEM_CURSOR flag in gfx_capabilities after calling show_mouse().

       The cursor argument selects the type of cursor to be displayed:

       MOUSE_CURSOR_NONE  Selects  an  invisible  mouse  cursor.  In  that  sense,  it  is  similar  to  calling
       show_mouse(NULL);

       MOUSE_CURSOR_ALLEGRO   Selects   the   custom   Allegro   cursor,   i.e.   the  one  that  you  set  with
       set_mouse_sprite().

       MOUSE_CURSOR_ARROW The operating system default arrow cursor.

       MOUSE_CURSOR_BUSY The operating system default `busy' cursor (hourglass).

       MOUSE_CURSOR_QUESTION The operating system default `question' cursor (arrow with question mark).

       MOUSE_CURSOR_EDIT The operating system default `edit' cursor (vertical bar).

       Example:

          /* initialize mouse sub-system */
          install_mouse();
          enable_hardware_cursor();

          /* Set busy pointer */
          select_mouse_cursor(MOUSE_CURSOR_BUSY);
          show_mouse(screen);

          /* Initialize stuff */
          ...

          /* Set normal arrow pointer */
          select_mouse_cursor(MOUSE_CURSOR_ARROW);

SEE ALSO

       install_mouse(3alleg4),   show_mouse(3alleg4),   set_mouse_sprite(3alleg4),    gfx_capabilities(3alleg4),
       enable_hardware_cursor(3alleg4),        set_mouse_cursor_bitmap(3alleg4),        show_os_cursor(3alleg4),
       exsyscur(3alleg4)