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

# GameInput

> GameInput

# GameInput

GameInput API 用於擷取來自各種裝置的人為輸入，例如遊戲控制器、飛行搖桿、賽車方向盤和觸控輸入。

<Note>此頁面記載目前 (最新) 的 GameInput API。每個成員的版本歷程記錄都註明於個別的參考頁面中。僅存在於舊版 API 中的成員，列於下方的 [已移除的成員](#removed-members) 一節。請注意，較新的 API 執行階段支援所有可用的 API 版本，因此已移除的成員仍可搭配舊版的標頭使用。</Note>

## 介面

| 介面 | 描述 |
| - | - |
| [IGameInputDevice](/zh-TW/reference/input/gameinput/interfaces/igameinputdevice/igameinputdevice) | 定義輸入裝置。 |
| [IGameInputDispatcher](/zh-TW/reference/input/gameinput/interfaces/IGameInputDispatcher/igameinputdispatcher) | 提供手動控制 GameInput API 所管理背景工作之排程的功能。 |
| [IGameInputForceFeedbackEffect](/zh-TW/reference/input/gameinput/interfaces/igameinputforcefeedbackeffect/igameinputforcefeedbackeffect) | 描述相容輸入裝置上的力回饋效果。 |
| [IGameInputMapper](/zh-TW/reference/input/gameinput/interfaces/igameinputmapper/igameinputmapper) | 提供 GameInput 如何對應裝置的相關資訊。 |
| [IGameInputRawDeviceReport](/zh-TW/reference/input/gameinput/interfaces/igameinputrawdevicereport/igameinputrawdevicereport) | 代表傳送至輸入裝置或從輸入裝置傳送的原始位元組緩衝區。 |
| [IGameInputReading](/zh-TW/reference/input/gameinput/interfaces/igameinputreading/igameinputreading) | 包含單一輸入更新的資料。 |
| [IGameInput](/zh-TW/reference/input/gameinput/interfaces/igameinput/igameinput) | 提供裝置輸入串流存取權的個別處理序單一資料庫。 |

## 函式

| 函式 | 描述 |
| - | - |
| [GameInputCreate](/zh-TW/reference/input/gameinput/functions/gameinputcreate) | 擷取 IGameInput 介面的執行個體。 |
| [GameInputDeviceCallback](/zh-TW/reference/input/gameinput/functions/gameinputdevicecallback) | 定義用於裝置連線和中斷連線事件的回呼。 |
| [GameInputKeyboardLayoutCallback](/zh-TW/reference/input/gameinput/functions/gameinputkeyboardlayoutcallback) | 定義用於鍵盤配置變更事件的回呼。 |
| [GameInputReadingCallback](/zh-TW/reference/input/gameinput/functions/gameinputreadingcallback) | 定義用於新讀數抵達事件的回呼。 |
| [GameInputSystemButtonCallback](/zh-TW/reference/input/gameinput/functions/gameinputsystembuttoncallback) | 定義用於指南或分享按鈕按下和放開事件的回呼。 |

## 結構

| 結構 | 描述 |
| - | - |
| [GameInputArcadeStickInfo](/zh-TW/reference/input/gameinput/structs/gameinputarcadestickinfo) | 詳細說明大型電玩搖桿的特性。 |
| [GameInputArcadeStickState](/zh-TW/reference/input/gameinput/structs/gameinputarcadestickstate) | 提供大型電玩搖桿的目前狀態。 |
| [GameInputAxisMapping](/zh-TW/reference/input/gameinput/structs/gameinputaxismapping) | 描述軸如何對應至控制器。 |
| [GameInputButtonMapping](/zh-TW/reference/input/gameinput/structs/gameinputbuttonmapping) | 描述按鈕如何對應至控制器。 |
| [GameInputControllerInfo](/zh-TW/reference/input/gameinput/structs/gameinputcontrollerinfo) | 詳細說明控制器的特性。 |
| [GameInputControllerSwitchInfo](/zh-TW/reference/input/gameinput/structs/gameinputcontrollerswitchinfo) | 指定輸入裝置上的切換開關。 |
| [GameInputDeviceInfo](/zh-TW/reference/input/gameinput/structs/gameinputdeviceinfo) | 包含輸入裝置的完整資訊。 |
| [GameInputFlightStickInfo](/zh-TW/reference/input/gameinput/structs/gameinputflightstickinfo) | 詳細說明飛行搖桿的特性。 |
| [GameInputFlightStickState](/zh-TW/reference/input/gameinput/structs/gameinputflightstickstate) | 提供飛行搖桿的目前狀態。 |
| [GameInputForceFeedbackConditionParams](/zh-TW/reference/input/gameinput/structs/gameinputforcefeedbackconditionparams) | 定義力回饋效果的特定物理層面。 |
| [GameInputForceFeedbackConstantParams](/zh-TW/reference/input/gameinput/structs/gameinputforcefeedbackconstantparams) | 定義力回饋效果的固定物理層面。 |
| [GameInputForceFeedbackEnvelope](/zh-TW/reference/input/gameinput/structs/gameinputforcefeedbackenvelope) | 定義修改力回饋效果的包絡。 |
| [GameInputForceFeedbackMagnitude](/zh-TW/reference/input/gameinput/structs/gameinputforcefeedbackmagnitude) | 定義力回饋效果所施加之力的大小。 |
| [GameInputForceFeedbackMotorInfo](/zh-TW/reference/input/gameinput/structs/gameinputforcefeedbackmotorinfo) | 提供力回饋馬達的相關資訊。 |
| [GameInputForceFeedbackParams](/zh-TW/reference/input/gameinput/structs/gameinputforcefeedbackparams) | 定義 API 支援的力回饋效果屬性。 |
| [GameInputForceFeedbackPeriodicParams](/zh-TW/reference/input/gameinput/structs/gameinputforcefeedbackperiodicparams) | 定義週期性力回饋效果的參數。 |
| [GameInputForceFeedbackRampParams](/zh-TW/reference/input/gameinput/structs/gameinputforcefeedbackrampparams) | 定義漸變力回饋效果的參數。 |
| [GameInputGamepadInfo](/zh-TW/reference/input/gameinput/structs/gameinputgamepadinfo) | 詳細說明遊戲台的特性。 |
| [GameInputGamepadState](/zh-TW/reference/input/gameinput/structs/gameinputgamepadstate) | 提供遊戲台輸入裝置的目前狀態。 |
| [GameInputHapticInfo](/zh-TW/reference/input/gameinput/structs/gameinputhapticinfo) | 詳細說明觸覺回饋馬達的特性。 |
| [GameInputKeyState](/zh-TW/reference/input/gameinput/structs/gameinputkeystate) | 提供鍵盤上某個按鍵的目前狀態。 |
| [GameInputKeyboardInfo](/zh-TW/reference/input/gameinput/structs/gameinputkeyboardinfo) | 詳細說明鍵盤的特性。 |
| [GameInputMouseInfo](/zh-TW/reference/input/gameinput/structs/gameinputmouseinfo) | 詳細說明滑鼠的特性。 |
| [GameInputMouseState](/zh-TW/reference/input/gameinput/structs/gameinputmousestate) | 提供滑鼠的目前狀態。 |
| [GameInputRacingWheelInfo](/zh-TW/reference/input/gameinput/structs/gameinputracingwheelinfo) | 詳細說明賽車方向盤的特性。 |
| [GameInputRacingWheelState](/zh-TW/reference/input/gameinput/structs/gameinputracingwheelstate) | 提供賽車方向盤的目前狀態。 |
| [GameInputRawDeviceReportInfo](/zh-TW/reference/input/gameinput/structs/gameinputrawdevicereportinfo) | 描述原始裝置報告。 |
| [GameInputRumbleParams](/zh-TW/reference/input/gameinput/structs/gameinputrumbleparams) | 描述控制器產生的震動效果。 |
| [GameInputSensorsInfo](/zh-TW/reference/input/gameinput/structs/gameinputsensorsinfo) | 詳細說明可用感應器的特性。 |
| [GameInputSensorsState](/zh-TW/reference/input/gameinput/structs/gameinputsensorsstate) | 提供裝置感應器的目前狀態。 |
| [GameInputUsage](/zh-TW/reference/input/gameinput/structs/gameinputusage) | 描述特定的 HID 使用方式。 |
| [GameInputVersion](/zh-TW/reference/input/gameinput/structs/gameinputversion) | 描述四段式版本號碼。 |

## 列舉

| 列舉 | 描述 |
| - | - |
| [GameInputArcadeStickButtons](/zh-TW/reference/input/gameinput/enums/gameinputarcadestickbuttons) | 列舉來自大型電玩搖桿的輸入。 |
| [GameInputDeviceFamily](/zh-TW/reference/input/gameinput/enums/gameinputdevicefamily) | 列舉輸入裝置系列。 |
| [GameInputDeviceStatus](/zh-TW/reference/input/gameinput/enums/gameinputdevicestatus) | 列舉輸入裝置可能處於的狀態。 |
| [GameInputElementKind](/zh-TW/reference/input/gameinput/enums/gameinputelementkind) | 列舉指定輸入的元素種類。 |
| [GameInputEnumerationKind](/zh-TW/reference/input/gameinput/enums/gameinputenumerationkind) | 列舉輸入裝置列舉的行為類型。 |
| [GameInputFeedbackAxes](/zh-TW/reference/input/gameinput/enums/gameinputfeedbackaxes) | 列舉輸入裝置上可用之力回饋馬達的方向類型。 |
| [GameInputFeedbackEffectState](/zh-TW/reference/input/gameinput/enums/gameinputfeedbackeffectstate) | 列舉力回饋效果的狀態。 |
| [GameInputFlightStickAxes](/zh-TW/reference/input/gameinput/enums/gameinputflightstickaxes) | 列舉飛行搖桿軸。 |
| [GameInputFlightStickButtons](/zh-TW/reference/input/gameinput/enums/gameinputflightstickbuttons) | 列舉飛行搖桿按鈕。 |
| [GameInputFocusPolicy](/zh-TW/reference/input/gameinput/enums/gameinputfocuspolicy) | 列舉輸入裝置的焦點原則。 |
| [GameInputForceFeedbackEffectKind](/zh-TW/reference/input/gameinput/enums/gameinputforcefeedbackeffectkind) | 列舉可套用至力回饋效果的大小隨時間變化效果類型。 |
| [GameInputGamepadAxes](/zh-TW/reference/input/gameinput/enums/gameinputgamepadaxes) | 列舉遊戲台軸。 |
| [GameInputGamepadButtons](/zh-TW/reference/input/gameinput/enums/gameinputgamepadbuttons) | 列舉遊戲台按鈕，包括方向鍵 (D-pad)。 |
| [GameInputKeyboardKind](/zh-TW/reference/input/gameinput/enums/gameinputkeyboardkind) | 依按鍵配置列舉鍵盤類型。 |
| [GameInputKind](/zh-TW/reference/input/gameinput/enums/gameinputkind) | 列舉有效的 GameInput 裝置類型。 |
| [GameInputLabel](/zh-TW/reference/input/gameinput/enums/gameinputlabel) | 列舉支援的按鈕標籤。 |
| [GameInputMouseButtons](/zh-TW/reference/input/gameinput/enums/gameinputmousebuttons) | 列舉滑鼠按鈕。 |
| [GameInputMousePositions](/zh-TW/reference/input/gameinput/enums/gameInputmousepositions) | 列舉滑鼠定位模式。 |
| [GameInputRacingWheelAxes](/zh-TW/reference/input/gameinput/enums/gameinputracingwheelaxes) | 列舉賽車方向盤上的軸。 |
| [GameInputRacingWheelButtons](/zh-TW/reference/input/gameinput/enums/gameinputracingwheelbuttons) | 列舉賽車方向盤上的按鈕。 |
| [GameInputRawDeviceReportKind](/zh-TW/reference/input/gameinput/enums/gameinputrawdevicereportkind) | 列舉原始裝置報告的種類。 |
| [GameInputRumbleMotors](/zh-TW/reference/input/gameinput/enums/gameinputrumblemotors) | 列舉 API 支援的輸入裝置震動馬達。 |
| [GameInputSensorAccuracy](/zh-TW/reference/input/gameinput/enums/gameinputsensoraccuracy) | 列舉感應器的精確度等級。 |
| [GameInputSensorsKind](/zh-TW/reference/input/gameinput/enums/gameinputsensorskind) | 列舉有效的 GameInput 感應器類型。 |
| [GameInputSwitchKind](/zh-TW/reference/input/gameinput/enums/gameinputswitchkind) | 列舉輸入裝置支援的切換開關類型。 |
| [GameInputSwitchPosition](/zh-TW/reference/input/gameinput/enums/gameinputswitchposition) | 列舉輸入裝置上切換開關的位置。 |
| [GameInputSystemButtons](/zh-TW/reference/input/gameinput/enums/gameinputsystembuttons) | 列舉用於控制系統的按鈕。 |

## 已移除的成員

下列成員存在於舊版 API 中，但已從目前的 API 移除。如需每個已移除成員的完整文件，請參閱 [已淘汰的 GameInput API 成員](/zh-TW/reference/input/gameinput/deprecated/gameinput_deprecated_members)。

### 已移除的介面

沒有任何介面被永久移除。`IGameInputRawDeviceReport` 在 v1 和 v2 中不存在，但已在目前的 API 中重新推出。

### 已移除的函式

| 函式 | 最後版本 | 描述 |
| - | - | - |
| [GameInputGuideButtonCallback](/zh-TW/reference/input/gameinput/deprecated/functions/gameinputguidebuttoncallback) | v0 | 由遊戲定義、用於指南按鈕事件的回呼。已由 `GameInputSystemButtonCallback` 取代。 |

### 已移除的結構

| 結構 | 最後版本 | 描述 |
| - | - | - |
| [GameInputBatteryState](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputbatterystate) | v0 | 描述輸入裝置的電池狀態。 |
| [GameInputControllerAxisInfo](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputcontrolleraxisinfo) | v2 | 描述輸入裝置上的軸。已由 `GameInputControllerInfo` 中的欄位取代。 |
| [GameInputControllerButtonInfo](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputcontrollerbuttoninfo) | v2 | 描述輸入裝置上的按鈕。已由 `GameInputControllerInfo` 中的欄位取代。 |
| [GameInputHapticFeedbackMotorInfo](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputhapticfeedbackmotorinfo) | v0 | 描述觸覺回饋馬達。已由 `GameInputHapticInfo` 取代。 |
| [GameInputHapticFeedbackParams](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputhapticfeedbackparams) | v0 | 描述觸覺回饋效果。 |
| [GameInputHapticWaveformInfo](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputhapticwaveforminfo) | v0 | 描述觸覺回饋效果的特性。 |
| [GameInputMotionInfo](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputmotioninfo) | v0 | 描述支援動作之輸入裝置的可測量屬性。 |
| [GameInputMotionState](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputmotionstate) | v0 | 描述動作輸入的狀態。 |
| [GameInputRawDeviceItemCollectionInfo](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputrawdeviceitemcollectioninfo) | v0 | 描述原始裝置項目的集合。 |
| [GameInputRawDeviceReportItemInfo](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputrawdevicereportiteminfo) | v0 | 描述原始裝置報告項目。 |
| [GameInputString](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputstring) | v0 | 描述包含輸入裝置相關資訊的字串。 |
| [GameInputTouchSensorInfo](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputtouchsensorinfo) | v0 | 描述輸入裝置的觸控感應器。 |
| [GameInputTouchState](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputtouchstate) | v0 | 描述觸控輸入裝置的狀態。 |
| [GameInputUiNavigationInfo](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputuinavigationinfo) | v2 | 指定 UI 中瀏覽按鈕的標籤。 |
| [GameInputUiNavigationState](/zh-TW/reference/input/gameinput/deprecated/structs/gameinputuinavigationstate) | v2 | 提供 UI 瀏覽輸入的目前狀態。 |

### 已移除的列舉

| 列舉 | 最後版本 | 描述 |
| - | - | - |
| [GameInputBatteryStatus](/zh-TW/reference/input/gameinput/deprecated/enums/gameinputbatterystatus) | v0 | 列舉輸入裝置的電池狀態。 |
| [GameInputDeviceCapabilities](/zh-TW/reference/input/gameinput/deprecated/enums/gameinputdevicecapabilities) | v0 | 列舉輸入裝置的特定功能。 |
| [GameInputLocation](/zh-TW/reference/input/gameinput/deprecated/enums/gameinputlocation) | v0 | 列舉輸入裝置的各個部分。 |
| [GameInputMotionAccuracy](/zh-TW/reference/input/gameinput/deprecated/enums/gameinputmotionaccuracy) | v0 | 列舉動作感應器的精確度等級。 |
| [GameInputRawDeviceItemCollectionKind](/zh-TW/reference/input/gameinput/deprecated/enums/gameinputrawdeviceitemcollectionkind) | v0 | 列舉原始裝置項目集合的類型。 |
| [GameInputRawDevicePhysicalUnitKind](/zh-TW/reference/input/gameinput/deprecated/enums/gameinputrawdevicephysicalunitkind) | v0 | 列舉與裝置輸入關聯的物理單位。 |
| [GameInputRawDeviceReportItemFlags](/zh-TW/reference/input/gameinput/deprecated/enums/gameinputrawdevicereportitemflags) | v0 | 列舉原始裝置報告項目的類型。 |
| [GameInputTouchShape](/zh-TW/reference/input/gameinput/deprecated/enums/gameinputtouchshape) | v0 | 列舉觸控感應器的形狀。 |
| [GameInputUiNavigationButtons](/zh-TW/reference/input/gameinput/deprecated/enums/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** | 已推出。 |

## 概念文件

* [輸入概觀](/zh-TW/build/core-features/common/input/overviews/input-overview)
* [輸入基本概念](/zh-TW/build/core-features/common/input/overviews/input-fundamentals)
* [輸入裝置](/zh-TW/build/core-features/common/input/overviews/input-devices)

## 另請參閱

[輸入 API 參考](/zh-TW/reference/input/gc-reference-input-toc)


## Related topics

- [GameInput](/reference/input/gameinput/gameinput_members.md)
- [Input](/build/core-features/common/input/gc-input-toc.md)
- [Overview of GameInput](/build/core-features/common/input/overviews/input-overview.md)
- [GameInput fundamentals](/build/core-features/common/input/overviews/input-fundamentals.md)
- [GameInput 概述](/zh-CN/build/core-features/common/input/overviews/input-overview.md)
