SDL_GetGamepadJoystick(3)

✨ SDL_GetGamepadJoystick ✨

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual 💖 this one's called SDL_GetGamepadJoystick and honestly? it's giving "backstage pass to your gamepad's inner joystick" 🎀

---

🦋 NAME 🦋

SDL_GetGamepadJoystick — get the underlying joystick from a gamepad 💅

like, the joystick that's literally inside your gamepad. the whole vibe. no cap.

---

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_gamepad.h>

SDL_Joystick * SDL_GetGamepadJoystick(SDL_Gamepad *gamepad);

that's it. one include, one call, one slay 🫶

---

💖 DESCRIPTION 💖

so the way that this works is: this function hands you back an SDL_Joystick object, which means you can use all the SDL_Joystick functions on a thing that's actually an SDL_Gamepad 😭✨ iconic crossover event fr fr.

why would you even want that? because it's lowkey useful for grabbing a joystick's position at any given moment — even if it hasn't moved at all. like, key detail: if you were just waiting for events, a joystick that never moves never produces one. and moving it is what would produce an event, which is what would carry the axis' value. so if you want the position right now, no movement required, this is your girl 💅

🚨 okay now the important part, listen up bestie 🚨 The pointer you get back is owned by the SDL_Gamepad. You should not call SDL_CloseJoystick() on it, for example — because doing so will likely cause SDL to crash. 💀 do not do it. not even once. the gamepad owns it, you're just borrowing it, it's giving library book not gift 🎀

---

🍓 FUNCTION PARAMETERS 🍓

• gamepad — the gamepad object that you want to get a joystick from. yeah. that one. the gamepad. the one you have 🫶

---

👑 RETURN VALUE 👑

Returns an SDL_Joystick object, or NULL on failure 🌈

if you get NULL? bestie, something went wrong. call SDL_GetError() for more information, she'll tell you what happened 💜

---

🧚 THREAD SAFETY 🧚

It is safe to call this function from any thread. periodt. ✨ go wild, thread girlies 🦋

---

⭐ AVAILABILITY ⭐

This function is available since SDL 3.2.0 🌸 (so if you're on something older, no joystick for you, sorry babe 😭)

---

and that's the whole page, bestie!! go forth and get that joystick, just don't close it 💅

this has been Simple Directmedia Layer, SDL 3.4.18, and it's dated right there in the footer with the rest of the SDL_GetGamepadJoystick(3) energy — mwah, take care of your pointers, ily 🫶💖✨