SDL_SetJoystickVirtualBall - Man Page

Generate ball motion on an opened virtual joystick.

Synopsis

#include <SDL3/SDL_joystick.h>

bool SDL_SetJoystickVirtualBall(SDL_Joystick *joystick, int ball, Sint16 xrel, Sint16 yrel);

Description

Please note that values set here will not be applied until the next call to SDL_UpdateJoysticks, which can either be called directly, or can be called indirectly through various other SDL APIs, including, but not limited to the following: SDL_PollEvent, SDL_PumpEvents, SDL_WaitEventTimeout, SDL_WaitEvent.

Function Parameters

joystick

the virtual joystick on which to set state.

ball

the index of the ball on the virtual joystick to update.

xrel

the relative motion on the X axis.

yrel

the relative motion on the Y axis.

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_SetJoystickVirtualAxis(3), SDL_SetJoystickVirtualButton(3), SDL_SetJoystickVirtualHat(3), SDL_SetJoystickVirtualTouchpad(3), SDL_SetJoystickVirtualSensorData(3)

Referenced By

SDL_AttachVirtualJoystick(3), SDL_SendJoystickVirtualSensorData(3), SDL_SetJoystickVirtualAxis(3), SDL_SetJoystickVirtualButton(3), SDL_SetJoystickVirtualHat(3), SDL_SetJoystickVirtualTouchpad(3).

SDL 3.3.2 Simple Directmedia Layer SDL3 FUNCTIONS