.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_GetJoystickHat:
.\"   https://wiki.libsdl.org/SDL_GetJoystickHat
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_GetJoystickHat
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetJoystickHat 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetJoystickHat \- Get the current state of a POV hat on a joystick\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "Uint8 SDL_GetJoystickHat(SDL_Joystick *joystick, int hat);
.fi
.SH DESCRIPTION
The returned value will be one of the following positions:


\(bu 
.BR
.BR SDL_HAT_CENTERED

\(bu 
.BR
.BR SDL_HAT_UP

\(bu 
.BR
.BR SDL_HAT_RIGHT

\(bu 
.BR
.BR SDL_HAT_DOWN

\(bu 
.BR
.BR SDL_HAT_LEFT

\(bu 
.BR
.BR SDL_HAT_RIGHTUP

\(bu 
.BR
.BR SDL_HAT_RIGHTDOWN

\(bu 
.BR
.BR SDL_HAT_LEFTUP

\(bu 
.BR
.BR SDL_HAT_LEFTDOWN

.SH FUNCTION PARAMETERS
.TP
.I joystick
an 
.BR SDL_Joystick
 structure containing joystick information
.TP
.I hat
the hat index to get the state from; indices start at index 0
.SH RETURN VALUE
Returns the current hat position\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_GetNumJoystickHats (3)