al_rumble_haptic(3)

💖 al_rumble_haptic(3) — Library Functions Manual 💖

okay so you opened the page for al_rumble_haptic(3), bestie, and it’s giving “Allegro 5 API haptic rumble realness” ✨ let’s get into it.

🌸 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 🎀

So al_rumble_haptic uploads a simple rumble effect to the haptic device and starts playback immediately. The intensity parameter is a relative magnitude between 0.0 and 1.0 that determines the intensity of the rumble effect. The duration parameter determines the duration of the effect in seconds. Cute, simple, no cap 🦋

You must also pass in a pointer to a user allocated ALLEGRO_HAPTIC_EFFECT_ID(3). Inside it, a reference is stored to be used to control playback of the effect. Returns true if the rumble effect was successfully uploaded and started, false if not 💅

If false is returned, the rumble effect will be automatically released as if al_release_haptic_effect(3) had been called, so there is no need to call it again manually in this case. But 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. That part is important, bestie — don’t leave your haptic effect slots starving 😭

⭐ SINCE ⭐

5.1.8 — periodt 🌟

[Unstable API]: perhaps it could be simplified due to limited support for all the exposed features across all of the platforms. Awaiting feedback from users 👀

---

that’s a wrap from the Allegro reference manual, al_rumble_haptic(3) — no date shown on this page, just this cute little send-off 🎀💖