Man page - sdl_getgamepadaxis(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_GetGamepadAxis

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
AVAILABILITY
SEE ALSO

NAME

SDL_GetGamepadAxis - Get the current state of an axis control on a gamepad.

HEADER FILE

Defined in SDL3/SDL_gamepad.h

SYNOPSIS

#include "SDL3/SDL.h"

Sint16 SDL_GetGamepadAxis(SDL_Gamepad *gamepad, SDL_GamepadAxis axis);

DESCRIPTION

The axis indices start at index 0.

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

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

FUNCTION PARAMETERS

gamepad

a gamepad.

axis

an axis index (one of the SDL_GamepadAxis

values).

RETURN VALUE

( Sint16 ) Returns axis state (including 0) on success or 0 (also) on failure; call SDL_GetError () for more information.

AVAILABILITY

This function is available since SDL 3.2.0.