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

Recupera uma exibição da leitura de entrada que descreve o estado de um mouse.

## Sintaxe

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

### Parâmetros

*state*   \_Out\_\
Tipo: [GameInputMouseState\*](/pt-BR/reference/input/gameinput/structs/gameinputmousestate)

Interpretação da entrada como um mouse.

### Valor retornado

Tipo: bool

Retorna true quando uma entrada de mouse é interpretada com êxito. Retorna false ao tentar ler uma entrada que não é reconhecida como uma entrada de mouse.

## Comentários

Chame o método [IGameInputReading::GetInputKind](/pt-BR/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind) para ver quais funções Get\*State retornarão uma interpretação válida para determinada [IGameInputReading](/pt-BR/reference/input/gameinput/interfaces/igameinputreading/igameinputreading). Cada função Get\*State tem uma entrada correspondente na enumeração [IGameInputReading::GetInputKind](/pt-BR/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind). Se você tentar chamar uma função Get\*State cujo sinalizador correspondente de [IGameInputReading::GetInputKind](/pt-BR/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind) não esteja definido, a função retornará valores padrão de repouso, além de um valor retornado false.

O movimento do mouse é relatado nativamente pelo dispositivo como valores delta relativos e/ou valores absolutos, dependendo dos recursos do dispositivo. Posições relativas não são muito compatíveis com uma API de sondagem, porque solicitar periodicamente a leitura atual do mouse provavelmente fará perder vários deltas intermediários. Em vez de forçar os aplicativos que usam as APIs de sondagem a percorrer potencialmente dezenas de leituras históricas do mouse e somar os deltas, a API GameInput expõe o movimento relativo do mouse acumulando continuamente os deltas em um valor virtual de "posição". Os aplicativos então calculam seus próprios deltas subtraindo o valor de "posição" da leitura anterior que obtiveram. Isso permite acessar deltas individuais quando calculados para leituras consecutivas, ou deltas acumulados quando leituras intermediárias foram ignoradas intencionalmente. Vale ressaltar que o valor de "posição" do mouse é apenas a soma de todos os deltas de movimento e não tem nenhuma correlação com coordenadas do espaço da tela.

## Requisitos

**Cabeçalho:** GameInput.h

[Visão geral da API de entrada](/pt-BR/build/core-features/common/input/overviews/input-overview)\
[IGameInputReading](/pt-BR/reference/input/gameinput/interfaces/igameinputreading/igameinputreading)

## Histórico de versões

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


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