Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
al_set_haptic_gain(3)	    Library Functions Manual	   al_set_haptic_gain(3)

NAME
     al_set_haptic_gain - Allegro 5 API

SYNOPSIS
	    #include <allegro5/allegro.h>

	    bool al_set_haptic_gain(ALLEGRO_HAPTIC *hap, double gain)

DESCRIPTION
     Sets  the gain of the haptic device if supported.	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.  Returns true if set successfully, false if
     not.   Only works if al_get_haptic_capabilities(3) returns a value that has
     ALLEGRO_HAPTIC_GAIN(3)ALLEGRO_HAPTIC_CONSTANTS(3) set.  If not, this  func-
     tion  returns false, and all effects will be played without any gain influ-
     ence.

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.

Allegro reference manual				   al_set_haptic_gain(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=al_set_haptic_gain&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help