SDL_GetGamepads(3)

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

💖 SDL_GetGamepads 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the man pages, this one's SDL_GetGamepads(3) and she's literally so useful 🎮✨

🌸 NAME 🌸

SDL_GetGamepads — get a list of currently connected gamepads.

like, all of them. every single controller plugged in / paired / vibing nearby. it's giving census day for gamepads 🫶

✨ SYNOPSIS ✨

#include <SDL3/SDL_gamepad.h>

SDL_JoystickID * SDL_GetGamepads(int *count);

🎀 FUNCTION PARAMETERS 🎀

  • count — a pointer that gets filled in with the number of gamepads returned. it may be NULL if you truly don't care how many there are, no pressure bestie 💅

🦋 RETURN VALUE 🦋

returns a 0 terminated array of joystick instance IDs, or NULL on failure. if it's NULL, go call SDL_GetError() for the tea ☕ — she'll tell you what went wrong.

important!! when you're done with that array, free it with SDL_free(). don't just leave it hanging, that's not the vibe, that's a leak 😭

🌈 THREAD SAFETY 🌈

it is safe to call this function from any thread. yes, any. go wild, main character energy, no locks required 🔥

⭐ AVAILABILITY ⭐

this function is available since SDL 3.2.0. if you're on something older, she simply doesn't exist yet, sorry babe 💀

👑 SEE ALSO 👑

and that's the whole page, bestie, you ate that 🍓

signing off with the receipts: this one comes from Simple Directmedia Layer, version SDL 3.4.18, and it's the SDL_GetGamepads(3) page. go forth and enumerate those controllers 💜🧚

📦 where this page comes from