Wiki Page Content

DRAFT

SDL_HapticSetGain

Use this function to set the global gain of the specified haptic device.

Syntax

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.

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.

Version

This function is available since SDL 2.0.0.


CategoryAPI, CategoryForceFeedback

None: SDL_HapticSetGain (last edited 2016-07-15 20:36:32 by PhilippWiesemann)

(Page Info.)
Feedback
Please include your contact information if you'd like to receive a reply.
Submit