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

# GameInputForceFeedbackParams

> GameInputForceFeedbackParams

# GameInputForceFeedbackParams

Définit les attributs d'un effet de retour de force pris en charge par l'API.

## Syntaxe

```cpp theme={null}
struct GameInputForceFeedbackParams
{
    GameInputForceFeedbackEffectKind kind;
    union
    {
        GameInputForceFeedbackConstantParams  constant;
        GameInputForceFeedbackRampParams      ramp;
        GameInputForceFeedbackPeriodicParams  sineWave;
        GameInputForceFeedbackPeriodicParams  squareWave;
        GameInputForceFeedbackPeriodicParams  triangleWave;
        GameInputForceFeedbackPeriodicParams  sawtoothUpWave;
        GameInputForceFeedbackPeriodicParams  sawtoothDownWave;
        GameInputForceFeedbackConditionParams spring;
        GameInputForceFeedbackConditionParams friction;
        GameInputForceFeedbackConditionParams damper;
        GameInputForceFeedbackConditionParams inertia;
    } data;
};
```

### Membres

*kind*\

Type : [GameInputForceFeedbackEffectKind](/fr-CA/reference/input/gameinput/enums/gameinputforcefeedbackeffectkind)

Définit le type d'un effet de retour de force.

*constant*\

Type : [GameInputForceFeedbackConstantParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackconstantparams)

Effet de retour de force constant. La force est appliquée à un niveau constant pendant toute la durée de l'effet.

*ramp*\

Type : [GameInputForceFeedbackRampParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackrampparams)

Effet de retour de force en rampe. La force est appliquée graduellement en augmentant ou en diminuant pendant la durée de l'effet.

*sineWave*\

Type : [GameInputForceFeedbackPeriodicParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams)

Effet de retour de force à onde sinusoïdale. La force est appliquée selon un motif d'onde sinusoïdale.

*squareWave*\

Type : [GameInputForceFeedbackPeriodicParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams)

Effet de retour de force à onde carrée. La force est appliquée selon un motif d'onde carrée.

*triangleWave*\

Type : [GameInputForceFeedbackPeriodicParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams)

Effet de retour de force à onde triangulaire. La force est appliquée selon un motif d'onde triangulaire.

*sawtoothUpWave*\

Type : [GameInputForceFeedbackPeriodicParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams)

Effet de retour de force à onde en dents de scie montante. La force est appliquée selon un motif d'onde en dents de scie montante.

*sawtoothDownWave*\

Type : [GameInputForceFeedbackPeriodicParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams)

Effet de retour de force à onde en dents de scie descendante. La force est appliquée selon un motif d'onde en dents de scie descendante.

*spring*\

Type : [GameInputForceFeedbackConditionParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackconditionparams)

Effet de retour de force de ressort. La force est appliquée en opposition à un état défini.

*friction*\

Type : [GameInputForceFeedbackConditionParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackconditionparams)

Effet de retour de force de friction. La force est appliquée de façon à imiter une friction.

*damper*\

Type : [GameInputForceFeedbackConditionParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackconditionparams)

Effet de retour de force d'amortissement. La force est appliquée de façon à imiter un effet d'amortissement.

*inertia*\

Type : [GameInputForceFeedbackConditionParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackconditionparams)

Effet de retour de force d'inertie. La force est appliquée de façon à imiter un effet d'inertie.

## Remarques

Les effets de retour de force sont définis par leurs paramètres. Ces effets sont stockés dans la structure `GameInputForceFeedbackParams`. Les paramètres réels de chaque type d'effet de retour de force varient légèrement. Les paramètres de tous les types d'effets définissent la magnitude de l'effet le long des axes pris en charge par le moteur, et la plupart permettent une enveloppe qui modifie l'intensité de l'effet au fil du temps.

## Configuration requise

**En-tête :** GameInput.h

[Rubriques GameInput avancées](/fr-CA/build/core-features/common/input/advanced/input-advanced-topics)\
[Vue d'ensemble de GameInput](/fr-CA/build/core-features/common/input/overviews/input-overview)\
[GameInputForceFeedbackEffectKind](/fr-CA/reference/input/gameinput/enums/gameinputforcefeedbackeffectkind)\
[GameInput](/fr-CA/reference/input/gameinput/gameinput_members)

## Historique des versions

| Version | Modifications |
| - | - |
| **v0** | Introduit. |

## Documentation conceptuelle

* [Retour de force dans GameInput](/fr-CA/build/core-features/common/input/advanced/input-forcefeedback)


## Related topics

- [GameInputForceFeedbackRampParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackrampparams.md)
- [GameInputForceFeedbackConstantParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackconstantparams.md)
- [GameInputForceFeedbackPeriodicParams](/fr-CA/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams.md)
- [IGameInputForceFeedbackEffect::SetParams](/fr-CA/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/methods/igameinputforcefeedbackeffect_setparams.md)
- [GameInputForceFeedbackEffectKind](/fr-CA/reference/input/gameinput/enums/gameinputforcefeedbackeffectkind.md)
