.\" 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_PlayHapticRumble:
.\"   https://wiki.libsdl.org/SDL_PlayHapticRumble
.\" 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_PlayHapticRumble
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_PlayHapticRumble 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_PlayHapticRumble \- Run a simple rumble effect on a haptic device\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_PlayHapticRumble(SDL_Haptic *haptic, float strength, Uint32 length);
.fi
.SH FUNCTION PARAMETERS
.TP
.I haptic
the haptic device to play the rumble effect on
.TP
.I strength
strength of the rumble to play as a 0-1 float value
.TP
.I length
length of the rumble to play in milliseconds
.SH RETURN VALUE
Returns 0 on success or a negative error code on failure; call

.BR SDL_GetError
() for more information\[char46]

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

.SH SEE ALSO
.BR SDL_InitHapticRumble (3),
.BR SDL_StopHapticRumble (3)