#pragma section-numbers off
#pragma disable-camelcase
||<tablewidth="100%" style="color: #FF0000;" :> DRAFT||

= SDL_JoystickGetHat =
Use this function to get the current state of a POV hat on a joystick.

<<TableOfContents()>>

== Syntax ==
{{{#!highlight cpp
Uint8 SDL_JoystickGetHat(SDL_Joystick* joystick,
                         int           hat)
}}}

== Function Parameters ==
||'''joystick'''||an SDL_Joystick structure containing joystick information||
||'''hat'''||the hat index to get the state from; hat indices start at index 0||


== Return Value ==
Returns one of the following positions:
||SDL_HAT_CENTERED||
||SDL_HAT_UP||
||SDL_HAT_RIGHT||
||SDL_HAT_DOWN||
||SDL_HAT_LEFT||
||SDL_HAT_RIGHTUP||
||SDL_HAT_RIGHTDOWN||
||SDL_HAT_LEFTUP||
||SDL_HAT_LEFTDOWN||
/* <<Color2(col=green,text="Should the defines/descriptions for each be included here since the RV is actually a Uint8 or will the user never see those? Should it be a list instead of a table?")>> */

/* <<Color2(col=green,text="Is this alternative table structure better?")>> */
||SDL_HAT_LEFTUP||SDL_HAT_UP||SDL_HAT_RIGHTUP||
||SDL_HAT_LEFT||SDL_HAT_CENTERED||SDL_HAT_RIGHT||
||SDL_HAT_LEFTDOWN||SDL_HAT_DOWN||SDL_HAT_RIGHTDOWN||

== Code Examples ==
{{{#!highlight cpp
You can add your code example here
}}}

== Remarks ==
''You can add useful comments here''

== Related Functions ==
 .[[SDL_JoystickNumHats]]

----
[[CategoryAPI]], [[CategoryJoystick]]