devela::_dep::sdl3::sys::everything

Function SDL_SetJoystickVirtualBall

pub unsafe extern "C" fn SDL_SetJoystickVirtualBall(
    joystick: *mut SDL_Joystick,
    ball: i32,
    xrel: i16,
    yrel: i16,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Generate ball motion on an opened virtual joystick.

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

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

§Availability

This function is available since SDL 3.2.0.