SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Get the ball axis change since the last poll.

Header File

Defined in <SDL3/SDL_joystick.h>


int 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

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.


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.


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryJoystick

[ edit | delete | history | feedback | raw ]

[ 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.