(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable 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

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 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

Version

This function is available since SDL 2.0.0.

See Also

• SDL_JoystickNumHats

---

CategoryAPI, CategoryAPIFunction, CategoryJoystick

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.