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

# GameInputMouseState

> GameInputMouseState

# GameInputMouseState

Descreve o estado de um mouse.

<a id="syntaxSection" />

## Sintaxe

```cpp theme={null}
struct GameInputMouseState
{
    GameInputMouseButtons   buttons;
    GameInputMousePositions positions;
    int64_t                 positionX;
    int64_t                 positionY;
    int64_t                 absolutePositionX;
    int64_t                 absolutePositionY;
    int64_t                 wheelX;
    int64_t                 wheelY;
};
```

<a id="membersSection" />

### Membros

*buttons*<br />
Tipo: [GameInputMouseButtons](/pt-BR/reference/input/gameinput/enums/gameinputmousebuttons)

Estado dos botões do mouse.

*positionFlags*<br />
Tipo: [GameInputMousePosition](/pt-BR/reference/input/gameinput/enums/gameInputmousepositions)

Estado das posições do mouse.

*positionX*<br />
Tipo: int64\_t

Alteração cumulativa no eixo x da posição do mouse.

*positionY*<br />
Tipo: int64\_t

Alteração cumulativa no eixo y da posição do mouse.

*absolutePositionX*<br />
Tipo: int64\_t

Posição absoluta do mouse no eixo x.

*absolutePositionY*<br />
Tipo: int64\_t

Posição absoluta do mouse no eixo y.

*wheelX*<br />
Tipo: int64\_t

Alteração cumulativa na roda de rolagem do eixo x.

*wheelY*<br />
Tipo: int64\_t

Alteração cumulativa na roda de rolagem do eixo y.

<a id="remarksSection" />

## Comentários

Essa estrutura é usada pelo método [IGameInputReading::GetMouseState](/pt-BR/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getmousestate).

Os movimentos do mouse e da roda de rolagem não são relatados como posições absolutas. Calcule os deltas subtraindo os valores da leitura atual dos valores da leitura anterior.

O GameInput apresentará todos os dispositivos de trackpad disponíveis como um único dispositivo de mouse virtual.

Para obter mais informações, confira [Leituras do GameInput](/pt-BR/build/core-features/common/input/overviews/input-readings).

<a id="requirementsSection" />

## Requisitos

**Cabeçalho:** GameInput.h

**Plataformas compatíveis:** Windows, consoles da família XBOX One e consoles XBOX Series

<a id="seealsoSection" />

## Documentação conceitual

* [Teclado e mouse no GameInput](/pt-BR/build/core-features/common/input/advanced/input-keyboard-mouse)

## Confira também

[Visão geral do GameInput](/pt-BR/build/core-features/common/input/overviews/input-overview)\
[GameInput](/pt-BR/reference/input/gameinput/gameinput_members)

## Histórico de versões

| Versão | Alterações |
| - | - |
| **v1** | **Adicionados** os campos `positions` (bitmask GameInputMousePositions) e `absolutePositionX`/`absolutePositionY`. |
| **v0** | Introduzido. |

## Apêndice: versões anteriores

### v0

```cpp theme={null}
struct GameInputMouseState
{
    GameInputMouseButtons buttons;
    int64_t               positionX;
    int64_t               positionY;
    int64_t               wheelX;
    int64_t               wheelY;
};
```


## Related topics

- [GameInputMouseState](/reference/input/gameinput/structs/gameinputmousestate.md)
- [IGameInputReading::GetMouseState](/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getmousestate.md)
- [GameInputMousePositions](/reference/input/gameinput/enums/gameInputmousepositions.md)
- [GameInputMouseButtons](/reference/input/gameinput/enums/gameinputmousebuttons.md)
- [Keyboards and mice in GameInput](/build/core-features/common/input/advanced/input-keyboard-mouse.md)