al_rumble_haptic(3alleg5)

📦
version 5.2.11.3 · 4 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 al_rumble_haptic — Allegro 5 API 💖

okay bestie, so this is al_rumble_haptic, straight outta the Allegro 5 API (that's 3alleg5, if you're keeping track). it's giving "make the controller go brrr" energy and honestly? obsessed. 🎀

✨ SYNOPSIS ✨

#include <allegro5/allegro.h>

bool al_rumble_haptic(ALLEGRO_HAPTIC *hap,
   double intensity, double duration, ALLEGRO_HAPTIC_EFFECT_ID *id)

🌸 DESCRIPTION 🌸

so what this does is: it uploads a simple rumble effect to the haptic device and starts playback immediately. no waiting, no queueing, we go now. 💅

  • intensity — a relative magnitude between 0.0 and 1.0 that determines the intensity of the rumble effect. like, how hard are we vibrating bestie.
  • duration — determines the duration of the effect, in seconds. how long the vibe lasts. 🌈

you also must pass in a pointer to a user allocated ALLEGRO_HAPTIC_EFFECT_ID(3alleg5). inside it, a reference gets stored that you use to control playback of the effect. main character storage unit fr fr. 👑

it returns true if the rumble effect was successfully uploaded and started, and false if not.

🚨 IMPORTANT BESTIE, LISTEN UP 🚨 if false is returned, the rumble effect gets automatically released as if al_release_haptic_effect(3alleg5) had been called. so you do not need to call it again manually in this case. it's handled. we're fine. 😌 but if true is returned, it is necessary to call al_release_haptic_effect(3alleg5) when the effect isn't needed anymore — this prevents the amount of available effects on the haptic device from running out. do not skip this one, the device has limits and it WILL hold a grudge. 💀

🦋 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. — so like, it works, but it's in its experimental era and the Allegro devs wanna hear from y'all. if you got thoughts, send them. 🫶

that's the whole page bestie, no cap. this was al_rumble_haptic(3alleg5) from the Allegro reference manual — go forth and rumble responsibly, and don't forget your release call. mwah. 💖✨🎀

📦 where this page comes from