SDL_SetJoystickVirtualHat(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

✨ SDL_SetJoystickVirtualHat ✨

okay so bestie, welcome to the SDL3 FUNCTIONS manual, and today's main character is SDL_SetJoystickVirtualHat(3) 💅 she sets the state of a hat on an opened virtual joystick, and honestly? she eats.

🎀 NAME 🎀

SDL_SetJoystickVirtualHat — set the state of a hat on an opened virtual joystick. no cap, that's literally the whole job description 🫶

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_joystick.h>

bool SDL_SetJoystickVirtualHat(SDL_Joystick *joystick, int hat, Uint8 value);

🦋 DESCRIPTION 🦋

okay so here's the tea, and it's important tea ☕ — the values you set here do NOT get applied right away. they're just vibing in limbo until the next call to SDL_UpdateJoysticks. and that call can happen either:

  • directly, by you calling it yourself, or
  • indirectly, through various other SDL APIs, including — but not limited to — SDL_PollEvent, SDL_PumpEvents, SDL_WaitEventTimeout, and SDL_WaitEvent.

so like. it's giving "queued up, pending, waiting for her moment" 💅 the hat state is not real until the update happens. periodt.

💖 FUNCTION PARAMETERS 💖

  • joystick — the virtual joystick on which to set state. your girl. the one you're messing with 🎮
  • hat — the index of the hat on the virtual joystick to update. yes, an index, so you gotta know which hat you mean 👑
  • value — the new value for the specified hat. the fresh fit you're dressing it in ✨

🌈 RETURN VALUE 🌈

returns true on success, or false on failure 😭 and if it fails, hit up SDL_GetError() for more information — she will tell you what went wrong, fr fr.

🔥 THREAD SAFETY 🔥

it is safe to call this function from any thread. multithreaded besties, you are SO valid 🫶 no locks, no drama, no stress.

⭐ AVAILABILITY ⭐

this function is available since SDL 3.2.0. if you're on anything older, she simply does not exist yet, sorry babe 🙈

👑 SEE ALSO 👑

the whole virtual-joystick friend group, all iconic, all linked:

quick vibe check 💀 remember: set the hat, then call SDL_UpdateJoysticks (or one of the event functions) or it's giving nothing. the hat does not exist until you do.

and that's a wrap on our girl 🌸 this page comes to you from Simple Directmedia Layer, version SDL 3.4.18, and the date stamped on it — mwah, chef's kiss 🎀 go forth, set your hats, and slay 💅✨🦋

📦 where this page comes from