ALLEGRO_HAPTIC_CONSTANTS man page

ALLEGRO_HAPTIC_CONSTANTS — Allegro 5 API

Synopsis

#include <allegro5/allegro.h>

enum ALLEGRO_HAPTIC_CONSTANTS

Description

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.

·
ALLEGRO_HAPTIC_RUMBLE - simple vibration effects
·
ALLEGRO_HAPTIC_PERIODIC - periodic, wave-form effects
·
ALLEGRO_HAPTIC_CONSTANT - constant effects
·
ALLEGRO_HAPTIC_SPRING - spring effects
·
ALLEGRO_HAPTIC_FRICTION - friction effects
·
ALLEGRO_HAPTIC_DAMPER - damper effects
·
ALLEGRO_HAPTIC_INERTIA - inertia effects
·
ALLEGRO_HAPTIC_RAMP - ramp effects
·
ALLEGRO_HAPTIC_SQUARE - square wave periodic effect
·
ALLEGRO_HAPTIC_TRIANGLE - triangle wave periodic effect
·
ALLEGRO_HAPTIC_SINE - sine wave periodic effect
·
ALLEGRO_HAPTIC_SAW_UP - upwards saw wave periodic effect
·
ALLEGRO_HAPTIC_SAW_DOWN - downwards saw wave periodic effect
·
ALLEGRO_HAPTIC_CUSTOM - custom wave periodic effect
·
ALLEGRO_HAPTIC_GAIN - the haptic device supports gain setting
·
ALLEGRO_HAPTIC_ANGLE - the haptic device supports angle coordinates
·
ALLEGRO_HAPTIC_RADIUS - the haptic device supports radius coordinates
·
ALLEGRO_HAPTIC_AZIMUTH - the haptic device supports azimuth coordinates
·
ALLEGRO_HAPTIC_AUTOCENTER

Since

5.1.8

[Unstable API]: Perhaps could be simplified due to limited support for all the exposed features across all of the platforms. Awaiting feedback from users.

See Also

al_get_haptic_capabilities(3), ALLEGRO_HAPTIC_EFFECT(3)

Referenced By

al_get_haptic_autocenter(3), al_get_haptic_capabilities(3), al_get_haptic_gain(3), al_is_haptic_capable(3), al_set_haptic_autocenter(3), al_set_haptic_gain(3).

Allegro reference manual