IGameInputForceFeedbackEffect

Describes and tracks a force feedback effect on a supporting input device.

Syntax

class IGameInputForceFeedbackEffect : public IUnknown  

Methods

Method Description
GetDevice method Retrieves the device associated with the force feedback effect.
IGameInputForceFeedbackEffect::GetGain Retrieves the gain set on a force feedback effect.
GetMotorIndex Retrieves the motor index associated with the force feedback effect.
GetParams Retrieves the parameters that define the force feedback effect.
IGameInputForceFeedbackEffect::GetState Retrieves the current state for a force feedback effect.
IGameInputForceFeedbackEffect::SetGain Sets the gain on a force feedback effect.
IGameInputForceFeedbackEffect::SetParams Sets new parameters on a force feedback effect.
IGameInputForceFeedbackEffect::SetState Sets the state for a force feedback effect.

Remarks

If the tracked device is disconnected before the feedback effect finishes it's lifetime the feedback effect is orphaned and will always report its state as "stopped" until the resources are released.

Requirements

Header: GameInput.h

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

See also

Input API Overview
GameInput