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

# IGameInputDevice::GetMouseInfo

> Récupère les propriétés de souris du périphérique, comme les boutons qu'il prend en charge, sa fréquence d'échantillonnage et ses molettes de défilement.

Récupère les propriétés de souris du périphérique, comme les boutons qu'il prend en charge, sa fréquence d'échantillonnage et ses molettes de défilement.

## Syntaxe

```cpp theme={null}
bool GetMouseInfo(
    GameInputMouseInfo* info
);
```

### Paramètres

*info*   \_Out\_\
Type : [GameInputMouseInfo](https://docs.xbox.com/fr/reference/input/gameinput/structs/gameinputmouseinfo.md)\*

Pointeur vers une structure `GameInputMouseInfo` qui reçoit les propriétés de souris du périphérique. Si le périphérique ne prend pas en charge l'entrée souris, tous les membres de la structure sont définis sur zéro.

### Valeur de retour

Type : bool

`true` si le périphérique prend en charge l'entrée souris et que *info* a été renseigné ; sinon, `false`.

## Remarques

La méthode `GetMouseInfo` copie les propriétés de souris du périphérique dans la structure fournie par l'appelant. Un périphérique prend en charge l'entrée souris lorsque la valeur retournée par [GetSupportedInput](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md) inclut `GameInputKindMouse`. Si le périphérique ne prend pas en charge l'entrée souris, `GetMouseInfo` initialise *info* à zéro et retourne `false`.

Le membre `supportedButtons` indique les boutons [GameInputMouseButtons](https://docs.xbox.com/fr/reference/input/gameinput/enums/gameinputmousebuttons.md) dont dispose la souris, et les membres `hasWheelX` et `hasWheelY` indiquent si la souris dispose de molettes de défilement horizontale et verticale. L'état de la souris est lu à partir des lectures à l'aide de [IGameInputReading::GetMouseState](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getmousestate.md).

Les propriétés retournées par cette méthode sont fixes pendant toute la durée de vie du périphérique ; vous pouvez donc les interroger une seule fois (par exemple, lors de la connexion du périphérique) et mettre le résultat en cache.

L'exemple suivant montre comment interroger les propriétés de souris d'un périphérique.

```cpp theme={null}
GameInputMouseInfo info;
if (device->GetMouseInfo(&info))
{
    if (info.hasWheelY)
    {
        // Enable scroll-wheel controls.
    }
}
```

Dans GameInput v3 et les versions antérieures, ces informations étaient disponibles via le membre `mouseInfo` de la structure [GameInputDeviceInfo](https://docs.xbox.com/fr/reference/input/gameinput/deprecated/structs/gameinputdeviceinfo.md) retournée par [IGameInputDevice::GetDeviceInfo](https://docs.xbox.com/fr/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_getdeviceinfo.md).

## Configuration requise

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

**Bibliothèque :** gameinput.lib

**Plateformes prises en charge :** Windows, consoles de la famille XBOX One et consoles XBOX Series

## Voir aussi

[Vue d'ensemble de GameInput](https://docs.xbox.com/fr/build/core-features/common/input/overviews/input-overview.md)\
[GameInputMouseInfo](https://docs.xbox.com/fr/reference/input/gameinput/structs/gameinputmouseinfo.md)\
[GetSupportedInput](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md)\
[GameInputKind](https://docs.xbox.com/fr/reference/input/gameinput/enums/gameinputkind.md)\
[GameInputMouseButtons](https://docs.xbox.com/fr/reference/input/gameinput/enums/gameinputmousebuttons.md)\
[IGameInputReading::GetMouseState](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getmousestate.md)\
[IGameInputDevice](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice.md)

## Historique des versions

| Version | Modifications |
| - | - |
| **v4** | Introduite. |


## Related topics

- [GameInputMouseInfo](https://docs.xbox.com/fr/reference/input/gameinput/structs/gameinputmouseinfo.md)
- [IGameInputDevice::GetInputReportInfo](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getinputreportinfo.md)
- [IGameInputDevice::GetKeyboardInfo](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getkeyboardinfo.md)
- [IGameInputDevice::GetGamepadInfo](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getgamepadinfo.md)
- [IGameInputDevice::GetSensorsInfo](https://docs.xbox.com/fr/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsensorsinfo.md)