1ALLEGRO_HAPTIC_CONSTANTS(3)                        ALLEGRO_HAPTIC_CONSTANTS(3)
2
3
4

NAME

6       ALLEGRO_HAPTIC_CONSTANTS - Allegro 5 API
7

SYNOPSIS

9              #include <allegro5/allegro.h>
10
11              enum ALLEGRO_HAPTIC_CONSTANTS
12

DESCRIPTION

14       This enum contains flags that are used to define haptic effects and ca‐
15       pabilities.  If the flag is set in  the  return  value  of  al_get_hap‐
16       tic_capabilities(3),  it  means  the  device supports the given effect.
17       The value of these flags should be set into a  ALLEGRO_HAPTIC_EFFECT(3)
18       struct to determine what kind of haptic effect should be played.
19
20       • ALLEGRO_HAPTIC_RUMBLE - simple vibration effects
21
22       • ALLEGRO_HAPTIC_PERIODIC - periodic, wave-form effects
23
24       • ALLEGRO_HAPTIC_CONSTANT - constant effects
25
26       • ALLEGRO_HAPTIC_SPRING - spring effects
27
28       • ALLEGRO_HAPTIC_FRICTION - friction effects
29
30       • ALLEGRO_HAPTIC_DAMPER - damper effects
31
32       • ALLEGRO_HAPTIC_INERTIA - inertia effects
33
34       • ALLEGRO_HAPTIC_RAMP - ramp effects
35
36       • ALLEGRO_HAPTIC_SQUARE - square wave periodic effect
37
38       • ALLEGRO_HAPTIC_TRIANGLE - triangle wave periodic effect
39
40       • ALLEGRO_HAPTIC_SINE - sine wave periodic effect
41
42       • ALLEGRO_HAPTIC_SAW_UP - upwards saw wave periodic effect
43
44       • ALLEGRO_HAPTIC_SAW_DOWN - downwards saw wave periodic effect
45
46       • ALLEGRO_HAPTIC_CUSTOM - custom wave periodic effect
47
48       • ALLEGRO_HAPTIC_GAIN - the haptic device supports gain setting
49
50       • ALLEGRO_HAPTIC_ANGLE - the haptic device supports angle coordinates
51
52       • ALLEGRO_HAPTIC_RADIUS - the haptic device supports radius coordinates
53
54       • ALLEGRO_HAPTIC_AZIMUTH  -  the haptic device supports azimuth coordi‐
55         nates
56
57       • ALLEGRO_HAPTIC_AUTOCENTER
58

SINCE

60       5.1.8
61
62              [Unstable API]: Perhaps could be simplified due to limited  sup‐
63              port  for  all the exposed features across all of the platforms.
64              Awaiting feedback from users.
65

SEE ALSO

67       al_get_haptic_capabilities(3), ALLEGRO_HAPTIC_EFFECT(3)
68
69
70
71Allegro reference manual                           ALLEGRO_HAPTIC_CONSTANTS(3)
Impressum