.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_GetGamepadAxis:
.\"   https://wiki.libsdl.org/SDL_GetGamepadAxis
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_GetGamepadAxis
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetGamepadAxis 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetGamepadAxis \- Get the current state of an axis control on a gamepad\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "Sint16 SDL_GetGamepadAxis(SDL_Gamepad *gamepad, SDL_GamepadAxis axis);
.fi
.SH DESCRIPTION
The axis indices start at index 0\[char46]

For thumbsticks, the state is a value ranging from -32768 (up/left) to
32767 (down/right)\[char46]

Triggers range from 0 when released to 32767 when fully pressed, and never
return a negative value\[char46] Note that this differs from the value reported by
the lower-level 
.BR SDL_GetJoystickAxis
(), which
normally uses the full range\[char46]

.SH FUNCTION PARAMETERS
.TP
.I gamepad
a gamepad
.TP
.I axis
an axis index (one of the 
.BR SDL_GamepadAxis
 values)
.SH RETURN VALUE
Returns axis state (including 0) on success or 0 (also) on failure; call

.BR SDL_GetError
() for more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_GamepadHasAxis (3),
.BR SDL_GetGamepadButton (3)