File: al_install_haptic.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 (39 lines) | stat: -rw-r--r-- 1,129 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
39
.TH "al_install_haptic" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_install_haptic \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>

bool\ al_install_haptic(void)
\f[]
.fi
.SH DESCRIPTION
.PP
Installs the haptic (force feedback) device subsystem.
This must be called before using any other haptic\-related functions.
Returns true if the haptics subsystem could be initialized correctly,
false in case of error.
.PP
For portability you should first open a display before calling
al_install_haptic(3).
On some platforms, such as DirectInput under Windows,
al_install_haptic(3) will only work if at least one active display is
available.
This display must stay available until al_uninstall_haptic(3) is called.
.PP
If you need to close and reopen your active display for example, then
you should call al_uninstall_haptic(3) before closing the display, and
al_install_haptic(3) after opening it again.
.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