devela::_dep::sdl3::sys::joystick

Function SDL_RumbleJoystick

pub unsafe extern "C" fn SDL_RumbleJoystick(
    joystick: *mut SDL_Joystick,
    low_frequency_rumble: u16,
    high_frequency_rumble: u16,
    duration_ms: u32,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Start a rumble effect.

Each call to this function cancels any previous rumble effect, and calling it with 0 intensity stops any rumbling.

This function requires you to process SDL events or call SDL_UpdateJoysticks() to update rumble state.

§Parameters

  • joystick: the joystick to vibrate.
  • low_frequency_rumble: the intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF.
  • high_frequency_rumble: the intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF.
  • duration_ms: the duration of the rumble effect, in milliseconds.

§Return value

Returns true, or false if rumble isn’t supported on this joystick.

§Availability

This function is available since SDL 3.2.0.