checkGain - 18684092/Steering-Wheel-Project GitHub Wiki

CheckGain

Access: Private

Prototype: bool checkGain(int gain)

Parameters: int gain – gain is a percentage of overall effect strength.

Return Value: Boolean true if within range, false otherwise.

Description: MIN_GAIN >= gain <= MAX_GAIN

Note: Gain is used in conjunction with setMaxGain() environmental variable. The gain is a percentage of MAXIMUM_GAIN which is an alias of SDL_HAPTIC_GAIN_MAX.

Related Functions: checkDuration(), checkDelay(), checkAttackLength(), checkFadeLength(), checkEnvelopeTime(), checkIterations(), checkLevel(), checkFadeLevel(), checkSatLevel(), checkCoEfLevel(), checkDeadband(), checkCentre(), checkAttackLevel(), checkEffectNumber(), checkHaptic(), checkParamsConstant(), checkParamsEnvelope(), checkParamsPeriod(), checkParamsCondition(), checkDirection(), checkPeriodType(), checkConditionType(), checkGain()