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

FreeBSD Manual Pages

  
 
  

home | help
al_rumble_haptic(3)	   Library Functions Manual	   al_rumble_haptic(3)

NAME
       al_rumble_haptic	- Allegro 5 API

SYNOPSIS
	      #include <allegro5/allegro.h>

	      bool al_rumble_haptic(ALLEGRO_HAPTIC *hap,
		 double	intensity, double duration, ALLEGRO_HAPTIC_EFFECT_ID *id)

DESCRIPTION
       Uploads a simple	rumble effect to the haptic device and starts playback
       immediately.   The  parameter intensity is a relative magnitude between
       0.0 and 1.0 that	determines the intensity of the	 rumble	 effect.   The
       duration	determines the duration	of the effect in seconds.

       You  must also pass in a	pointer	to a user allocated ALLEGRO_HAPTIC_EF-
       FECT_ID(3).  It it is stored a reference	to be used to control playback
       of the effect.  Returns true if the rumble effect was successfully  up-
       loaded and started, false if not.

       In  case	false is returned, the rumble effect will be automatically re-
       leased as if al_release_haptic_effect(3)	had been called, so  there  is
       no  need	 to  call it again manually in this case.  However, if true is
       returned, it is necessary to call al_release_haptic_effect(3) when  the
       effect isn't needed anymore, to prevent the amount of available effects
       on the haptic device from running out.

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.

Allegro	reference manual				   al_rumble_haptic(3)

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

home | help