---
name: "SDL_RumbleJoystick"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_RumbleJoystick"
---

# SDL\_RumbleJoystick(3)

Start a rumble effect.

## NAME

SDL\_RumbleJoystick - Start a rumble effect.

## HEADER FILE

Defined in SDL3/SDL\_joystick.h

## SYNOPSIS

```
#include "SDL3/SDL.h"
```

**bool SDL\_RumbleJoystick(SDL\_Joystick \*joystick, Uint16 low\_frequency\_rumble, Uint16 high\_frequency\_rumble, Uint32 duration\_ms);**

## DESCRIPTION

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.

## FUNCTION 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.