SDL_GetJoystickGUID(3)

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

💖 SDL_GetJoystickGUID(3) 💖

okay bestie, welcome to the SDL3 FUNCTIONS section of the manual — this one's about pulling the ✨vibe fingerprint✨ of a joystick. No cap.

🌸 NAME 🌸

SDL_GetJoystickGUID — get the implementation-dependent GUID for the joystick.

🎀 SYNOPSIS 🎀

#include <SDL3/SDL_joystick.h>

SDL_GUID SDL_GetJoystickGUID(SDL_Joystick *joystick);

🦋 DESCRIPTION 🦋

So basically this function hands you the GUID of a joystick, and it's implementation-dependent, meaning the exact value is whatever the implementation says it is — not us, not you, not the group chat. 🙈

Heads up bestie: this function requires an open joystick. Like, it has to already be opened. You can't just roll up on a closed one. 💅

🌈 FUNCTION PARAMETERS 🌈

  • joystick — the SDL_Joystick you got from SDL_OpenJoystick(). That's the one. That's the source. 🫶

⭐ RETURN VALUE ⭐

Returns the GUID of the given joystick. Iconic. 👑

But — and listen — if you call this on an invalid index, it returns a zero GUID. 😭 Not great, not terrible, just zero. And then you should call SDL_GetError() for more information, because that's where the actual tea is. ☕

🧚 THREAD SAFETY 🧚

It is safe to call this function from any thread. Fr fr. Go off, multithreaded main character. 🔥

💜 AVAILABILITY 💜

This function is available since SDL 3.2.0. 🎀

🌸 SEE ALSO 🌸

and that's the whole page, no skips, no cuts, every single detail preserved because that's just how we do it here 💅✨

k bye, this was brought to you by the fine folks at Simple Directmedia Layer, version SDL 3.4.18 — mwah, slay, go get that GUID 🦋💖

📦 where this page comes from