File: al_set_mouse_cursor.3

package info (click to toggle)
allegro5 2%3A5.0.10-3
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 14,856 kB
  • ctags: 15,948
  • sloc: ansic: 87,540; cpp: 9,693; objc: 3,491; python: 2,057; sh: 829; makefile: 93; perl: 37; pascal: 24
file content (26 lines) | stat: -rw-r--r-- 619 bytes parent folder | download
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
.TH al_set_mouse_cursor 3 "" "Allegro reference manual"
.SH NAME
.PP
al_set_mouse_cursor \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_set_mouse_cursor(ALLEGRO_DISPLAY\ *display,\ ALLEGRO_MOUSE_CURSOR\ *cursor)
\f[]
.fi
.SH DESCRIPTION
.PP
Set the given mouse cursor to be the current mouse cursor for the given
display.
.PP
If the cursor is currently \[aq]shown\[aq] (as opposed to
\[aq]hidden\[aq]) the change is immediately visible.
.PP
Returns true on success, false on failure.
.SH SEE ALSO
.PP
al_set_system_mouse_cursor(3), al_show_mouse_cursor(3),
al_hide_mouse_cursor(3)