.\" 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_HapticRunEffect:
.\"   https://wiki.libsdl.org/SDL_HapticRunEffect
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-prerelease-3.0.0-3289-g99f6bcf50
.\" 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_HapticRunEffect
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_HapticRunEffect 3 "SDL 3.0.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_HapticRunEffect \- Run the haptic effect on its associated haptic device\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_HapticRunEffect(SDL_Haptic * haptic,
.BI "                        int effect,
.BI "                        Uint32 iterations);
.fi
.SH DESCRIPTION
To repeat the effect over and over indefinitely, set
.BR iterations
to

.BR
.BR SDL_HAPTIC_INFINITY
\[char46] (Repeats the envelope -
attack and fade\[char46]) To make one instance of the effect last indefinitely (so
the effect does not fade), set the effect's
.BR length
in its structure/union
to 
.BR
.BR SDL_HAPTIC_INFINITY
instead\[char46]

.SH FUNCTION PARAMETERS
.TP
.I haptic
the 
.BR SDL_Haptic
 device to run the effect on
.TP
.I effect
the ID of the haptic effect to run
.TP
.I iterations
the number of iterations to run the effect; use 
.BR
.BR SDL_HAPTIC_INFINITY
to repeat forever
.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_HapticDestroyEffect (3),
.BR SDL_HapticGetEffectStatus (3),
.BR SDL_HapticStopEffect (3)