.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_SetHapticGain:
.\"   https://wiki.libsdl.org/SDL_SetHapticGain
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision SDL-3.1.0
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_SetHapticGain
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_SetHapticGain 3 "SDL 3.1.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_SetHapticGain \- Set the global gain of the specified haptic device\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "int SDL_SetHapticGain(SDL_Haptic *haptic, int gain);
.fi
.SH DESCRIPTION
Device must support the 
.BR SDL_HAPTIC_GAIN
 feature\[char46]

The user may specify the maximum gain by setting the environment variable

.BR
.BR SDL_HAPTIC_GAIN_MAX
which should be between 0 and
100\[char46] All calls to 
.BR SDL_SetHapticGain
() will scale
linearly using 
.BR
.BR SDL_HAPTIC_GAIN_MAX
as the maximum\[char46]

.SH FUNCTION PARAMETERS
.TP
.I haptic
the 
.BR SDL_Haptic
 device to set the gain on
.TP
.I gain
value to set the gain to, should be between 0 and 100 (0 - 100)
.SH RETURN VALUE
Returns 0 on success or a negative error code on failure; call

.BR SDL_GetError
() for more information\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_GetHapticFeatures (3)