SDL_SetHapticGain(3)

SDL_SetHapticGain3

Set the global gain of the specified haptic device.

Usage

#include "SDL3/SDL.h"

bool SDL_SetHapticGain(SDL_Haptic *haptic, int gain);

Header file

Defined in SDL3/SDL_haptic.h

Overview

Device must support the SDL_HAPTIC_GAIN
feature.

The user may specify the maximum gain by setting the environment variable

SDL_HAPTIC_GAIN_MAX which should be between 0 and 100. All calls to SDL_SetHapticGain () will scale linearly using SDL_HAPTIC_GAIN_MAX as the maximum.

Function parameters

haptic

the SDL_Haptic
device to set the gain on.

gain

value to set the gain to, should be between 0 and 100 (0 - 100).

Return value

Returns true on success or false on failure; call

SDL_GetError () for more information.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.