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

Function SDL_RumbleJoystickTriggers

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

Start a rumble effect in the joystick’s triggers.

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

Note that this is rumbling of the triggers and not the game controller as a whole. This is currently only supported on Xbox One controllers. If you want the (more common) whole-controller rumble, use SDL_RumbleJoystick() instead.

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

§Parameters

  • joystick: the joystick to vibrate.
  • left_rumble: the intensity of the left trigger rumble motor, from 0 to 0xFFFF.
  • right_rumble: the intensity of the right trigger rumble motor, from 0 to 0xFFFF.
  • duration_ms: the duration of the rumble effect, in milliseconds.

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

§See also