GameInput
GameInput API は、ゲーム コントローラー、フライト スティック、レーシング ホイール、タッチ入力など、さまざまなデバイスから人間の入力をキャプチャするために使用されます。このページでは、現在の (最新の) GameInput API について説明します。各メンバーのバージョン履歴は個別のリファレンス ページに記載されています。以前の API バージョンにのみ存在していたメンバーは、以下の 削除されたメンバー セクションにリストされています。API の新しいランタイムはすべての利用可能な API バージョンをサポートしているため、削除されたメンバーは以前のバージョンのヘッダーで引き続き使用できます。
インターフェイス
| インターフェイス | 説明 |
|---|---|
| IGameInputDevice | 入力デバイスを定義します。 |
| IGameInputDispatcher | GameInput API によって管理されるバックグラウンド タスクのスケジューリングを手動で制御します。 |
| IGameInputForceFeedbackEffect | 互換性のある入力デバイスに対するフォース フィードバック効果を記述します。 |
| IGameInputMapper | GameInput がデバイスをどのようにマップするかに関する情報を提供します。 |
| IGameInputRawDeviceReport | 入力デバイスとの間で受け渡しされる raw バイト バッファーを表します。 |
| IGameInputReading | 単一の入力更新のデータが含まれます。 |
| IGameInput | デバイス入力ストリームへのアクセスを提供するプロセス単位のシングルトン。 |
関数
| 関数 | 説明 |
|---|---|
| GameInputCreate | IGameInput インターフェイスのインスタンスを取得します。 |
| GameInputDeviceCallback | デバイスの接続と切断イベント用のコールバックを定義します。 |
| GameInputKeyboardLayoutCallback | キーボード レイアウト変更イベント用のコールバックを定義します。 |
| GameInputReadingCallback | 新しい読み取り値到着イベント用のコールバックを定義します。 |
| GameInputSystemButtonCallback | Guide または Share ボタンの押下と解放イベント用のコールバックを定義します。 |
構造体
| 構造体 | 説明 |
|---|---|
| GameInputArcadeStickInfo | アーケード スティックの特性を詳細に示します。 |
| GameInputArcadeStickState | アーケード スティックの現在の状態を提供します。 |
| GameInputAxisMapping | 軸がコントローラーにどのようにマップされるかを記述します。 |
| GameInputButtonMapping | ボタンがコントローラーにどのようにマップされるかを記述します。 |
| GameInputControllerInfo | コントローラーの特性を詳細に示します。 |
| GameInputControllerSwitchInfo | 入力デバイスのスイッチを指定します。 |
| GameInputDeviceInfo | 入力デバイスに関する包括的な情報が含まれます。 |
| GameInputFlightStickInfo | フライト スティックの特性を詳細に示します。 |
| GameInputFlightStickState | フライト スティックの現在の状態を提供します。 |
| GameInputForceFeedbackConditionParams | フォース フィードバック効果の特定の物理的側面を定義します。 |
| GameInputForceFeedbackConstantParams | フォース フィードバック効果の一定の物理的側面を定義します。 |
| GameInputForceFeedbackEnvelope | フォース フィードバック効果を変更するエンベロープを定義します。 |
| GameInputForceFeedbackMagnitude | フォース フィードバック効果によって加えられる力の大きさを定義します。 |
| GameInputForceFeedbackMotorInfo | フォース フィードバック モーターに関する情報を提供します。 |
| GameInputForceFeedbackParams | フォース フィードバック効果の API がサポートする属性を定義します。 |
| GameInputForceFeedbackPeriodicParams | 周期的なフォース フィードバック効果のパラメーターを定義します。 |
| GameInputForceFeedbackRampParams | ランプ フォース フィードバック効果のパラメーターを定義します。 |
| GameInputGamepadInfo | ゲームパッドの特性を詳細に示します。 |
| GameInputGamepadState | ゲームパッド入力デバイスの現在の状態を提供します。 |
| GameInputHapticInfo | 触覚フィードバック モーターの特性を詳細に示します。 |
| GameInputKeyState | キーボード上のキーの現在の状態を提供します。 |
| GameInputKeyboardInfo | キーボードの特性を詳細に示します。 |
| GameInputMouseInfo | マウスの特性を詳細に示します。 |
| GameInputMouseState | マウスの現在の状態を提供します。 |
| GameInputRacingWheelInfo | レーシング ホイールの特性を詳細に示します。 |
| GameInputRacingWheelState | レーシング ホイールの現在の状態を提供します。 |
| GameInputRawDeviceReportInfo | raw デバイス レポートを記述します。 |
| GameInputRumbleParams | コントローラーが生成するランブル効果を記述します。 |
| GameInputSensorsInfo | 利用可能なセンサーの特性を詳細に示します。 |
| GameInputSensorsState | デバイスのセンサーの現在の状態を提供します。 |
| GameInputUsage | 特定の HID 用途を記述します。 |
| GameInputVersion | 4 つの部分からなるバージョン番号を記述します。 |
列挙型
| 列挙型 | 説明 |
|---|---|
| GameInputArcadeStickButtons | アーケード スティックからの入力を列挙します。 |
| GameInputDeviceFamily | 入力デバイスのファミリを列挙します。 |
| GameInputDeviceStatus | 入力デバイスが取り得る状態を列挙します。 |
| GameInputElementKind | 指定された入力の要素の種類を列挙します。 |
| GameInputEnumerationKind | 入力デバイスを列挙する際の動作の種類を列挙します。 |
| GameInputFeedbackAxes | 入力デバイスで利用可能なフォース フィードバック モーターの方向の種類を列挙します。 |
| GameInputFeedbackEffectState | フォース フィードバック効果の状態を列挙します。 |
| GameInputFlightStickAxes | フライト スティックの軸を列挙します。 |
| GameInputFlightStickButtons | フライト スティックのボタンを列挙します。 |
| GameInputFocusPolicy | 入力デバイスのフォーカス ポリシーを列挙します。 |
| GameInputForceFeedbackEffectKind | フォース フィードバック効果に適用できる、時間経過に伴う大きさの効果の種類を列挙します。 |
| GameInputGamepadAxes | ゲームパッドの軸を列挙します。 |
| GameInputGamepadButtons | 方向パッド (D-pad) を含むゲームパッドのボタンを列挙します。 |
| GameInputKeyboardKind | キー レイアウト別のキーボード タイプを列挙します。 |
| GameInputKind | 有効な GameInput デバイスの種類を列挙します。 |
| GameInputLabel | サポートされているボタン ラベルを列挙します。 |
| GameInputMouseButtons | マウス ボタンを列挙します。 |
| GameInputMousePositions | マウス位置指定モードを列挙します。 |
| GameInputRacingWheelAxes | レーシング ホイールの軸を列挙します。 |
| GameInputRacingWheelButtons | レーシング ホイール上のボタンを列挙します。 |
| GameInputRawDeviceReportKind | raw デバイス レポートの種類を列挙します。 |
| GameInputRumbleMotors | 入力デバイスの API がサポートするランブル モーターを列挙します。 |
| GameInputSensorAccuracy | センサーの精度レベルを列挙します。 |
| GameInputSensorsKind | 有効な GameInput センサーの種類を列挙します。 |
| GameInputSwitchKind | 入力デバイスがサポートするスイッチの種類を列挙します。 |
| GameInputSwitchPosition | 入力デバイス上のスイッチの位置を列挙します。 |
| GameInputSystemButtons | システムを制御するために使用されるボタンを列挙します。 |
削除されたメンバー
次のメンバーは以前の API バージョンには存在していましたが、現在の API から削除されています。削除された各メンバーの完全なドキュメントについては、非推奨の GameInput API メンバー を参照してください。削除されたインターフェイス
完全に削除されたインターフェイスはありません。IGameInputRawDeviceReport は v1 と v2 では存在しませんでしたが、現在の API で再導入されています。
削除された関数
| 関数 | 最終バージョン | 説明 |
|---|---|---|
| GameInputGuideButtonCallback | v0 | Guide ボタン イベント用のタイトル定義コールバック。GameInputSystemButtonCallback に置き換えられました。 |
削除された構造体
| 構造体 | 最終バージョン | 説明 |
|---|---|---|
| GameInputBatteryState | v0 | 入力デバイスのバッテリー状態を記述していました。 |
| GameInputControllerAxisInfo | v2 | 入力デバイスの軸を記述していました。GameInputControllerInfo のフィールドに置き換えられました。 |
| GameInputControllerButtonInfo | v2 | 入力デバイスのボタンを記述していました。GameInputControllerInfo のフィールドに置き換えられました。 |
| GameInputHapticFeedbackMotorInfo | v0 | 触覚フィードバック モーターを記述していました。GameInputHapticInfo に置き換えられました。 |
| GameInputHapticFeedbackParams | v0 | 触覚フィードバック効果を記述していました。 |
| GameInputHapticWaveformInfo | v0 | 触覚フィードバック効果の特性を記述していました。 |
| GameInputMotionInfo | v0 | モーション対応入力デバイスの測定可能なプロパティを記述していました。 |
| GameInputMotionState | v0 | モーション入力の状態を記述していました。 |
| GameInputRawDeviceItemCollectionInfo | v0 | raw デバイス項目のコレクションを記述していました。 |
| GameInputRawDeviceReportItemInfo | v0 | raw デバイス レポート項目を記述していました。 |
| GameInputString | v0 | 入力デバイスに関する情報を含む文字列を記述していました。 |
| GameInputTouchSensorInfo | v0 | 入力デバイスのタッチ センサーを記述していました。 |
| GameInputTouchState | v0 | タッチ入力デバイスの状態を記述していました。 |
| GameInputUiNavigationInfo | v2 | UI 内のナビゲーション ボタンのラベルを指定していました。 |
| GameInputUiNavigationState | v2 | UI ナビゲーション入力の現在の状態を提供していました。 |
削除された列挙型
| 列挙型 | 最終バージョン | 説明 |
|---|---|---|
| GameInputBatteryStatus | v0 | 入力デバイスのバッテリー状態を列挙していました。 |
| GameInputDeviceCapabilities | v0 | 入力デバイスの特定の機能を列挙していました。 |
| GameInputLocation | v0 | 入力デバイスの部分を列挙していました。 |
| GameInputMotionAccuracy | v0 | モーション センサーの精度レベルを列挙していました。 |
| GameInputRawDeviceItemCollectionKind | v0 | raw デバイス項目コレクションの種類を列挙していました。 |
| GameInputRawDevicePhysicalUnitKind | v0 | デバイス入力に関連付けられた物理単位を列挙していました。 |
| GameInputRawDeviceReportItemFlags | v0 | raw デバイス レポート項目の種類を列挙していました。 |
| GameInputTouchShape | v0 | タッチ センサーの形状を列挙していました。 |
| GameInputUiNavigationButtons | v2 | UI ナビゲーション ボタンを列挙していました。 |
バージョン履歴
| バージョン | 変更内容 |
|---|---|
| v3 | IGameInputMapper インターフェイスを追加。IGameInputRawDeviceReport インターフェイスを再導入 (v1/v2 では欠落していました)。GameInputAxisMapping、GameInputButtonMapping、GameInputControllerInfo、GameInputHapticInfo 構造体を追加。GameInputRawDeviceReportInfo 構造体と GameInputRawDeviceReportKind 列挙型を再導入 (v1/v2 では欠落)。GameInputVersion 構造体を再導入 (v1/v2 では欠落)。GameInputElementKind、GameInputFlightStickAxes、GameInputGamepadAxes、GameInputRacingWheelAxes 列挙型を追加。GameInputControllerAxisInfo、GameInputControllerButtonInfo、GameInputUiNavigationInfo、GameInputUiNavigationState 構造体を削除。GameInputUiNavigationButtons 列挙型を削除。 |
| v2 | GameInputSensorsInfo、GameInputSensorsState 構造体を追加。GameInputSensorsKind、GameInputSensorAccuracy 列挙型を追加。IGameInputDevice::DirectInputEscape、IGameInputDevice::GetHapticInfo を追加。IGameInputReading::GetSensorsState を追加。GameInputVersion 構造体を再導入 (v1 では欠落していました)。 |
| v1 | IGameInputRawDeviceReport インターフェイス、GameInputRawDeviceReportInfo 構造体、GameInputRawDeviceReportKind 列挙型を削除。GameInputVersion 構造体を削除。GameInputMousePositions 列挙型を追加。v0 のみの未実装の触覚、モーション、タッチ型 (GameInputBatteryState、GameInputHapticFeedbackMotorInfo、GameInputHapticFeedbackParams、GameInputHapticWaveformInfo、GameInputMotionInfo、GameInputMotionState、GameInputTouchSensorInfo、GameInputTouchState、GameInputString、GameInputRawDeviceItemCollectionInfo、GameInputRawDeviceReportItemInfo) を削除。 |
| v0 | 導入されました。 |