SDL_SetJoystickVirtualButton(3)

💖 SDL_SetJoystickVirtualButton(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS section of the manual, and lemme tell you, this one is a whole vibe. it's all about poking the buttons on a virtual joystick you made yourself. iconic behavior honestly 🎮✨

---

✨ NAME ✨

SDL_SetJoystickVirtualButton — set the state of a button on an opened virtual joystick, fr fr.

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_joystick.h>

bool SDL_SetJoystickVirtualButton(SDL_Joystick *joystick, int button, bool down);

---

🦋 DESCRIPTION 🦋

so like, this function lets you flip a button on a virtual joystick — pressed or not pressed, your call, no cap.

but IMPORTANT, and I cannot stress this enough: the values you set here are not applied until the next call to SDL_UpdateJoysticks. not immediately. not right this second. the next one. 🫠

and SDL_UpdateJoysticks can be called directly, or it can sneak in indirectly through a bunch of other SDL APIs, including but not limited to:

• SDL_PollEvent
• SDL_PumpEvents
• SDL_WaitEventTimeout
• SDL_WaitEvent

so basically you set it, and then something updates it eventually, and that's when the world finds out 💅

---

🎀 FUNCTION PARAMETERS 🎀

• joystick — the virtual joystick on which to set state. this is your joystick, the one you're setting state on, periodt.
• button — the index of the button on the virtual joystick to update. yes, an index, not a name, not a vibe, a number.
• down — true if the button is pressed, false otherwise. that's it, that's the whole boolean, she's simple and she's slaying 🙈

---

⭐ RETURN VALUE ⭐

returns true on success or false on failure. and if it fails? call SDL_GetError() for more information, she'll tell you what went wrong 🥺

---

🧚 THREAD SAFETY 🧚

it is safe to call this function from any thread. any thread. all the threads. every thread. go off, multitasking queen 👑

---

🌈 AVAILABILITY 🌈

this function is available since SDL 3.2.0. so if you're on something older, sorry bestie, no button-setting for you 💀

---

💜 SEE ALSO 💜

• SDL_SetJoystickVirtualAxis(3)
• SDL_SetJoystickVirtualBall(3)
• SDL_SetJoystickVirtualHat(3)
• SDL_SetJoystickVirtualTouchpad(3)
• SDL_SetJoystickVirtualSensorData(3)

---

and that's the whole page babes 🫶 this little love letter to virtual joystick buttons comes to you courtesy of Simple Directmedia Layer, version SDL 3.4.18, and yes she ate and left no crumbs. mwah 💋