al_get_haptic_gain(3)

al_get_haptic_gain(3) 💅

okay bestie, welcome to the Library Functions Manual — this page is all about al_get_haptic_gain, and it's giving Allegro 5 API main character energy. 🦋

---

💖 NAME 💖

al_get_haptic_gain — Allegro 5 API. That's the whole name, no cap. ✨

🌈 SYNOPSIS 🌈

#include <allegro5/allegro.h>

double al_get_haptic_gain(ALLEGRO_HAPTIC *hap)

🦋 DESCRIPTION 🦋

okay so al_get_haptic_gain returns the current gain of the device. Gain is much like volume for sound: it's as if every effect's intensity is multiplied by it. The gain is a value between 0.0 and 1.0. 🎀

It only works correctly if al_get_haptic_capabilities(3) returns a value that has ALLEGRO_HAPTIC_GAIN(3)ALLEGRO_HAPTIC_CONSTANTS(3) set. If this is not set, the function will simply return 1.0 and all effects will be played without any gain influence. fr fr, that's the whole vibe check. 💅

🌸 SINCE 🌸

5.1.8 — iconic since then, bestie. 🫶

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

---

signed off by the Allegro reference manual, page al_get_haptic_gain(3) — and the original footer doesn't list a date, so that's all the footer lore 😭💖