(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetJoystickHat

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

Header File

Syntax

Uint8 SDL_GetJoystickHat(SDL_Joystick *joystick, int hat);


#define SDL_HAT_CENTERED    0x00u
#define SDL_HAT_UP          0x01u
#define SDL_HAT_RIGHT       0x02u
#define SDL_HAT_DOWN        0x04u
#define SDL_HAT_LEFT        0x08u
#define SDL_HAT_RIGHTUP     (SDL_HAT_RIGHT|SDL_HAT_UP)
#define SDL_HAT_RIGHTDOWN   (SDL_HAT_RIGHT|SDL_HAT_DOWN)
#define SDL_HAT_LEFTUP      (SDL_HAT_LEFT|SDL_HAT_UP)
#define SDL_HAT_LEFTDOWN    (SDL_HAT_LEFT|SDL_HAT_DOWN)

Function Parameters

SDL_Joystick *	joystick	an SDL_Joystick structure containing joystick information.
int	hat	the hat index to get the state from; indices start at index 0.

Return Value

(Uint8) Returns the current hat position.

Remarks

The returned value will be one of the SDL_HAT_* values.

Version

This function is available since SDL 3.1.3.

(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetJoystickHat

Header File

Syntax

Function Parameters

Return Value

Remarks

Version

See Also