XGameUI
Les API XboxGameUI permettent aux titres d’afficher des interfaces utilisateur prédéfinies sur la console XBOX One. Ces interfaces utilisateur prédéfinies comprennent notamment des sélecteurs d’utilisateurs, des cartes de profil et des invitations à des jeux.Fonctions
| Fonction | Description |
|---|---|
| XGameUiSetNotificationPositionHint | Définit la position préférée d’affichage des notifications toast sur le titre actuel. |
| XGameUiShowAchievementsAsync | Affiche une interface utilisateur présentant les succès du joueur demandeur pour le titre spécifié. |
| XGameUiShowAchievementsResult | Obtient le résultat d’un appel à XGameUiShowAchievementsAsync. |
| XGameUiShowErrorDialogAsync | Affiche l’interface utilisateur d’une boîte de dialogue d’erreur avec une chaîne d’erreur définie par le service pour le code d’erreur spécifié. |
| XGameUiShowErrorDialogResult | Obtient le résultat d’un appel à XGameUiShowErrorDialogAsync. |
| XGameUiShowMessageDialogAsync | Affiche l’interface utilisateur d’une boîte de dialogue de message personnalisable. |
| XGameUiShowMessageDialogResult | Obtient le résultat d’un appel à XGameUiShowMessageDialogAsync. |
| XGameUiShowMultiplayerActivityGameInviteAsync | À déterminer |
| XGameUiShowMultiplayerActivityGameInviteResult | À déterminer |
| XGameUiShowPlayerPickerAsync | Affiche une interface utilisateur de sélection qui permet à une personne qui joue au jeu de sélectionner des joueurs dans une liste de personnes présentée. |
| XGameUiShowPlayerPickerResult | Obtient les résultats d’un appel à XGameUiShowPlayerPickerAsync. |
| XGameUiShowPlayerPickerResultCount | Obtient le nombre de résultats d’un appel à XGameUiShowPlayerPickerAsync. |
| XGameUiShowPlayerProfileCardAsync | Affiche l’interface utilisateur de la carte de profil du joueur spécifié. |
| XGameUiShowPlayerProfileCardResult | Obtient le résultat d’un appel à XGameUiShowPlayerProfileCardAsync. |
| XGameUiShowSendGameInviteAsync | Affiche une interface utilisateur de sélection remplie à partir de la liste d’amis et de la liste d’amis suggérés du joueur sélectionné. |
| XGameUiShowSendGameInviteResult | Obtient le résultat d’un appel à XGameUIShowSendGameInviteAsync. |
| XGameUiShowStateShareAsync | Affiche une interface utilisateur permettant de partager un état avec d’autres joueurs |
| XGameUiShowStateShareResult | Obtient le résultat d’un appel à XGameUIShowStateShareAsync |
| XGameUiShowTextEntryAsync | Affiche une interface utilisateur de saisie de texte permettant à un utilisateur d’entrer des informations. |
| XGameUiShowTextEntryResult | Obtient les résultats d’un appel à XGameUiShowTextEntryAsync. |
| XGameUiShowTextEntryResultSize | Obtient la taille de la mémoire tampon de retour d’un appel à XGameUiShowTextEntryAsync. |
| XGameUiShowWebAuthenticationAsync | Affiche une interface utilisateur web qui permet à l’utilisateur de déléguer l’accès à des sites et services web externes sans fournir directement ses informations d’identification au titre en cours d’exécution. |
| XGameUiShowWebAuthenticationResult | Obtient les résultats d’un appel à XGameUiShowWebAuthenticationAsync. |
| XGameUiShowWebAuthenticationResultSize | Récupère la taille de la mémoire tampon nécessaire pour contenir les résultats d’une demande d’authentification. |
| XGameUiShowWebAuthenticationWithOptionsAsync | Affiche une interface utilisateur web, avec l’option de l’afficher en plein écran, qui permet à l’utilisateur de déléguer l’accès à des sites et services web externes sans fournir directement ses informations d’identification au titre en cours d’exécution. |
| XGameUiTextEntryClose | Ferme le clavier virtuel et libère les ressources correspondantes. |
| XGameUiTextEntryGetExtents | Obtient l’étendue à l’écran du clavier virtuel. |
| XGameUiTextEntryGetState | Obtient l’état actuel du clavier virtuel ouvert. |
| XGameUiTextEntryOpen | Ouvre un clavier virtuel pour lequel le titre est responsable de l’affichage du texte. |
| XGameUiTextEntryUpdatePositionHint | Met à jour le positionnement préféré du clavier virtuel. |
| XGameUiTextEntryUpdateVisibility | Indique s’il faut afficher le clavier virtuel complet ou uniquement la liste des candidats. |
| XGameUISetUICallbacks | Définit les rappels d’interface utilisateur définis par le développeur. |
| XGameUISetMessageDialogUIResponse | Définit la valeur XGameUiMessageDialogButton résultante à retourner par XGameUiShowMessageDialogResult. |
| XGameUISetPlayerPickerUIResponse | Définit les résultats à retourner par XGameUiShowPlayerPickerResultCount et XGameUiShowPlayerPickerResult. |
| XGameUISetTextEntryUIResponse | Définit la longueur du texte résultant et le texte à retourner par XGameUiShowTextEntryAsync. |
| XGameUISetPlayerProfileCardUIResponse | Termine l’appel à XGameUiShowPlayerProfileCardAsync. |
| XGameUISetSendGameInviteUIResponse | Termine l’appel à XGameUiShowSendGameInviteAsync. |
| XGameUISetAchievementsUIResponse | Termine l’appel à XGameUiShowAchievementsAsync. |
| XGameUISetMultiplayerActivityGameInviteUIResponse | Termine l’appel à XGameUiShowMultiplayerActivityGameInviteAsync. |
| XGameUISetErrorDialogUIResponse | Termine l’appel à XGameUiShowErrorDialogAsync. |
| XGameUIShowPlayerProfileCardUICallback | Signature d’un rappel XGameUiShowPlayerProfileCardAsync. |
| XGameUIShowPlayerPickerUICallback | Signature d’un rappel XGameUiShowPlayerPickerAsync. |
| XGameUIShowSendGameInviteUICallback | Signature d’un rappel XGameUiShowSendGameInviteAsync. |
| XGameUIShowAchievementsUICallback | Signature d’un rappel XGameUiShowAchievementsAsync. |
| XGameUIShowMultiplayerActivityGameInviteUICallback | Signature d’un rappel XGameUiShowMultiplayerActivityGameInviteAsync. |
| XGameUIShowMessageDialogUICallback | Signature d’un rappel XGameUiShowMessageDialogAsync. |
| XGameUIShowErrorDialogUICallback | Signature d’un rappel XGameUiShowErrorDialogAsync. |
| XGameUIShowTextEntryUICallback | Signature d’un rappel XGameUiShowTextEntryAsync. |
Structures
| Structure | Description |
|---|---|
| XGameUiWebAuthenticationResultData | Contient la réponse d’une demande d’authentification web. |
| XGameUiTextEntryExtents | Décrit le positionnement relatif du clavier virtuel. |
| XGameUiTextEntryOptions | Ensemble initial d’options du clavier virtuel utilisé par XGameUiTextEntryOpen. |
| XGameUICallbackHandle | Handle associé à un appel de rappel XGameUi. Utilisé dans les appels aux API Set*Response. |
| XGameUIPlayerPickerInfo | Structure encapsulant les informations utilisateur à utiliser par l’interface utilisateur de sélection de joueurs personnalisée du développeur. |
| XGameUIUICallbacks | Structure contenant des pointeurs vers des rappels d’interface utilisateur définis par le développeur. |
Énumérations
| Énumération | Description |
|---|---|
| XGameUiMessageDialogButton | Énumère les boutons d’une boîte de dialogue de message personnalisable. |
| XGameUiNotificationPositionHint | Décrit la position préférée d’affichage des notifications toast sur le titre actuel. |
| XGameUiTextEntryChangeTypeFlags | Indicateurs précisant ce qui a changé depuis le dernier appel à XGameUiTextEntryGetState. |
| XGameUiTextEntryInputScope | Énumère les types d’informations attendus dans la saisie de texte. |
| XGameUiTextEntryPositionHint | Indication de l’emplacement optimal du clavier virtuel. |
| XGameUiTextEntryVisibilityFlags | Indicateurs précisant l’état de visibilité du clavier virtuel. |
| XGameUiWebAuthenticationOptions | Énumère les options de présentation du flux d’authentification web. |
Codes d’erreur
Les codes d’erreur suivants peuvent être retournés par les API XGameUI. Pour obtenir la liste complète, consultez Codes d’erreur.| Code | Valeur | Description |
|---|---|---|
| E_GAMEUI_TEXTENTRY_NOT_SHOWN | — | Le XGameUiTextEntryHandle n’est pas valide, probablement parce que vous devez d’abord appeler XGameUiTextEntryOpen. |
Documentation conceptuelle
- Objectifs de conception et améliorations de la programmation asynchrone
- Threads urgents
- Qu’est-ce que le Microsoft Game Development Kit ?
- Utilisation de wrappers C# pour les API GDK dans votre projet Unity