.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_RumbleJoystick:
.\"   https://wiki.libsdl.org/SDL_RumbleJoystick
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_RumbleJoystick
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_RumbleJoystick 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_RumbleJoystick \- Start a rumble effect\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_RumbleJoystick(SDL_Joystick *joystick, Uint16 low_frequency_rumble, Uint16 high_frequency_rumble, Uint32 duration_ms);
.fi
.SH DESCRIPTION
Each call to this function cancels any previous rumble effect, and calling
it with 0 intensity stops any rumbling\[char46]

This function requires you to process SDL events or call

.BR SDL_UpdateJoysticks
() to update rumble state\[char46]

.SH FUNCTION PARAMETERS
.TP
.I joystick
The joystick to vibrate
.TP
.I low_frequency_rumble
The intensity of the low frequency (left) rumble motor, from 0 to 0xFFFF
.TP
.I high_frequency_rumble
The intensity of the high frequency (right) rumble motor, from 0 to 0xFFFF
.TP
.I duration_ms
The duration of the rumble effect, in milliseconds
.SH RETURN VALUE
Returns 0, or -1 if rumble isn't supported on this joystick

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]