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

> Recupera as propriedades de mouse do dispositivo, como os botões com suporte, a taxa de amostragem e as rodas de rolagem.

Recupera as propriedades de mouse do dispositivo, como os botões com suporte, a taxa de amostragem e as rodas de rolagem.

## Sintaxe

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

### Parâmetros

*info*   \_Out\_\
Tipo: [GameInputMouseInfo](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputmouseinfo.md)\*

Ponteiro para uma estrutura `GameInputMouseInfo` que recebe as propriedades de mouse do dispositivo. Se o dispositivo não oferecer suporte à entrada de mouse, todos os membros da estrutura serão definidos como zero.

### Valor retornado

Tipo: bool

`true` se o dispositivo oferecer suporte à entrada de mouse e *info* tiver sido preenchido; caso contrário, `false`.

## Comentários

O método `GetMouseInfo` copia as propriedades de mouse do dispositivo para a estrutura fornecida pelo chamador. Um dispositivo oferece suporte à entrada de mouse quando o valor retornado por [GetSupportedInput](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md) inclui `GameInputKindMouse`. Se o dispositivo não oferecer suporte à entrada de mouse, `GetMouseInfo` inicializará *info* com zeros e retornará `false`.

O membro `supportedButtons` relata quais [GameInputMouseButtons](https://docs.xbox.com/pt-BR/reference/input/gameinput/enums/gameinputmousebuttons.md) o mouse tem, e os membros `hasWheelX` e `hasWheelY` relatam se o mouse tem rodas de rolagem horizontal e vertical. O estado do mouse é lido das leituras por meio de [IGameInputReading::GetMouseState](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getmousestate.md).

As propriedades retornadas por este método são fixas durante o tempo de vida do dispositivo, portanto você pode consultá-las uma vez (por exemplo, quando o dispositivo se conecta) e armazenar o resultado em cache.

O exemplo a seguir mostra como consultar as propriedades de mouse de um dispositivo.

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

No GameInput v3 e anteriores, essas informações estavam disponíveis no membro `mouseInfo` da estrutura [GameInputDeviceInfo](https://docs.xbox.com/pt-BR/reference/input/gameinput/deprecated/structs/gameinputdeviceinfo.md) retornada por [IGameInputDevice::GetDeviceInfo](https://docs.xbox.com/pt-BR/reference/input/gameinput/deprecated/interfaces/igameinputdevice/methods/igameinputdevice_getdeviceinfo.md).

## Requisitos

**Cabeçalho:** GameInput.h

**Biblioteca:** gameinput.lib

**Plataformas com suporte:** Windows, consoles da família XBOX One e consoles XBOX Series

## Confira também

[Visão geral do GameInput](https://docs.xbox.com/pt-BR/build/core-features/common/input/overviews/input-overview.md)\
[GameInputMouseInfo](https://docs.xbox.com/pt-BR/reference/input/gameinput/structs/gameinputmouseinfo.md)\
[GetSupportedInput](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/methods/igameinputdevice_getsupportedinput.md)\
[GameInputKind](https://docs.xbox.com/pt-BR/reference/input/gameinput/enums/gameinputkind.md)\
[GameInputMouseButtons](https://docs.xbox.com/pt-BR/reference/input/gameinput/enums/gameinputmousebuttons.md)\
[IGameInputReading::GetMouseState](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getmousestate.md)\
[IGameInputDevice](https://docs.xbox.com/pt-BR/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice.md)

## Histórico de versões

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


## Related topics

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