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

# GetMouseState

> IGameInputReading::GetMouseState

# IGameInputReading::GetMouseState

マウスの状態を表す入力読み取りのビューを取得します。

## 構文

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

### パラメーター

*state*   \_Out\_\
型: [GameInputMouseState\*](https://docs.xbox.com/ja-jp/reference/input/gameinput/structs/gameinputmousestate.md)

入力をマウスとして解釈したものです。

### 戻り値

型: bool

マウス入力として正常に解釈できた場合は true を返します。マウス入力として認識されない入力を読み取ろうとした場合は false を返します。

## 解説

ある [IGameInputReading](https://docs.xbox.com/ja-jp/reference/input/gameinput/interfaces/igameinputreading/igameinputreading.md) について、どの Get\*State 関数が有効な解釈を返すかを確認するには、[IGameInputReading::GetInputKind](https://docs.xbox.com/ja-jp/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind.md) メソッドを呼び出します。各 Get\*State 関数には、[IGameInputReading::GetInputKind](https://docs.xbox.com/ja-jp/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind.md) 列挙型に対応するエントリがあります。対応する [IGameInputReading::GetInputKind](https://docs.xbox.com/ja-jp/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getinputkind.md) フラグが設定されていない状態で Get\*State 関数を呼び出そうとすると、関数はデフォルトの静止値と共に false の戻り値を返します。

マウスの移動は、デバイスの機能に応じて、デバイスからネイティブに相対的なデルタ値および/または絶対値として報告されます。相対的な位置はポーリング API とはあまり相性がよくありません。定期的に現在のマウスの読み取りを要求すると、中間のいくつかのデルタを見逃してしまう可能性が高いからです。ポーリング API を使用するアプリに、数十にもなる可能性がある過去のマウスの読み取りを走査してデルタを合計させる代わりに、GameInput API は、デルタを仮想的な "位置" の値へ継続的に累積することで相対的なマウスの動きを公開します。アプリケーションは、以前に取得した読み取りから "位置" の値を差し引くことにより、独自のデルタを計算します。これにより、連続する読み取りに対して計算した場合には個々のデルタにアクセスでき、中間の読み取りを意図的にスキップした場合には累積されたデルタにアクセスできます。強調しておきますが、マウスの "位置" の値は単にすべての移動デルタの合計であり、画面空間の座標とはまったく関係ありません。

## 要件

**ヘッダー:** GameInput.h

[Input API の概要](https://docs.xbox.com/ja-jp/build/core-features/common/input/overviews/input-overview.md)\
[IGameInputReading](https://docs.xbox.com/ja-jp/reference/input/gameinput/interfaces/igameinputreading/igameinputreading.md)

## バージョン履歴

| バージョン | 変更点 |
| - | - |
| **v0** | 導入。 |


## Related topics

- [GameInputMouseButtons](https://docs.xbox.com/ja-jp/reference/input/gameinput/enums/gameinputmousebuttons.md)
- [XINPUT_STATE](https://docs.xbox.com/ja-jp/reference/input/xinputongameinput/structs/xinput_state.md)
- [GetKeyState](https://docs.xbox.com/ja-jp/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getkeystate.md)
- [GetGamepadState](https://docs.xbox.com/ja-jp/reference/input/gameinput/interfaces/igameinputreading/methods/igameinputreading_getgamepadstate.md)
- [XUserGetState](https://docs.xbox.com/ja-jp/reference/system/xuser/functions/xusergetstate.md)