(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)

SDL_JoystickGetHat

Get the current state of a POV hat on a joystick.

Header File

Defined in SDL_joystick.h

Syntax

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; indices start at index 0

Return Value

Returns the current hat position.

Remarks

The returned value will be one of the following positions:

Version

This function is available since SDL 2.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryJoystick