NAME¶

SDL_HapticSetGain - Set the global gain of the specified haptic device.

SYNOPSIS¶

#include "SDL3/SDL.h"

int SDL_HapticSetGain(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_HapticSetGain () 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 0 on success or a negative error code on failure; call

SDL_GetError () for more information.

AVAILABILITY¶

This function is available since SDL 3.0.0.

SEE ALSO¶

SDL_HapticQuery(3)