1show_os_cursor(3)               Allegro manual               show_os_cursor(3)
2
3
4

NAME

6       show_os_cursor  -  Low  level  function to display the operating system
7       cursor. Allegro game programming library.
8

SYNOPSIS

10       #include <allegro.h>
11
12
13       int show_os_cursor(int cursor);
14

DESCRIPTION

16       In case you do not need Allegro's mouse cursor API, which automatically
17       emulates  a cursor in software if no other cursor is available, you can
18       use this low level function to try to display or hide the system cursor
19       directly.   The   cursor   parameter   takes   the   same   values   as
20       select_mouse_cursor.  This  function  is  very   similar   to   calling
21       enable_hardware_cursor,  select_mouse_cursor  and  show_mouse, but will
22       not try to do anything if no system cursor is available.
23
24       The most common use for this function is to just call it  once  at  the
25       beginning of the program to tell it to display the system cursor inside
26       the Allegro window. The return value can be used to see  if  this  suc‐
27       ceeded  or  not.  On some systems (e.g. DirectX fullscreen) this is not
28       supported and the function will always fail, and in  other  cases  only
29       some  of the cursors will work, or in the case of MOUSE_CURSOR_ALLEGRO,
30       only certain bitmap sizes may be supported.
31
32       You  never  should  use  show_os_cursor  together  with  the   function
33       show_mouse  and  other  functions  affecting  it  (select_mouse_cursor,
34       enable_hardware_cursor,      disable_hardware_cursor,      scare_mouse,
35       unscare_mouse).  They  implement the standard high level mouse API, and
36       don't work together with this low level function.
37

RETURN VALUE

39       Returns 0 if a system cursor is  being  displayed  after  the  function
40       returns, or -1 otherwise.
41
42

SEE ALSO

44       show_mouse(3), set_mouse_cursor_bitmap(3), select_mouse_cursor(3)
45
46
47
48Allegro                          version 4.4.2               show_os_cursor(3)
Impressum