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

# GameInputForceFeedbackParams

> GameInputForceFeedbackParams

# GameInputForceFeedbackParams

Define os atributos compatíveis com a API de um efeito de force feedback.

## Sintaxe

```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;
};
```

### Membros

*kind*\

Tipo: [GameInputForceFeedbackEffectKind](https://docs.xbox.com/pt-BR/reference/input/gameinput/enums/gameinputforcefeedbackeffectkind.md)

Define o tipo de um efeito de force feedback.

*constant*\

Tipo: [GameInputForceFeedbackConstantParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackconstantparams.md)

Efeito de force feedback constante. A força é aplicada em um nível constante durante o efeito.

*ramp*\

Tipo: [GameInputForceFeedbackRampParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackrampparams.md)

Efeito de force feedback de rampa. A força é aplicada gradualmente, aumentando ou diminuindo ao longo da duração do efeito.

*sineWave*\

Tipo: [GameInputForceFeedbackPeriodicParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams.md)

Efeito de force feedback de onda senoidal. A força é aplicada em um padrão de onda senoidal.

*squareWave*\

Tipo: [GameInputForceFeedbackPeriodicParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams.md)

Efeito de force feedback de onda quadrada. A força é aplicada em um padrão de onda quadrada.

*triangleWave*\

Tipo: [GameInputForceFeedbackPeriodicParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams.md)

Efeito de force feedback de onda triangular. A força é aplicada em um padrão de onda triangular.

*sawtoothUpWave*\

Tipo: [GameInputForceFeedbackPeriodicParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams.md)

Efeito de force feedback de onda dente de serra ascendente. A força é aplicada em um padrão de onda dente de serra ascendente.

*sawtoothDownWave*\

Tipo: [GameInputForceFeedbackPeriodicParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams.md)

Efeito de force feedback de onda dente de serra descendente. A força é aplicada em um padrão de onda dente de serra descendente.

*spring*\

Tipo: [GameInputForceFeedbackConditionParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackconditionparams.md)

Efeito de force feedback de mola. A força é aplicada em oposição a um estado definido.

*friction*\

Tipo: [GameInputForceFeedbackConditionParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackconditionparams.md)

Efeito de force feedback de atrito. A força é aplicada para simular atrito.

*damper*\

Tipo: [GameInputForceFeedbackConditionParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackconditionparams.md)

Efeito de force feedback de amortecimento. A força é aplicada para simular um efeito de amortecedor.

*inertia*\

Tipo: [GameInputForceFeedbackConditionParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackconditionparams.md)

Efeito de force feedback de inércia. A força é aplicada para simular um efeito de inércia.

## Comentários

Os efeitos de force feedback são definidos por seus parâmetros. Esses efeitos são armazenados na estrutura `GameInputForceFeedbackParams`. Os parâmetros reais de cada tipo de efeito de force feedback variam ligeiramente. Os parâmetros de todos os tipos de efeitos definem a magnitude do efeito ao longo dos eixos compatíveis do motor, e a maioria permite um envelope que afeta a intensidade do efeito ao longo do tempo.

## Requisitos

**Cabeçalho:** GameInput.h

[Tópicos avançados do GameInput](https://docs.xbox.com/pt-BR/build/core-features/common/input/advanced/input-advanced-topics.md)\
[Visão geral do GameInput](https://docs.xbox.com/pt-BR/build/core-features/common/input/overviews/input-overview.md)\
[GameInputForceFeedbackEffectKind](https://docs.xbox.com/pt-BR/reference/input/gameinput/enums/gameinputforcefeedbackeffectkind.md)\
[GameInput](https://docs.xbox.com/pt-BR/reference/input/gameinput/gameinput_members.md)

## Histórico de versões

| Versão | Alterações |
| - | - |
| **v0** | Introduzido. |

## Documentação conceitual

* [Force feedback no GameInput](https://docs.xbox.com/pt-BR/build/core-features/common/input/advanced/input-forcefeedback.md)


## Related topics

- [GameInputForceFeedbackRampParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackrampparams.md)
- [GameInputForceFeedbackPeriodicParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams.md)
- [GameInputForceFeedbackConstantParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputforcefeedbackconstantparams.md)
- [Force feedback no GameInput](https://docs.xbox.com/pt-BR/build/core-features/common/input/advanced/input-forcefeedback.md)
- [IGameInputForceFeedbackEffect::SetParams](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/methods/igameinputforcefeedbackeffect_setparams.md)