File: al_stop_haptic_effect.3

package info (click to toggle)
allegro5 2%3A5.2.2-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,032 kB
  • sloc: ansic: 120,340; cpp: 15,707; objc: 4,805; python: 2,915; java: 2,195; sh: 887; xml: 86; makefile: 49; perl: 37; pascal: 24
file content (28 lines) | stat: -rw-r--r-- 669 bytes parent folder | download
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
.TH "al_stop_haptic_effect" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_stop_haptic_effect \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_stop_haptic_effect(ALLEGRO_HAPTIC_EFFECT_ID\ *id)
\f[]
.fi
.SH DESCRIPTION
.PP
Stops playing 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).
.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