SDL_JoyHatEvent(3)

✨ SDL_JoyHatEvent ✨

okay bestie, this is a page from the SDL API Reference — it's SDL_JoyHatEvent(3), and it's literally the manual for the little struct that tells you when someone yanks a hat around on a joystick. yes. a hat. on a joystick. we love a retro peripheral moment 🎩💖

---

🎀 NAME 🎀

SDL_JoyHatEvent — the joystick hat position change event structure. that's it, that's the whole name, she's straightforward and we respect her 🫶

---

🧚 STRUCTURE DEFINITION 🧚

here's the whole fit, no cap:

typedef struct{
  Uint8 type;
  Uint8 which;
  Uint8 hat;
  Uint8 value;
} SDL_JoyHatEvent;

four Uint8s and a dream 💅

---

🌸 STRUCTURE DATA 🌸

• type — it's SDL_JOY 👑
• which — the joystick device index (which joystick is doing all this)
• hat — the joystick hat index (which hat on that joystick)
• value — the hat position

---

💖 DESCRIPTION 💖

so SDL_JoyHatEvent is a member of the SDL_Event union, and it's the one that shows up when an event of type SDL_JOYHATMOTION gets reported. main character energy fr fr ✨

an SDL_JOYHATMOTION event happens whenevs a user moves a hat on the joystick. the field which is the index of the joystick that reported the event, and hat is the index of the hat (for a way more detailed explanation, go peek at the Joystick section — iykyk). and value is the current position of the hat.

now value is a logically OR'd combination of these following values, and honestly their meanings should be pretty obvious 😌:

• SDL_HAT_CENTERED
• SDL_HAT_UP
• SDL_HAT_RIGHT
• SDL_HAT_DOWN
• SDL_HAT_LEFT

and these defines are also provided (the diagonal girlies 🌈):

• SDL_HAT_RIGHTUP
• SDL_HAT_RIGHTDOWN
• SDL_HAT_LEFTUP
• SDL_HAT_LEFTDOWN

---

👑 SEE ALSO 👑

• SDL_Event
• Joystick Functions
• SDL_JoystickEventState
• SDL_JoystickGetHat

---

and that's the whole page, bestie — go read up on your hats, periodt 🎀✨

this was SDL, and the page is dated Tue 11 Sep 2001, 22:59 — a true vintage icon, we stan a timestamp 💜🦋