1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
.TH "al_play_haptic_effect" "3" "" "Allegro reference manual" ""
.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[]
.fi
.SH DESCRIPTION
.PP
Plays back a previously uploaded haptic effect.
The play_id must be a valid ALLEGRO_HAPTIC_EFFECT_ID(3) obtained from
al_upload_haptic_effect(3), al_upload_and_play_haptic_effect(3) or
al_rumble_haptic(3).
.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\[aq]t wait for the playback
to finish.
It returns true if the playback was started sucessfully or false if not.
.SH SINCE
.PP
5.1.8
.RS
.PP
\f[I][Unstable API]:\f[] Perhaps could be simplified due to limited
support for all the exposed features across all of the platforms.
Awaiting feedback from users.
.RE
|
