IGameInputForceFeedbackEffect::GetGain

Retrieves the gain set on a force feedback effect.

Syntax

float GetGain();

Parameters

This method has no parameters.

Return value

Type: float

The gain set on a force-feedback motor device.

Remarks

The IGameInputForceFeedbackEffect::GetGain method retrieves the gain on a force feedback motor. The gain can have a value between 0.0 and 1.0. For more information, see Advanced GameInput topics.

Requirements

Header: GameInput.h

Library: xgameruntime.lib

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

Overview of GameInput
IGameInputForceFeedbackEffect::SetGain
IGameInputDevice::SetForceFeedbackMotorGain
IGameInputForceFeedbackEffect