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
|
.TH "al_set_haptic_gain" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
al_set_haptic_gain \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>
bool\ al_set_haptic_gain(ALLEGRO_HAPTIC\ *hap,\ double\ gain)
\f[]
.fi
.SH DESCRIPTION
.PP
Sets the gain of the haptic device if supported.
Gain is much like volume for sound, it is as if every effect\[aq]s
intensity is multiplied by it.
Gain is a value between 0.0 and 1.0.
Returns true if set sucessfully, false if not.
Only works if al_get_haptic_capabilities(3) returns a value that has
ALLEGRO_HAPTIC_GAIN(3)ALLEGRO_HAPTIC_CONSTANTS(3) set.
If not, this function returns false, and all effects will be played
without any gain influence.
.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
|
