Skip to main content

GameInputForceFeedbackEnvelope

Defines an envelope that modifies a force-feedback effect.

Syntax

Members

attackDuration
Type: uint64_t
Time in microseconds to reach the sustain level of a force-feedback effect envelope. sustainDuration
Type: uint64_t
Time in microseconds from the start of the sustain duration until the release component of a force-feedback effect envelope. If the effect is intended to run forever, use UINT64_MAX for the this value. releaseDuration
Type: uint64_t
Time in microseconds from the sustain duration to the release of a force-feedback effect envelope. attackGain
Type: float
Modifier on the attack of force-feedback effect envelope. sustainGain
Type: float
Modifier on the sustain gain of a force-feedback effect envelope. releaseGain
Type: float
Modifier on the release gain of a force-feedback effect envelope. playCount
Type: uint32_t
Number of iterations that the envelope will be applied to the force-feedback event. repeatDelay
Type: uint64_t
Interval of time between applications of the force-feedback envelope.

Remarks

GameInputForceFeedbackEnvelope is a member of the GameInputForceFeedbackConstantParams, GameInputForceFeedbackPeriodicParams, and GameInputForceFeedbackRampParams structures. Force-feedback envelopes are modifiers on force feedback effects that modify their output through the device. For more information, see Advanced GameInput topics.

Requirements

Header: GameInput.h

Version History

Last modified on August 31, 2026