SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Set the global gain of the specified haptic device.

Header File

Defined in <SDL3/SDL_haptic.h>


int SDL_SetHapticGain(SDL_Haptic *haptic, int gain);

Function Parameters

SDL_Haptic * haptic the SDL_Haptic device to set the gain on.
int gain value to set the gain to, should be between 0 and 100 (0 - 100).

Return Value

(int) 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 100. All calls to SDL_SetHapticGain() will scale linearly using SDL_HAPTIC_GAIN_MAX as the maximum.


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryHaptic

[ 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.