.\" Automatically generated by Pandoc 3.1.3
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "al_release_haptic_effect" "3alleg5" "" "Allegro reference manual" ""
.hy
.SH NAME
.PP
al_release_haptic_effect - Allegro 5 API
.SH SYNOPSIS
.IP
.nf
\f[C]
#include <allegro5/allegro.h>

bool al_release_haptic_effect(ALLEGRO_HAPTIC_EFFECT_ID *id)
\f[R]
.fi
.SH DESCRIPTION
.PP
Releases a previously uploaded haptic effect from the device it has been
uploaded to, allowing for other effects to be uploaded.
The play_id must be a valid ALLEGRO_HAPTIC_EFFECT_ID(3alleg5) obtained
from al_upload_haptic_effect(3alleg5),
al_upload_and_play_haptic_effect(3alleg5) or al_rumble_haptic(3alleg5).
.PP
This function is called automatically when you call
al_release_haptic(3alleg5) on a ALLEGRO_HAPTIC(3alleg5) for all effects
that are still uploaded to the device.
Therefore this function is most useful if you want to upload and release
haptic effects dynamically, for example as a way to circumvent the limit
imposed by al_get_max_haptic_effects(3alleg5).
.PP
Returns true on success, false if the effect couldn\[cq]t be released
for any reason such as when NULL is passed, the effect is not active or
failure to release the effect by the driver.
.SH SINCE
.PP
5.1.8
.RS
.PP
\f[I][Unstable API]:\f[R] Perhaps could be simplified due to limited
support for all the exposed features across all of the platforms.
Awaiting feedback from users.
.RE