File: al_release_haptic.3

package info (click to toggle)
allegro5 2%3A5.2.6.0-3%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 24,212 kB
  • sloc: ansic: 125,319; cpp: 15,781; objc: 4,579; python: 2,802; java: 2,254; javascript: 1,204; sh: 1,002; makefile: 51; perl: 37; xml: 25; pascal: 24
file content (38 lines) | stat: -rw-r--r-- 1,035 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
29
30
31
32
33
34
35
36
37
38
.\" Automatically generated by Pandoc 1.19.2.4
.\"
.TH "al_release_haptic" "3" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_release_haptic \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_release_haptic(ALLEGRO_HAPTIC\ *haptic)
\f[]
.fi
.SH DESCRIPTION
.PP
Releases the haptic device and its resources when it\[aq]s not needed
anymore.
Should also be used in case the joystick configuration changed, such as
when a joystick is hot plugged.
This function also automatically releases all haptic effects that are
still uploaded to the device and that have not been released manually
using al_release_haptic_effect(3).
.PP
Returns true on success or false if the haptic device couldn\[aq]t be
released for any reason, such as NULL being passed, the device not being
active or failure in the driver.
.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