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
37
38
39
|
.TH "al_upload_and_play_haptic_effect" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_upload_and_play_haptic_effect \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>
bool\ al_upload_and_play_haptic_effect(ALLEGRO_HAPTIC\ *hap,
\ \ \ ALLEGRO_HAPTIC_EFFECT\ *effect,\ ALLEGRO_HAPTIC_EFFECT_ID\ *id,\ int\ loop)
\f[]
.fi
.SH DESCRIPTION
.PP
Uploads the haptic effect to the device and starts playback immediately.
Returns true if the upload and playback were successful, false if either
failed.
.PP
In case false is returned, the haptic effect will be automatically
released as if al_release_haptic_effect(3) had been called, so there is
no need to call it again manually in this case.
However, if true is returned, it is necessary to call
al_release_haptic_effect(3) when the effect isn\[aq]t needed anymore, to
prevent the amount of available effects on the haptic devicefrom running
out.
.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
.SH SEE ALSO
.PP
al_upload_haptic_effect(3), al_play_haptic_effect(3)
|
