SDL Wiki
(This is the legacy documentation for stable SDL2, the current stable version; SDL3 is the current development version.)


Set the global gain of the specified haptic device.


int SDL_HapticSetGain(SDL_Haptic * haptic, int gain);

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.


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

  1. All calls to SDL_HapticSetGain() will scale linearly using SDL_HAPTIC_GAIN_MAX as the maximum.


This function is available since SDL 2.0.0.


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.