|
⇤ ← Revision 1 as of 2010-03-22 19:59:24
Size: 1135
Comment: create page, add content (Rev 5321)
|
Size: 1153
Comment: update content - standard return value
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 21: | Line 21: |
| Returns 0 on success, or -1 on failure; call [[SDL_GetError]]() for more information. | Returns 0 on success or a negative error code on failure; call [[SDL_GetError]]() for more information. |
DRAFT |
SDL_HapticSetGain
Use this function to set the global gain of the specified haptic device.
Contents
Syntax
int SDL_HapticSetGain(SDL_Haptic* haptic,
int gain)
Function Parameters
haptic |
a pointer to the haptic device to set the gain on |
gain |
value to set the gain to, should be between 0 and 100 |
Return Value
Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
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.
