plucky (3) al_upload_and_play_haptic_effect.3alleg5.gz

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 immediately.  Returns true if the upload and
       playback were successful, false if either failed.

       In  case  false   is   returned,   the   haptic   effect   will   be   automatically   released   as   if
       al_release_haptic_effect(3alleg5)  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(3alleg5)  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 support for all  the  exposed  features
              across all of the platforms.  Awaiting feedback from users.

SEE ALSO

       al_upload_haptic_effect(3alleg5), al_play_haptic_effect(3alleg5)