NAME

SDL_GetJoystickBall - Get the ball axis change since the last poll.

SYNOPSIS

#include <SDL3/SDL_joystick.h>

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

DESCRIPTION

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.

FUNCTION PARAMETERS

joystick

the SDL_Joystick to query.

ball

the ball index to query; ball indices start at index 0.

dx

stores the difference in the x axis position since the last poll.

dy

stores the difference in the y axis position since the last poll.

RETURN VALUE

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

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL 3.2.0.

SEE ALSO

SDL_GetNumJoystickBalls(3)