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

SDL_JoystickGetAxisInitialState

Get the initial state of an axis control on a joystick.

Header File

Defined in SDL_joystick.h

Syntax

SDL_bool SDL_JoystickGetAxisInitialState(SDL_Joystick *joystick,
                           int axis, Sint16 *state);

Function Parameters

SDL_Joystick *	joystick	an SDL_Joystick structure containing joystick information.
int	axis	the axis to query; the axis indices start at index 0.
Sint16 *	state	Upon return, the initial value is supplied here.

Return Value

(SDL_bool) Return SDL_TRUE if this axis has any initial value, or SDL_FALSE if not.

Remarks

The state is a value ranging from -32768 to 32767.

The axis indices start at index 0.

Version

This function is available since SDL 2.0.6.

---

CategoryAPI, CategoryAPIFunction, CategoryJoystick

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.