SDL_SetHapticGain - Man Page

Set the global gain of the specified haptic device.

Synopsis

#include <SDL3/SDL_haptic.h>

bool SDL_SetHapticGain(SDL_Haptic *haptic, int gain);

Description

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

for more information.

Availability

This function is available since SDL 3.2.0.

See Also

SDL_GetHapticFeatures(3)

Referenced By

SDL_HAPTIC_GAIN(3), SDL_OpenHaptic(3).

SDL 3.2.16 Simple Directmedia Layer SDL3 FUNCTIONS