docs/man3/SDL_JoystickGetHat.3
author Sam Lantinga <slouken@libsdl.org>
Wed, 08 Mar 2006 18:30:12 +0000
changeset 1486 9d77fc9d0ace
parent 181 e5bc29de3f0a
child 2283 546f7c1eb755
permissions -rw-r--r--
Re-added C runtime support for Visual C++ 5,6
slouken@181
     1
.TH "SDL_JoystickGetHat" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
slouken@0
     2
.SH "NAME"
slouken@0
     3
SDL_JoystickGetHat\- Get the current state of a joystick hat
slouken@0
     4
.SH "SYNOPSIS"
slouken@0
     5
.PP
slouken@0
     6
\fB#include "SDL\&.h"
slouken@0
     7
.sp
slouken@0
     8
\fBUint8 \fBSDL_JoystickGetHat\fP\fR(\fBSDL_Joystick *joystick, int hat\fR);
slouken@0
     9
.SH "DESCRIPTION"
slouken@0
    10
.PP
slouken@0
    11
SDL_JoystickGetHat returns the current state of the given \fBhat\fR on the given \fBjoystick\fR\&.
slouken@0
    12
.SH "RETURN VALUE"
slouken@0
    13
.PP
slouken@0
    14
The current state is returned as a Uint8 which is defined as an OR\&'d combination of one or more of the following
slouken@0
    15
.IP "" 10
slouken@0
    16
\fBSDL_HAT_CENTERED\fP
slouken@0
    17
.IP "" 10
slouken@0
    18
\fBSDL_HAT_UP\fP
slouken@0
    19
.IP "" 10
slouken@0
    20
\fBSDL_HAT_RIGHT\fP
slouken@0
    21
.IP "" 10
slouken@0
    22
\fBSDL_HAT_DOWN\fP
slouken@0
    23
.IP "" 10
slouken@0
    24
\fBSDL_HAT_LEFT\fP
slouken@0
    25
.IP "" 10
slouken@0
    26
\fBSDL_HAT_RIGHTUP\fP
slouken@0
    27
.IP "" 10
slouken@0
    28
\fBSDL_HAT_RIGHTDOWN\fP
slouken@0
    29
.IP "" 10
slouken@0
    30
\fBSDL_HAT_LEFTUP\fP
slouken@0
    31
.IP "" 10
slouken@0
    32
\fBSDL_HAT_LEFTDOWN\fP
slouken@0
    33
.SH "SEE ALSO"
slouken@0
    34
.PP
slouken@0
    35
\fI\fBSDL_JoystickNumHats\fP\fR
slouken@181
    36
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00