(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_JoystickNumAxes

Get the number of general axis controls on a joystick.

Header File

Syntax

int SDL_JoystickNumAxes(SDL_Joystick *joystick);

Function Parameters

SDL_Joystick *

joystick

an SDL_Joystick structure containing joystick information.

Return Value

(int) Returns the number of axis controls/number of axes on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

Often, the directional pad on a game controller will either look like 4 separate buttons or a POV hat, and not axes, but all of this is up to the device and platform.

Version

This function is available since SDL 2.0.0.