Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
GameInput APIs are used to capture human input from a wide range of devices, such as game controllers, flight sticks, racing wheels, and touch input.
Interfaces
| Interface | Description |
|---|---|
| IGameInputDevice | Defines an input device. |
| IGameInputDispatcher | Provides manual control over scheduling the background tasks managed by the GameInput API. |
| IGameInputForceFeedbackEffect | Describes a force feedback effect on a compatible input device. |
| IGameInputReading | Contains the data for a single input update. |
| IGameInput | A per-process singleton that provides access to the device input stream. |
Functions
| Function | Description |
|---|---|
| GameInputCreate | Retrieves an instance of the IGameInput interface. |
| GameInputDeviceCallback | Defines a callback for device connection and disconnection events. |
| GameInputKeyboardLayoutCallback | Defines a callback for keyboard layout change events. |
| GameInputReadingCallback | Defines a callback for new reading arrival events. |
| GameInputSystemButtonCallback | Defines a callback for Guide or Share button press and release events. |
Structures
| Structure | Description |
|---|---|
| GameInputArcadeStickInfo | Details the characteristics of an arcade stick. |
| GameInputArcadeStickState | Provides the current status of an arcade stick. |
| GameInputControllerAxisInfo | Specifies an axis on an input device. |
| GameInputControllerButtonInfo | Specifies a button on an input device. |
| GameInputControllerSwitchInfo | Specifies a switch on an input device. |
| GameInputDeviceInfo | Contains comprehensive information about an input device. |
| GameInputFlightStickInfo | Details the characteristics of a flight stick. |
| GameInputFlightStickState | Provides the current status of a flight stick. |
| GameInputForceFeedbackConditionParams | Defines certain physical aspects of a force-feedback effect. |
| GameInputForceFeedbackConstantParams | Defines a constant physical aspect of a force-feedback effect. |
| GameInputForceFeedbackEnvelope | Defines an envelope that modifies a force-feedback effect. |
| GameInputForceFeedbackMagnitude | Defines the magnitude of the force exerted by a force-feedback effect. |
| GameInputForceFeedbackMotorInfo | Provides information about the force-feedback motor. |
| GameInputForceFeedbackParams | Defines the API-supported attributes of a force-feedback effect. |
| GameInputForceFeedbackPeriodicParams | Defines the parameters for a periodic force-feedback effect. |
| GameInputForceFeedbackRampParams | Defines the parameters for a ramp force-feedback effect. |
| GameInputGamepadInfo | Details the characteristics of a gamepad. |
| GameInputGamepadState | Provides the current status of a gamepad input device. |
| GameInputKeyState | Provides the current state of a key on a keyboard. |
| GameInputKeyboardInfo | Details the characteristics of a keyboard. |
| GameInputMouseInfo | Details the characteristics of a mouse. |
| GameInputMouseState | Provides the current status of a mouse. |
| GameInputRacingWheelInfo | Details the characteristics of a racing wheel. |
| GameInputRacingWheelState | Provides the current status of a racing wheel. |
| GameInputRumbleParams | Describes a rumble effect produced by a controller. |
| GameInputUiNavigationInfo | Specifies the labels of navigation buttons in the UI. |
| GameInputUiNavigationState | Provides the current status of UI navigation input. |
| GameInputUsage | Describes a specific HID usage. |
Enumerations
| Enumeration | Description |
|---|---|
| GameInputArcadeStickButtons | Enumerates inputs from an arcade stick. |
| GameInputDeviceFamily | Enumerates families of input devices. |
| GameInputDeviceStatus | Enumerates the states that an input device can be in. |
| GameInputEnumerationKind | Enumerates types of behavior for enumerating input devices. |
| GameInputFeedbackAxes | Enumerates direction types of force feedback motors available on an input device. |
| GameInputFeedbackEffectState | Enumerates states of a force feedback effect. |
| GameInputFlightStickButtons | Enumerates flight stick buttons. |
| GameInputFocusPolicy | Enumerates focus policies for an input device. |
| GameInputForceFeedbackEffectKind | Enumerates types of magnitude over time effects that can be applied to a force feedback effect. |
| GameInputGamepadButtons | Enumerates gamepad buttons, including the directional pad (D-pad). |
| GameInputKeyboardKind | Enumerates keyboard types by key layout. |
| GameInputKind | Enumerates valid GameInput device types. |
| GameInputLabel | Enumerates supported button labels. |
| GameInputMouseButtons | Enumerates mouse buttons. |
| GameInputRacingWheelButtons | Enumerates buttons on a racing wheel. |
| GameInputRumbleMotors | Enumerates the API supported rumble motors for an input device. |
| GameInputSwitchKind | Enumerates types of switches supported by an input device. |
| GameInputSwitchPosition | Enumerates positions of a switch on an input device. |
| GameInputSystemButtons | Enumerates buttons used for controlling the system. |
| GameInputUiNavigationButtons | Enumerates UI navigation buttons. |