XInputGetState 関数 (xinput.h)

[アーティクル]
03/05/2024

指定したコントローラーの現在の状態を取得します。

構文

DWORD XInputGetState(
  [in]  DWORD        dwUserIndex,
  [out] XINPUT_STATE *pState
);

パラメーター

[in] dwUserIndex

ユーザーのコントローラーのインデックス。 0 ~ 3 の値を指定できます。この値の決定方法と、値がコントローラー上のインジケーターにどのようにマップされるかについては、「複数のコントローラー」を参照してください。

[out] pState

コントローラーの現在の状態を受け取る XINPUT_STATE 構造体へのポインター。

戻り値

関数が成功した場合、戻り値は ERROR_SUCCESS。

コントローラーが接続されていない場合、戻り値は ERROR_DEVICE_NOT_CONNECTED。

関数が失敗した場合、戻り値は Winerror.h で定義されたエラーコードです。関数は、呼び出し元のスレッドの最後のエラーコードを設定するために SetLastError を使用しません。

注釈

XInputGetState を使用してコントローラーデータを取得する場合、左右のトリガーはそれぞれ個別に報告されます。従来の理由から、DirectInput がコントローラーデータを取得すると、2 つのトリガーは同じ軸を共有します。従来の動作は、コントローラーの状態に DirectInput を使用する現在の Game Device コントロールパネルで顕著です。

プラットフォームの要件

Windows 8 (XInput 1.4)、DirectX SDK (XInput 1.3)、Windows Vista (XInput 9.1.0)

要件

要件	値
対象プラットフォーム	Windows
ヘッダー	xinput.h
Library	Xinput.lib;Xinput9_1_0.lib
[DLL]	Xinput1_4.dll;Xinput9_1_0.dll;Xinputuap.dll