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

擷取描述滑鼠狀態的輸入讀數檢視。

## 語法

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

### 參數

*state*   \_Out\_\
類型：[GameInputMouseState\*](/zh-TW/reference/input/gameinput/structs/gameinputmousestate)

將輸入解譯為滑鼠的結果。

### 傳回值

類型：bool

成功解譯為滑鼠輸入時傳回 true。嘗試讀取無法辨識為滑鼠輸入的輸入時傳回 false。

## 備註

呼叫 [IGameInputReading::GetInputKind](/zh-TW/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind) 方法，以查看哪些 Get\*State 函式會針對某個 [IGameInputReading](/zh-TW/reference/input/gameinput/interfaces/igameinputreading/igameinputreading) 傳回有效的解譯。每個 Get\*State 函式在 [IGameInputReading::GetInputKind](/zh-TW/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind) 列舉中都有對應的項目。如果您在未設定對應 [IGameInputReading::GetInputKind](/zh-TW/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind) 旗標的情況下呼叫 Get\*State 函式，該函式會傳回預設的靜止值，並傳回 false。

視裝置功能而定，裝置會原生以相對差異值和/或絕對值回報滑鼠移動。相對位置與輪詢 API 不太相容，因為定期要求目前的滑鼠讀數，很可能會遺漏數個中間的差異值。GameInput API 不會強迫使用輪詢 API 的應用程式逐一查看可能多達數十筆的歷史滑鼠讀數並加總差異值，而是持續將差異值累加至虛擬的「位置」值，藉此公開相對的滑鼠移動。應用程式接著會將「位置」值減去先前取得之讀數的值，自行計算差異值。這樣一來，針對連續的讀數計算時可存取個別的差異值，而刻意略過中間讀數時則可存取累加的差異值。必須強調的是，滑鼠的「位置」值只是所有移動差異值的總和，與螢幕空間座標沒有任何關聯。

## 需求

**標頭：** GameInput.h

[輸入 API 概觀](/zh-TW/build/core-features/common/input/overviews/input-overview)\
[IGameInputReading](/zh-TW/reference/input/gameinput/interfaces/igameinputreading/igameinputreading)

## 版本歷程記錄

| 版本 | 變更 |
| - | - |
| **v0** | 推出。 |


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