> ## 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.

# GameInputForceFeedbackPeriodicParams

> GameInputForceFeedbackPeriodicParams

# GameInputForceFeedbackPeriodicParams

The parameters that define periodic force-feedback effects.

## Syntax

```cpp theme={null}
struct GameInputForceFeedbackPeriodicParams
{
    GameInputForceFeedbackEnvelope  envelope;
    GameInputForceFeedbackMagnitude magnitude;
    float                           frequency;
    float                           phase;
    float                           bias;
};
```

### Members

*envelope*<br />
Type: [GameInputForceFeedbackEnvelope](/reference/input/gameinput/structs/gameinputforcefeedbackenvelope)

The modifiers on a force-feedback effect, such as attack, sustain, or release.

*magnitude*<br />
Type: [GameInputForceFeedbackMagnitude](/reference/input/gameinput/structs/gameinputforcefeedbackmagnitude)

The amount of force applied by the force-feedback effect.

*frequency*<br />
Type: float

Frequency of the force-feedback period measured in hertz.

*phase*<br />
Type: float

The time in the cycle of the periodic effect at which the playback begins.

*bias*<br />
Type: float

Offset of the force-feedback period.

## Remarks

The `GameInputForceFeedbackPeriodicParams` structure is a member of  [GameInputForceFeedbackParams](/reference/input/gameinput/structs/gameinputforcefeedbackparams). Forced-feedback effects are defined by their parameters. These effects are stored in the `GameInputForceFeedbackParams` structure. The actual parameters for each type of force feedback effect vary slightly. The parameters for all kinds of effects define the magnitude of the effect along the motor's supported axes, and most allow for an envelope that affects the strength of the effect over time.

## Requirements

**Header:** GameInput.h

[Advanced GameInput topics](/build/core-features/common/input/advanced/input-advanced-topics)\
[Overview of GameInput](/build/core-features/common/input/overviews/input-overview)\
[GameInputForceFeedbackParams](/reference/input/gameinput/structs/gameinputforcefeedbackparams)\
[GameInput](/reference/input/gameinput/gameinput_members)

## Version History

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


## Related topics

- [GameInputForceFeedbackParams](/reference/input/gameinput/structs/gameinputforcefeedbackparams.md)
- [GameInputForceFeedbackMagnitude](/reference/input/gameinput/structs/gameinputforcefeedbackmagnitude.md)
- [GameInputForceFeedbackEnvelope](/reference/input/gameinput/structs/gameinputforcefeedbackenvelope.md)
- [GameInput](/reference/input/gameinput/gameinput_members.md)
- [Force feedback on GameInput](/build/core-features/common/input/advanced/input-forcefeedback.md)