XGameUI

XboxGameUI API 允许游戏在 Xbox One 主机上弹出预定义的用户界面显示。 这些预定义的 UI 除了界面之外还包括用户选取器、个人资料卡和游戏邀请。

函数

函数	说明
XGameUiSetNotificationPositionHint	设置要在当前游戏上显示的 toast 通知的首选位置。
XGameUiShowAchievementsAsync	显示展示请求玩家对于指定游戏的成就的 UI。
XGameUiShowAchievementsResult	获取调用 XGameUiShowAchievementsAsync 的结果。
XGameUiShowErrorDialogAsync	显示错误对话框的 UI，它具有针对指定的错误代码的服务定义的错误字符串。
XGameUiShowErrorDialogResult	获取调用 XStoreShowRateAndReviewUIAsync 的结果。
XGameUiShowMessageDialogAsync	显示可自定义的消息对话框的 UI。
XGameUiShowMessageDialogResult	从 XGameUiShowMessageDialogAsync 调用获取结果。
XGameUiShowMultiplayerActivityGameInviteAsync	TBD
XGameUiShowMultiplayerActivityGameInviteResult	TBD
XGameUiShowPlayerPickerAsync	显示一个选取器 UI，它允许正玩游戏的某个人从展示的人员列表中选择玩家。
XGameUiShowPlayerPickerResult	从 XGameUiShowPlayerPickerAsync 调用获取结果。
XGameUiShowPlayerPickerResultCount	从 XGameUiShowPlayerPickerAsync 调用获取结果的计数。
XGameUiShowPlayerProfileCardAsync	显示指定玩家的个人资料卡的 UI。
XGameUiShowPlayerProfileCardResult	获取调用 XStoreShowRateAndReviewUIAsync 的结果。
XGameUiShowSendGameInviteAsync	显示从所选玩家的好友列表和建议的好友列表填充的选取器 UI。
XGameUiShowSendGameInviteResult	获取调用 XStoreShowRateAndReviewUIAsync 的结果。
XGameUiShowStateShareAsync	显示用于与其他玩家共享状态的 UI
XGameUiShowStateShareResult	获取调用 XGameUIShowStateShareAsync 的结果
XGameUiShowTextEntryAsync	显示供用户输入信息的文本输入 UI。
XGameUiShowTextEntryResult	从 XGameUiShowTextEntryAsync 调用获取结果。
XGameUiShowTextEntryResultSize	从 XGameUiShowTextEntryAsync 调用获取返回缓冲区的大小。
XGameUiShowWebAuthenticationAsync	显示一个 web UI，该 UI 允许用户向外部网站和服务委派访问权限，而不是直接提供自己的正在运行的游戏的凭据。
XGameUiShowWebAuthenticationResult	从 XGameUiShowWebAuthenticationAsync 调用获取结果。
XGameUiShowWebAuthenticationResultSize	检索包含身份验证请求的结果所需的缓冲区大小。
XGameUiShowWebAuthenticationWithOptionsAsync	显示 web UI （带有全屏选项），该 UI 允许用户向外部网站和服务委派访问权限，而不是直接提供自己的正在运行的游戏的凭据。
XGameUiTextEntryClose	关闭虚拟键盘并释放相应的资源。
XGameUiTextEntryGetExtents	获取虚拟键盘的屏幕盘区。
XGameUiTextEntryGetState	获取打开的虚拟键盘的当前状态。
XGameUiTextEntryOpen	打开一个虚拟键盘，游戏负责呈现文本。
XGameUiTextEntryUpdatePositionHint	更新虚拟键盘的首选位置。
XGameUiTextEntryUpdateVisibility	更新是显示完整的虚拟键盘还是仅显示候选列表。

结构

结构	说明
XGameUiWebAuthenticationResultData	包含来自 web 身份验证请求的响应。
XGameUiTextEntryExtents	描述虚拟键盘的相对定位。
XGameUiTextEntryOptions	XGameUiTextEntryOpen 使用的虚拟键盘的初始选项集。

枚举

枚举	说明
XGameUiMessageDialogButton	枚举可自定义消息对话框中的按钮。
XGameUiNotificationPositionHint	描述要在当前游戏上显示的 toast 通知的首选位置。
XGameUiTextEntryChangeTypeFlags	指示自上次调用 XGameUiTextEntryGetState 以来已更改的内容的标志。
XGameUiTextEntryInputScope	枚举文本输入中需要的信息类型。
XGameUiTextEntryPositionHint	虚拟键盘的最佳位置提示。
XGameUiTextEntryVisibilityFlags	指示虚拟键盘可见性状态的标志。
XGameUiWebAuthenticationOptions	显示 Web 身份验证流的选项。

另请参阅

系统 API 参考