1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
.TH al_set_system_mouse_cursor 3 "" "Allegro reference manual"
.SH NAME
.PP
al_set_system_mouse_cursor \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>
bool\ al_set_system_mouse_cursor(ALLEGRO_DISPLAY\ *display,
\ \ \ ALLEGRO_SYSTEM_MOUSE_CURSOR\ cursor_id)
\f[]
.fi
.SH DESCRIPTION
.PP
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.
.PP
If the cursor doesn\[aq]t exist on the current platform another cursor
will be silently be substituted.
.PP
The cursors are:
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_DEFAULT
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_ARROW
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_BUSY
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_QUESTION
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_EDIT
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_MOVE
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_N
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_W
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_S
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_E
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_NW
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_SW
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_SE
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_RESIZE_NE
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_PROGRESS
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_PRECISION
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_LINK
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_ALT_SELECT
.IP \[bu] 2
ALLEGRO_SYSTEM_MOUSE_CURSOR_UNAVAILABLE
.PP
Returns true on success, false on failure.
.SH SEE ALSO
.PP
al_set_mouse_cursor(3), al_show_mouse_cursor(3), al_hide_mouse_cursor(3)
|
