Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
ALLEGRO_HA..._CONSTANTS(3) Library Functions Manual ALLEGRO_HA..._CONSTANTS(3)

NAME
       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 ca-
       pabilities.   If	 the  flag  is	set in the return value	of al_get_hap-
       tic_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  coordi-
	 nates

        ALLEGRO_HAPTIC_AUTOCENTER

SINCE
       5.1.8

	      [Unstable	 API]: Perhaps could be	simplified due to limited sup-
	      port 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)

Allegro	reference manual			    ALLEGRO_HA..._CONSTANTS(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ALLEGRO_HAPTIC_CONSTANTS&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help