GameInput
Les API GameInput permettent de capturer les entrées humaines provenant d’un large éventail de périphériques, tels que les manettes de jeu, les joysticks de vol, les volants de course et les entrées tactiles.Cette page documente l’API GameInput actuelle (la plus récente). L’historique des versions de chaque membre est indiqué dans les pages de référence individuelles. Les membres qui n’existaient que dans les anciennes versions de l’API sont répertoriés dans la section Membres supprimés ci-dessous. Notez que les runtimes plus récents de l’API prennent en charge toutes les versions disponibles de l’API ; les membres supprimés peuvent donc toujours être utilisés avec les en-têtes des anciennes versions.
Interfaces
| Interface | Description |
|---|---|
| IGameInputDevice | Définit un périphérique d’entrée. |
| IGameInputDispatcher | Fournit un contrôle manuel sur la planification des tâches en arrière-plan gérées par l’API GameInput. |
| IGameInputForceFeedbackEffect | Décrit un effet de retour de force sur un périphérique d’entrée compatible. |
| IGameInputMapper | Fournit des informations sur la façon dont GameInput mappe un périphérique. |
| IGameInputRawDeviceReport | Représente une mémoire tampon d’octets bruts transmise à un périphérique d’entrée ou reçue de celui-ci. |
| IGameInputReading | Contient les données d’une seule mise à jour d’entrée. |
| IGameInput | Singleton par processus qui fournit l’accès au flux d’entrée des périphériques. |
Fonctions
| Fonction | Description |
|---|---|
| GameInputCreate | Récupère une instance de l’interface IGameInput. |
| GameInputDeviceCallback | Définit un rappel pour les événements de connexion et de déconnexion de périphériques. |
| GameInputKeyboardLayoutCallback | Définit un rappel pour les événements de changement de disposition du clavier. |
| GameInputReadingCallback | Définit un rappel pour les événements d’arrivée de nouvelles lectures. |
| GameInputSystemButtonCallback | Définit un rappel pour les événements d’appui et de relâchement du bouton Guide ou Partager. |
Structures
| Structure | Description |
|---|---|
| GameInputArcadeStickInfo | Détaille les caractéristiques d’un stick arcade. |
| GameInputArcadeStickState | Fournit l’état actuel d’un stick arcade. |
| GameInputAxisMapping | Décrit la façon dont un axe est mappé à la manette. |
| GameInputButtonMapping | Décrit la façon dont un bouton est mappé à la manette. |
| GameInputControllerInfo | Détaille les caractéristiques d’une manette. |
| GameInputControllerSwitchInfo | Spécifie un commutateur sur un périphérique d’entrée. |
| GameInputDeviceInfo | Contient des informations complètes sur un périphérique d’entrée. |
| GameInputFlightStickInfo | Détaille les caractéristiques d’un joystick de vol. |
| GameInputFlightStickState | Fournit l’état actuel d’un joystick de vol. |
| GameInputForceFeedbackConditionParams | Définit certains aspects physiques d’un effet de retour de force. |
| GameInputForceFeedbackConstantParams | Définit un aspect physique constant d’un effet de retour de force. |
| GameInputForceFeedbackEnvelope | Définit une enveloppe qui modifie un effet de retour de force. |
| GameInputForceFeedbackMagnitude | Définit l’amplitude de la force exercée par un effet de retour de force. |
| GameInputForceFeedbackMotorInfo | Fournit des informations sur le moteur de retour de force. |
| GameInputForceFeedbackParams | Définit les attributs d’un effet de retour de force pris en charge par l’API. |
| GameInputForceFeedbackPeriodicParams | Définit les paramètres d’un effet de retour de force périodique. |
| GameInputForceFeedbackRampParams | Définit les paramètres d’un effet de retour de force en rampe. |
| GameInputGamepadInfo | Détaille les caractéristiques d’une manette de jeu. |
| GameInputGamepadState | Fournit l’état actuel d’une manette de jeu. |
| GameInputHapticInfo | Détaille les caractéristiques d’un moteur de retour haptique. |
| GameInputKeyState | Fournit l’état actuel d’une touche de clavier. |
| GameInputKeyboardInfo | Détaille les caractéristiques d’un clavier. |
| GameInputMouseInfo | Détaille les caractéristiques d’une souris. |
| GameInputMouseState | Fournit l’état actuel d’une souris. |
| GameInputRacingWheelInfo | Détaille les caractéristiques d’un volant de course. |
| GameInputRacingWheelState | Fournit l’état actuel d’un volant de course. |
| GameInputRawDeviceReportInfo | Décrit un rapport de périphérique brut. |
| GameInputRumbleParams | Décrit un effet de vibration produit par une manette. |
| GameInputSensorsInfo | Détaille les caractéristiques des capteurs disponibles. |
| GameInputSensorsState | Fournit l’état actuel des capteurs d’un périphérique. |
| GameInputUsage | Décrit un usage HID spécifique. |
| GameInputVersion | Décrit un numéro de version en quatre parties. |
Énumérations
| Énumération | Description |
|---|---|
| GameInputArcadeStickButtons | Énumère les entrées d’un stick arcade. |
| GameInputDeviceFamily | Énumère les familles de périphériques d’entrée. |
| GameInputDeviceStatus | Énumère les états dans lesquels un périphérique d’entrée peut se trouver. |
| GameInputElementKind | Énumère le type d’élément d’une entrée donnée. |
| GameInputEnumerationKind | Énumère les types de comportement pour l’énumération des périphériques d’entrée. |
| GameInputFeedbackAxes | Énumère les types de direction des moteurs de retour de force disponibles sur un périphérique d’entrée. |
| GameInputFeedbackEffectState | Énumère les états d’un effet de retour de force. |
| GameInputFlightStickAxes | Énumère les axes d’un joystick de vol. |
| GameInputFlightStickButtons | Énumère les boutons d’un joystick de vol. |
| GameInputFocusPolicy | Énumère les stratégies de focus d’un périphérique d’entrée. |
| GameInputForceFeedbackEffectKind | Énumère les types d’effets d’amplitude dans le temps pouvant être appliqués à un effet de retour de force. |
| GameInputGamepadAxes | Énumère les axes d’une manette de jeu. |
| GameInputGamepadButtons | Énumère les boutons d’une manette de jeu, y compris le pavé directionnel (croix directionnelle). |
| GameInputKeyboardKind | Énumère les types de clavier par disposition des touches. |
| GameInputKind | Énumère les types de périphériques GameInput valides. |
| GameInputLabel | Énumère les étiquettes de bouton prises en charge. |
| GameInputMouseButtons | Énumère les boutons de la souris. |
| GameInputMousePositions | Énumère les modes de positionnement de la souris. |
| GameInputRacingWheelAxes | Énumère les axes d’un volant de course. |
| GameInputRacingWheelButtons | Énumère les boutons d’un volant de course. |
| GameInputRawDeviceReportKind | Énumère les types de rapports de périphérique bruts. |
| GameInputRumbleMotors | Énumère les moteurs de vibration pris en charge par l’API pour un périphérique d’entrée. |
| GameInputSensorAccuracy | Énumère les niveaux de précision des capteurs. |
| GameInputSensorsKind | Énumère les types de capteurs GameInput valides. |
| GameInputSwitchKind | Énumère les types de commutateurs pris en charge par un périphérique d’entrée. |
| GameInputSwitchPosition | Énumère les positions d’un commutateur sur un périphérique d’entrée. |
| GameInputSystemButtons | Énumère les boutons utilisés pour contrôler le système. |
Membres supprimés
Les membres suivants étaient présents dans les anciennes versions de l’API, mais ont été supprimés de l’API actuelle. Pour la documentation complète de chaque membre supprimé, consultez Membres obsolètes de l’API GameInput.Interfaces supprimées
Aucune interface n’a été définitivement supprimée.IGameInputRawDeviceReport était absente dans v1 et v2, mais a été réintroduite dans l’API actuelle.
Fonctions supprimées
| Fonction | Dernière version | Description |
|---|---|---|
| GameInputGuideButtonCallback | v0 | Rappel défini par le titre pour les événements du bouton Guide. Remplacé par GameInputSystemButtonCallback. |
Structures supprimées
| Structure | Dernière version | Description |
|---|---|---|
| GameInputBatteryState | v0 | Décrivait l’état de la batterie d’un périphérique d’entrée. |
| GameInputControllerAxisInfo | v2 | Décrivait un axe d’un périphérique d’entrée. Remplacée par des champs de GameInputControllerInfo. |
| GameInputControllerButtonInfo | v2 | Décrivait un bouton d’un périphérique d’entrée. Remplacée par des champs de GameInputControllerInfo. |
| GameInputHapticFeedbackMotorInfo | v0 | Décrivait un moteur de retour haptique. Remplacée par GameInputHapticInfo. |
| GameInputHapticFeedbackParams | v0 | Décrivait un effet de retour haptique. |
| GameInputHapticWaveformInfo | v0 | Décrivait les caractéristiques d’un effet de retour haptique. |
| GameInputMotionInfo | v0 | Décrivait les propriétés mesurables d’un périphérique d’entrée prenant en charge le mouvement. |
| GameInputMotionState | v0 | Décrivait l’état de l’entrée de mouvement. |
| GameInputRawDeviceItemCollectionInfo | v0 | Décrivait une collection d’éléments de périphérique bruts. |
| GameInputRawDeviceReportItemInfo | v0 | Décrivait un élément de rapport de périphérique brut. |
| GameInputString | v0 | Décrivait une chaîne contenant des informations sur un périphérique d’entrée. |
| GameInputTouchSensorInfo | v0 | Décrivait un capteur tactile d’un périphérique d’entrée. |
| GameInputTouchState | v0 | Décrivait l’état d’un périphérique d’entrée tactile. |
| GameInputUiNavigationInfo | v2 | Spécifiait les étiquettes des boutons de navigation dans l’interface utilisateur. |
| GameInputUiNavigationState | v2 | Fournissait l’état actuel de l’entrée de navigation dans l’interface utilisateur. |
Énumérations supprimées
| Énumération | Dernière version | Description |
|---|---|---|
| GameInputBatteryStatus | v0 | Énumérait les états de batterie d’un périphérique d’entrée. |
| GameInputDeviceCapabilities | v0 | Énumérait certaines fonctionnalités d’un périphérique d’entrée. |
| GameInputLocation | v0 | Énumérait les parties d’un périphérique d’entrée. |
| GameInputMotionAccuracy | v0 | Énumérait les niveaux de précision des capteurs de mouvement. |
| GameInputRawDeviceItemCollectionKind | v0 | Énumérait les types de collections d’éléments de périphérique bruts. |
| GameInputRawDevicePhysicalUnitKind | v0 | Énumérait les unités physiques associées à l’entrée du périphérique. |
| GameInputRawDeviceReportItemFlags | v0 | Énumérait les types d’éléments de rapport de périphérique bruts. |
| GameInputTouchShape | v0 | Énumérait les formes d’un capteur tactile. |
| GameInputUiNavigationButtons | v2 | Énumérait les boutons de navigation dans l’interface utilisateur. |
Historique des versions
| Version | Modifications |
|---|---|
| v3 | Ajout de l’interface IGameInputMapper. Réintroduction de l’interface IGameInputRawDeviceReport (absente dans v1/v2). Ajout des structures GameInputAxisMapping, GameInputButtonMapping, GameInputControllerInfo, GameInputHapticInfo. Réintroduction de la structure GameInputRawDeviceReportInfo et de l’énumération GameInputRawDeviceReportKind (absentes dans v1/v2). Réintroduction de la structure GameInputVersion (absente dans v1/v2). Ajout des énumérations GameInputElementKind, GameInputFlightStickAxes, GameInputGamepadAxes, GameInputRacingWheelAxes. Suppression des structures GameInputControllerAxisInfo, GameInputControllerButtonInfo, GameInputUiNavigationInfo, GameInputUiNavigationState. Suppression de l’énumération GameInputUiNavigationButtons. |
| v2 | Ajout des structures GameInputSensorsInfo, GameInputSensorsState. Ajout des énumérations GameInputSensorsKind, GameInputSensorAccuracy. Ajout de IGameInputDevice::DirectInputEscape, IGameInputDevice::GetHapticInfo. Ajout de IGameInputReading::GetSensorsState. Réintroduction de la structure GameInputVersion (absente dans v1). |
| v1 | Suppression de l’interface IGameInputRawDeviceReport, de la structure GameInputRawDeviceReportInfo et de l’énumération GameInputRawDeviceReportKind. Suppression de la structure GameInputVersion. Ajout de l’énumération GameInputMousePositions. Suppression des types haptiques, de mouvement et tactiles non implémentés propres à v0 (GameInputBatteryState, GameInputHapticFeedbackMotorInfo, GameInputHapticFeedbackParams, GameInputHapticWaveformInfo, GameInputMotionInfo, GameInputMotionState, GameInputTouchSensorInfo, GameInputTouchState, GameInputString, GameInputRawDeviceItemCollectionInfo, GameInputRawDeviceReportItemInfo). |
| v0 | Introduction. |