1al_release_haptic_effect(3)                        al_release_haptic_effect(3)
2
3
4

NAME

6       al_release_haptic_effect - Allegro 5 API
7

SYNOPSIS

9              #include <allegro5/allegro.h>
10
11              bool al_release_haptic_effect(ALLEGRO_HAPTIC_EFFECT_ID *id)
12

DESCRIPTION

14       Releases  a  previously  uploaded  haptic effect from the device it has
15       been uploaded to, allowing for  other  effects  to  be  uploaded.   The
16       play_id  must  be  a  valid  ALLEGRO_HAPTIC_EFFECT_ID(3)  obtained from
17       al_upload_haptic_effect(3),   al_upload_and_play_haptic_effect(3)    or
18       al_rumble_haptic(3).
19
20       This  function  is  called  automatically when you call al_release_hap‐
21       tic(3) on a ALLEGRO_HAPTIC(3) for all effects that are  still  uploaded
22       to  the  device.  Therefore this function is most useful if you want to
23       upload and release haptic effects dynamically, for example as a way  to
24       circumvent the limit imposed by al_get_max_haptic_effects(3).
25
26       Returns  true  on success, false if the effect couldn't be released for
27       any reason such as when NULL is passed, the effect  is  not  active  or
28       failure to release the effect by the driver.
29

SINCE

31       5.1.8
32
33              [Unstable  API]: Perhaps could be simplified due to limited sup‐
34              port for all the exposed features across all of  the  platforms.
35              Awaiting feedback from users.
36
37
38
39Allegro reference manual                           al_release_haptic_effect(3)