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

FreeBSD Manual Pages

  
 
  

home | help
al_upload_...tic_effect(3) Library Functions Manual al_upload_...tic_effect(3)

NAME
       al_upload_and_play_haptic_effect	- Allegro 5 API

SYNOPSIS
	      #include <allegro5/allegro.h>

	      bool al_upload_and_play_haptic_effect(ALLEGRO_HAPTIC *hap,
		 ALLEGRO_HAPTIC_EFFECT *effect,	ALLEGRO_HAPTIC_EFFECT_ID *id, int loop)

DESCRIPTION
       Uploads	the  haptic  effect  to	the device and starts playback immedi-
       ately.  Returns true if the upload and playback were successful,	 false
       if either failed.

       In  case	false is returned, the haptic 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 devicefrom	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.

SEE ALSO
       al_upload_haptic_effect(3), al_play_haptic_effect(3)

Allegro	reference manual			    al_upload_...tic_effect(3)

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

home | help