(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetJoystickBall

Get the ball axis change since the last poll.

Header File

Defined in <SDL3/SDL_joystick.h>

Syntax

bool SDL_GetJoystickBall(SDL_Joystick *joystick, int ball, int *dx, int *dy);

Function Parameters

SDL_Joystick *	joystick	the SDL_Joystick to query.
int	ball	the ball index to query; ball indices start at index 0.
int *	dx	stores the difference in the x axis position since the last poll.
int *	dy	stores the difference in the y axis position since the last poll.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

Trackballs can only return relative motion since the last call to SDL_GetJoystickBall(), these motion deltas are placed into dx and dy.

Most joysticks do not have trackballs.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetNumJoystickBalls

---

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.