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

# IGameInputReading::GetMouseState

> IGameInputReading::GetMouseState

# IGameInputReading::GetMouseState

Récupère une vue de la lecture d'entrée qui décrit l'état d'une souris.

## Syntaxe

```cpp theme={null}
bool GetMouseState(
    GameInputMouseState* state
);
```

### Paramètres

*state*   \_Out\_\
Type : [GameInputMouseState\*](/fr/reference/input/gameinput/structs/gameinputmousestate)

Interprétation de l'entrée en tant que souris.

### Valeur de retour

Type : bool

Retourne true si l'interprétation en tant qu'entrée de souris réussit. Retourne false lors d'une tentative de lecture d'une entrée qui n'est pas reconnue comme une entrée de souris.

## Remarques

Appelez la méthode [IGameInputReading::GetInputKind](/fr/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind) pour savoir quelles fonctions Get\*State retourneront une interprétation valide pour un [IGameInputReading](/fr/reference/input/gameinput/interfaces/igameinputreading/igameinputreading) donné. Chaque fonction Get\*State a une entrée correspondante dans l'énumération [IGameInputReading::GetInputKind](/fr/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind). Si vous tentez d'appeler une fonction Get\*State pour laquelle l'indicateur [IGameInputReading::GetInputKind](/fr/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind) correspondant n'est pas défini, la fonction retourne des valeurs au repos par défaut ainsi que la valeur de retour false.

Le mouvement de la souris est signalé nativement par l'appareil sous forme de valeurs delta relatives et/ou de valeurs absolues, selon les fonctionnalités de l'appareil. Les positions relatives sont peu compatibles avec une API d'interrogation, car demander périodiquement la lecture actuelle de la souris risque de manquer plusieurs deltas intermédiaires. Plutôt que d'obliger les applications qui utilisent les API d'interrogation à parcourir potentiellement des dizaines de lectures de souris historiques et à additionner les deltas, l'API GameInput expose le mouvement relatif de la souris en accumulant continuellement les deltas dans une valeur de « position » virtuelle. Les applications calculent ensuite leurs propres deltas en soustrayant la valeur de « position » de la lecture précédente qu'elles ont obtenue. Cela permet d'accéder aux deltas individuels lorsqu'ils sont calculés pour des lectures consécutives, ou aux deltas cumulés lorsque des lectures intermédiaires ont été intentionnellement ignorées. Il convient de souligner que la valeur de « position » de la souris n'est que la somme de tous les deltas de mouvement et n'a aucune corrélation avec les coordonnées de l'espace écran.

## Configuration requise

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

[Vue d'ensemble de l'API Input](/fr/build/core-features/common/input/overviews/input-overview)\
[IGameInputReading](/fr/reference/input/gameinput/interfaces/igameinputreading/igameinputreading)

## Historique des versions

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


## Related topics

- [IGameInputReading::GetMouseState](/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getmousestate.md)
- [GameInputMouseState](/reference/input/gameinput/structs/gameinputmousestate.md)
- [IGameInputReading::GetGamepadState](/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getgamepadstate.md)
- [IGameInputReading::GetSensorsState](/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getsensorsstate.md)