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 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
|
.TH "ALLEGRO_HAPTIC_CONSTANTS" "3" "" "Allegro reference manual" ""
.SH NAME
.PP
ALLEGRO_HAPTIC_CONSTANTS \- Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include\ <allegro5/allegro.h>
enum\ ALLEGRO_HAPTIC_CONSTANTS
\f[]
.fi
.SH DESCRIPTION
.PP
This enum contains flags that are used to define haptic effects and
capabilities.
If the flag is set in the return value of al_get_haptic_capabilities(3),
it means the device supports the given effect.
The value of these flags should be set into a ALLEGRO_HAPTIC_EFFECT(3)
struct to determine what kind of haptic effect should be played.
.IP \[bu] 2
ALLEGRO_HAPTIC_RUMBLE \- simple vibration effects
.IP \[bu] 2
ALLEGRO_HAPTIC_PERIODIC \- periodic, wave\-form effects
.IP \[bu] 2
ALLEGRO_HAPTIC_CONSTANT \- constant effects
.IP \[bu] 2
ALLEGRO_HAPTIC_SPRING \- spring effects
.IP \[bu] 2
ALLEGRO_HAPTIC_FRICTION \- friction effects
.IP \[bu] 2
ALLEGRO_HAPTIC_DAMPER \- damper effects
.IP \[bu] 2
ALLEGRO_HAPTIC_INERTIA \- inertia effects
.IP \[bu] 2
ALLEGRO_HAPTIC_RAMP \- ramp effects
.IP \[bu] 2
ALLEGRO_HAPTIC_SQUARE \- square wave periodic effect
.IP \[bu] 2
ALLEGRO_HAPTIC_TRIANGLE \- triangle wave periodic effect
.IP \[bu] 2
ALLEGRO_HAPTIC_SINE \- sine wave periodic effect
.IP \[bu] 2
ALLEGRO_HAPTIC_SAW_UP \- upwards saw wave periodic effect
.IP \[bu] 2
ALLEGRO_HAPTIC_SAW_DOWN \- downwards saw wave periodic effect
.IP \[bu] 2
ALLEGRO_HAPTIC_CUSTOM \- custom wave periodic effect
.IP \[bu] 2
ALLEGRO_HAPTIC_GAIN \- the haptic device supports gain setting
.IP \[bu] 2
ALLEGRO_HAPTIC_ANGLE \- the haptic device supports angle coordinates
.IP \[bu] 2
ALLEGRO_HAPTIC_RADIUS \- the haptic device supports radius coordinates
.IP \[bu] 2
ALLEGRO_HAPTIC_AZIMUTH \- the haptic device supports azimuth coordinates
.IP \[bu] 2
ALLEGRO_HAPTIC_AUTOCENTER
.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_get_haptic_capabilities(3), ALLEGRO_HAPTIC_EFFECT(3)
|