devela::_dep::sdl2::sys

Function SDL_HapticSetGain

pub unsafe extern "C" fn SDL_HapticSetGain(
    haptic: *mut _SDL_Haptic,
    gain: i32,
) -> i32
Available on crate feature dep_sdl2 only.
Expand description

Set the global gain of the specified haptic device.

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.

\param haptic the SDL_Haptic device to set the gain on \param gain value to set the gain to, should be between 0 and 100 (0 - 100) \returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_HapticQuery