(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetJoystickHat

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

Syntax

Uint8 SDL_GetJoystickHat(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 3.0.0.


CategoryAPI