SDL_GetJoystickHat(3)

SDL_GetJoystickHat3

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

Usage

#include "SDL3/SDL.h"

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)

Header file

Defined in SDL3/SDL_joystick.h

Overview

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

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.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.