.\" Automatically generated by Pandoc 2.17.1.1
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "al_play_haptic_effect" "3alleg5" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_play_haptic_effect - Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <allegro5/allegro.h>

bool al_play_haptic_effect(ALLEGRO_HAPTIC_EFFECT_ID *id, int loop)
\f[R]
.fi
.SH DESCRIPTION
.PP
Plays back a previously uploaded haptic effect.
The play_id must be a valid ALLEGRO_HAPTIC_EFFECT_ID(3alleg5) obtained
from al_upload_haptic_effect(3alleg5),
al_upload_and_play_haptic_effect(3alleg5) or al_rumble_haptic(3alleg5).
.PP
The haptic effect will be played back loop times in sequence.
If loop is less than or equal to 1, then the effect will be played once
only.
.PP
This function returns immediately and doesn\[cq]t wait for the playback
to finish.
It returns true if the playback was started successfully or false if
not.
.SH SINCE
.PP
5.1.8
.RS
.PP
\f[I][Unstable API]:\f[R] Perhaps could be simplified due to limited
support for all the exposed features across all of the platforms.
Awaiting feedback from users.
.RE