File: al_get_mouse_state.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 (41 lines) | stat: -rw-r--r-- 896 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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
.TH al_get_mouse_state 3 "" "Allegro reference manual"
.SH NAME
.PP
al_get_mouse_state \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

void\ al_get_mouse_state(ALLEGRO_MOUSE_STATE\ *ret_state)
\f[]
.fi
.SH DESCRIPTION
.PP
Save the state of the mouse specified at the time the function is called
into the given structure.
.PP
Example:
.IP
.nf
\f[C]
ALLEGRO_MOUSE_STATE\ state;

al_get_mouse_state(&state);
if\ (state.buttons\ &\ 1)\ {
\ \ \ \ /*\ Primary\ (e.g.\ left)\ mouse\ button\ is\ held.\ */
\ \ \ \ printf("Mouse\ position:\ (%d,\ %d)\\n",\ state.x,\ state.y);
}
if\ (state.buttons\ &\ 2)\ {
\ \ \ \ /*\ Secondary\ (e.g.\ right)\ mouse\ button\ is\ held.\ */
}
if\ (state.buttons\ &\ 4)\ {
\ \ \ \ /*\ Tertiary\ (e.g.\ middle)\ mouse\ button\ is\ held.\ */
}
\f[]
.fi
.SH SEE ALSO
.PP
ALLEGRO_MOUSE_STATE(3), al_get_mouse_state_axis(3),
al_mouse_button_down(3)