Function SDL_SetHapticGain
pub unsafe extern "C" fn SDL_SetHapticGain(
haptic: *mut SDL_Haptic,
gain: i32,
) -> bool
Available on crate feature
dep_sdl3
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_SetHapticGain()
will scale linearly using SDL_HAPTIC_GAIN_MAX
as the
maximum.
§Parameters
haptic
: theSDL_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.