al_get_haptic_gain(3alleg5)

al_get_haptic_gain3alleg5

Allegro 5 api

Usage

#include <allegro5/allegro.h>
double al_get_haptic_gain(ALLEGRO_HAPTIC *hap)

Overview

Returns the current gain of the device. Gain is much like volume for sound, it is as if every effect’s intensity is multiplied by it. Gain is a value between 0.0 and 1.0. Only works correctly if al_get_haptic_capabilities(3alleg5) returns a value that has ALLEGRO_HAPTIC_GAIN(3alleg5)ALLEGRO_HAPTIC_CONSTANTS(3alleg5) set. If this is not set, this function will simply return 1.0 and all effects will be played without any gain influence.

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.

Releases

5 releases since Debian 9 (Stretch); the text changed 4 times.

  1. 9
  2. 10
  3. 11
  4. 12
  5. 13

From allegro5-doc 2:5.2.10.1+dfsg-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.