SDL_GetGamepadAxis(3)

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

✨ SDL_GetGamepadAxis ✨

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual 💖 this one's all about grabbing the current state of an axis control on a gamepad. like, where is that stick right now. no cap, it's a good one.

🌸 NAME 🌸

SDL_GetGamepadAxis — get the current state of an axis control on a gamepad. that's the whole vibe 🎮

🦋 SYNOPSIS 🦋

#include <SDL3/SDL_gamepad.h>

Sint16 SDL_GetGamepadAxis(SDL_Gamepad *gamepad, SDL_GamepadAxis axis);

look at her. two args, one Sint16 coming back at you. iconic. 💅

👑 DESCRIPTION 👑

first things first: the axis indices start at index 0. zero-based, as the universe intended. periodt.

for thumbsticks, the state is a value ranging from -32768 (up/left) to 32767 (down/right). so yeah, she swings both ways, literally. 😭

for triggers, it's a whole different story: they range from 0 when released to 32767 when fully pressed, and they never return a negative value. heads up though, because this differs from the value reported by the lower-level SDL_GetJoystickAxis(), which normally uses the full range. so don't be out here comparing them like they're the same thing, because they are NOT. 💀

and okay, the plot twist: for invalid gamepads or axes, this will return 0. but wait — 0 is also a totally valid value in normal operation, where it usually means a centered axis. so yeah, 0 is giving mystery. it could mean "perfectly centered" or "everything is broken," and the function is not gonna tell you which. main character ambiguity. 🙈

🎀 FUNCTION PARAMETERS 🎀

  • gamepad — a gamepad. yes queen, that's the one you're interrogating 🫶
  • axis — an axis index (one of the SDL_GamepadAxis values). pick your fighter.

⭐ RETURN VALUE ⭐

Returns axis state. that's it, that's the tea. 🍓

💜 THREAD SAFETY 💜

It is safe to call this function from any thread. go off, multithreaded legend. 🌈

🔥 AVAILABILITY 🔥

This function is available since SDL 3.2.0. vintage-ish but make it fresh. ✨

🌸 SEE ALSO 🌸

go read those too, iykyk 💅

and that's the whole page, bestie!! this manual page came to you from the lovely humans at Simple Directmedia Layer, and it's rocking SDL 3.4.18 — so if you're on that version, you're golden 💖 thanks for reading, ily, go center that thumbstick 🎀✨🦋

📦 where this page comes from