XGameUI
Las API de XboxGameUI permiten a los títulos mostrar pantallas de interfaz de usuario predefinidas en la consola XBOX One. Estas interfaces de usuario predefinidas incluyen selectores de usuario, tarjetas de perfil e invitaciones de juego, entre otras interfaces.Funciones
| Función | Descripción |
|---|---|
| XGameUiSetNotificationPositionHint | Establece la posición preferida en la que se mostrarán las notificaciones del sistema en el título actual. |
| XGameUiShowAchievementsAsync | Muestra la interfaz de usuario que presenta los logros del jugador solicitante para el título especificado. |
| XGameUiShowAchievementsResult | Obtiene el resultado de una llamada a XGameUiShowAchievementsAsync. |
| XGameUiShowErrorDialogAsync | Muestra la interfaz de usuario de un cuadro de diálogo de error con una cadena de error definida por el servicio para el código de error especificado. |
| XGameUiShowErrorDialogResult | Obtiene el resultado de una llamada a XGameUiShowErrorDialogAsync. |
| XGameUiShowMessageDialogAsync | Muestra la interfaz de usuario de un cuadro de diálogo de mensaje personalizable. |
| XGameUiShowMessageDialogResult | Obtiene el resultado de una llamada a XGameUiShowMessageDialogAsync. |
| XGameUiShowMultiplayerActivityGameInviteAsync | TBD |
| XGameUiShowMultiplayerActivityGameInviteResult | TBD |
| XGameUiShowPlayerPickerAsync | Muestra una interfaz de usuario de selección que permite a una persona que juega al juego seleccionar jugadores de una lista de personas presentada. |
| XGameUiShowPlayerPickerResult | Obtiene los resultados de una llamada a XGameUiShowPlayerPickerAsync. |
| XGameUiShowPlayerPickerResultCount | Obtiene el número de resultados de una llamada a XGameUiShowPlayerPickerAsync. |
| XGameUiShowPlayerProfileCardAsync | Muestra la interfaz de usuario de la tarjeta de perfil del jugador especificado. |
| XGameUiShowPlayerProfileCardResult | Obtiene el resultado de una llamada a XGameUiShowPlayerProfileCardAsync. |
| XGameUiShowSendGameInviteAsync | Muestra una interfaz de usuario de selección rellenada a partir de la lista de amigos del jugador seleccionado y la lista de amigos sugeridos. |
| XGameUiShowSendGameInviteResult | Obtiene el resultado de una llamada a XGameUIShowSendGameInviteAsync. |
| XGameUiShowStateShareAsync | Muestra la interfaz de usuario para compartir un estado con otros jugadores |
| XGameUiShowStateShareResult | Obtiene el resultado de una llamada a XGameUIShowStateShareAsync |
| XGameUiShowTextEntryAsync | Muestra una interfaz de usuario de entrada de texto para que un usuario escriba información. |
| XGameUiShowTextEntryResult | Obtiene los resultados de una llamada a XGameUiShowTextEntryAsync. |
| XGameUiShowTextEntryResultSize | Obtiene el tamaño del búfer devuelto de una llamada a XGameUiShowTextEntryAsync. |
| XGameUiShowWebAuthenticationAsync | Muestra una interfaz de usuario web que permite al usuario delegar el acceso a sitios web y servicios externos sin proporcionar directamente sus credenciales al título en ejecución. |
| XGameUiShowWebAuthenticationResult | Obtiene los resultados de una llamada a XGameUiShowWebAuthenticationAsync. |
| XGameUiShowWebAuthenticationResultSize | Recupera el tamaño del búfer necesario para contener los resultados de una solicitud de autenticación. |
| XGameUiShowWebAuthenticationWithOptionsAsync | Muestra una interfaz de usuario web, con la opción de mostrarla a pantalla completa, que permite al usuario delegar el acceso a sitios web y servicios externos sin proporcionar directamente sus credenciales al título en ejecución. |
| XGameUiTextEntryClose | Cierra el teclado virtual y libera los recursos correspondientes. |
| XGameUiTextEntryGetExtents | Obtiene la extensión en pantalla del teclado virtual. |
| XGameUiTextEntryGetState | Obtiene el estado actual del teclado virtual abierto. |
| XGameUiTextEntryOpen | Abre un teclado virtual en el que el título es responsable de representar el texto. |
| XGameUiTextEntryUpdatePositionHint | Actualiza la posición preferida del teclado virtual. |
| XGameUiTextEntryUpdateVisibility | Actualiza si se muestra el teclado virtual completo o solo la lista de candidatos. |
| XGameUISetUICallbacks | Establece las devoluciones de llamada de interfaz de usuario definidas por el desarrollador. |
| XGameUISetMessageDialogUIResponse | Establece el valor de resultado XGameUiMessageDialogButton que devolverá XGameUiShowMessageDialogResult. |
| XGameUISetPlayerPickerUIResponse | Establece los resultados que devolverán XGameUiShowPlayerPickerResultCount y XGameUiShowPlayerPickerResult. |
| XGameUISetTextEntryUIResponse | Establece la longitud del texto y el texto resultantes que devolverá XGameUiShowTextEntryAsync. |
| XGameUISetPlayerProfileCardUIResponse | Completa la llamada a XGameUiShowPlayerProfileCardAsync. |
| XGameUISetSendGameInviteUIResponse | Completa la llamada a XGameUiShowSendGameInviteAsync. |
| XGameUISetAchievementsUIResponse | Completa la llamada a XGameUiShowAchievementsAsync. |
| XGameUISetMultiplayerActivityGameInviteUIResponse | Completa la llamada a XGameUiShowMultiplayerActivityGameInviteAsync. |
| XGameUISetErrorDialogUIResponse | Completa la llamada a XGameUiShowErrorDialogAsync. |
| XGameUIShowPlayerProfileCardUICallback | Firma de una devolución de llamada de XGameUiShowPlayerProfileCardAsync. |
| XGameUIShowPlayerPickerUICallback | Firma de una devolución de llamada de XGameUiShowPlayerPickerAsync. |
| XGameUIShowSendGameInviteUICallback | Firma de una devolución de llamada de XGameUiShowSendGameInviteAsync. |
| XGameUIShowAchievementsUICallback | Firma de una devolución de llamada de XGameUiShowAchievementsAsync. |
| XGameUIShowMultiplayerActivityGameInviteUICallback | Firma de una devolución de llamada de XGameUiShowMultiplayerActivityGameInviteAsync. |
| XGameUIShowMessageDialogUICallback | Firma de una devolución de llamada de XGameUiShowMessageDialogAsync. |
| XGameUIShowErrorDialogUICallback | Firma de una devolución de llamada de XGameUiShowErrorDialogAsync. |
| XGameUIShowTextEntryUICallback | Firma de una devolución de llamada de XGameUiShowTextEntryAsync. |
Estructuras
| Estructura | Descripción |
|---|---|
| XGameUiWebAuthenticationResultData | Contiene la respuesta de una solicitud de autenticación web. |
| XGameUiTextEntryExtents | Describe la posición relativa del teclado virtual. |
| XGameUiTextEntryOptions | Conjunto inicial de opciones para el teclado virtual usado por XGameUiTextEntryOpen. |
| XGameUICallbackHandle | Identificador asociado a una invocación de devolución de llamada de XGameUi. Se usa en llamadas a las API Set*Response. |
| XGameUIPlayerPickerInfo | Estructura que encapsula la información del usuario que usará la interfaz de usuario de selección de jugadores personalizada del desarrollador. |
| XGameUIUICallbacks | Estructura que contiene punteros a devoluciones de llamada de interfaz de usuario definidas por el desarrollador. |
Enumeraciones
| Enumeración | Descripción |
|---|---|
| XGameUiMessageDialogButton | Enumera los botones de un cuadro de diálogo de mensaje personalizable. |
| XGameUiNotificationPositionHint | Describe la posición preferida en la que se mostrarán las notificaciones del sistema en el título actual. |
| XGameUiTextEntryChangeTypeFlags | Marcas que indican lo que ha cambiado desde la última llamada a XGameUiTextEntryGetState. |
| XGameUiTextEntryInputScope | Enumera los tipos de información esperados en la entrada de texto. |
| XGameUiTextEntryPositionHint | Sugerencia sobre dónde colocar mejor el teclado virtual. |
| XGameUiTextEntryVisibilityFlags | Marcas que indican el estado de visibilidad del teclado virtual. |
| XGameUiWebAuthenticationOptions | Enumera las opciones para presentar el flujo de autenticación web. |
Códigos de error
Las API de XGameUI pueden devolver los siguientes códigos de error. Para obtener una lista completa, consulte Códigos de error.| Código | Valor | Descripción |
|---|---|---|
| E_GAMEUI_TEXTENTRY_NOT_SHOWN | — | El XGameUiTextEntryHandle no es válido, probablemente porque es necesario llamar primero a XGameUiTextEntryOpen. |
Documentación conceptual
- Objetivos de diseño y mejoras de la programación asincrónica
- Subprocesos sensibles al tiempo
- ¿Qué es el Microsoft Game Development Kit?
- Uso de contenedores de C# para las API del GDK en su proyecto de Unity