> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GameInputForceFeedbackEnvelope

> GameInputForceFeedbackEnvelope

# GameInputForceFeedbackEnvelope

Defines an envelope that modifies a force-feedback effect.

## Syntax

```cpp theme={null}
struct GameInputForceFeedbackEnvelope
{
    uint64_t attackDuration;
    uint64_t sustainDuration;
    uint64_t releaseDuration;
    float    attackGain;
    float    sustainGain;
    float    releaseGain;
    uint32_t playCount;
    uint64_t repeatDelay;
};
```

### Members

*attackDuration*<br />
Type: uint64\_t

Time in microseconds to reach the sustain level of a force-feedback effect envelope.

*sustainDuration*<br />
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*<br />
Type: uint64\_t

Time in microseconds from the sustain duration to the release of a force-feedback effect envelope.

*attackGain*<br />
Type: float

Modifier on the attack of force-feedback effect envelope.

*sustainGain*<br />
Type: float

Modifier on the sustain gain of a force-feedback effect envelope.

*releaseGain*<br />
Type: float

Modifier on the release gain of a force-feedback effect envelope.

*playCount*<br />
Type: uint32\_t

Number of iterations that the envelope will be applied to the force-feedback event.

*repeatDelay*<br />
Type: uint64\_t

Interval of time between applications of the force-feedback envelope.

## Remarks

`GameInputForceFeedbackEnvelope` is a member of the [GameInputForceFeedbackConstantParams](/reference/input/gameinput/structs/gameinputforcefeedbackconstantparams), [GameInputForceFeedbackPeriodicParams](/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams), and [GameInputForceFeedbackRampParams](/reference/input/gameinput/structs/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](/build/core-features/common/input/advanced/input-advanced-topics).

## Requirements

**Header:** GameInput.h

## Version History

| Version | Changes     |
| ------- | ----------- |
| **v0**  | Introduced. |


## Related topics

- [GameInputForceFeedbackConstantParams](/reference/input/gameinput/structs/gameinputforcefeedbackconstantparams.md)
- [GameInputForceFeedbackRampParams](/reference/input/gameinput/structs/gameinputforcefeedbackrampparams.md)
- [GameInputForceFeedbackPeriodicParams](/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams.md)
- [GameInput](/reference/input/gameinput/gameinput_members.md)
- [GameInputForceFeedbackParams](/reference/input/gameinput/structs/gameinputforcefeedbackparams.md)