Initial bulk commit for "Git on MSys"
[msysgit/historical-msysgit.git] / mingw / man / man3 / SDL_JoystickGetHat.3
blobd133041705a6ec511bdea166db6eb515da394a72
1 .TH "SDL_JoystickGetHat" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
2 .SH "NAME"
3 SDL_JoystickGetHat\- Get the current state of a joystick hat
4 .SH "SYNOPSIS"
5 .PP
6 \fB#include "SDL\&.h"
7 .sp
8 \fBUint8 \fBSDL_JoystickGetHat\fP\fR(\fBSDL_Joystick *joystick, int hat\fR);
9 .SH "DESCRIPTION"
10 .PP
11 SDL_JoystickGetHat returns the current state of the given \fBhat\fR on the given \fBjoystick\fR\&.
12 .SH "RETURN VALUE"
13 .PP
14 The current state is returned as a Uint8 which is defined as an OR\&'d combination of one or more of the following
15 .IP "" 10
16 \fBSDL_HAT_CENTERED\fP
17 .IP "" 10
18 \fBSDL_HAT_UP\fP
19 .IP "" 10
20 \fBSDL_HAT_RIGHT\fP
21 .IP "" 10
22 \fBSDL_HAT_DOWN\fP
23 .IP "" 10
24 \fBSDL_HAT_LEFT\fP
25 .IP "" 10
26 \fBSDL_HAT_RIGHTUP\fP
27 .IP "" 10
28 \fBSDL_HAT_RIGHTDOWN\fP
29 .IP "" 10
30 \fBSDL_HAT_LEFTUP\fP
31 .IP "" 10
32 \fBSDL_HAT_LEFTDOWN\fP
33 .SH "SEE ALSO"
34 .PP
35 \fI\fBSDL_JoystickNumHats\fP\fR
36 ...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00