XGameUI

XboxGameUI API を使用すると、タイトルは XBOX One 本体上で事前定義されたユーザーインターフェイス表示を表示できます。これらの事前定義された UI には、ユーザーピッカー、プロフィールカード、ゲーム招待などのインターフェイスが含まれます。

関数

関数	説明
XGameUiSetNotificationPositionHint	現在のタイトルでトースト通知を表示する推奨位置を設定します。
XGameUiShowAchievementsAsync	指定されたタイトルの、要求元プレイヤーの実績を表示する UI を表示します。
XGameUiShowAchievementsResult	XGameUiShowAchievementsAsync 呼び出しの結果を取得します。
XGameUiShowErrorDialogAsync	指定されたエラーコードに対して、サービスが定義したエラー文字列を含むエラーダイアログの UI を表示します。
XGameUiShowErrorDialogResult	XGameUiShowErrorDialogAsync 呼び出しの結果を取得します。
XGameUiShowMessageDialogAsync	カスタマイズ可能なメッセージダイアログの UI を表示します。
XGameUiShowMessageDialogResult	XGameUiShowMessageDialogAsync 呼び出しの結果を取得します。
XGameUiShowMultiplayerActivityGameInviteAsync	TBD
XGameUiShowMultiplayerActivityGameInviteResult	TBD
XGameUiShowPlayerPickerAsync	ゲームをプレイしている人が、提示された人物リストからプレイヤーを選択できるようにするピッカー UI を表示します。
XGameUiShowPlayerPickerResult	XGameUiShowPlayerPickerAsync 呼び出しの結果を取得します。
XGameUiShowPlayerPickerResultCount	XGameUiShowPlayerPickerAsync 呼び出しの結果の数を取得します。
XGameUiShowPlayerProfileCardAsync	指定されたプレイヤーのプロフィールカードの UI を表示します。
XGameUiShowPlayerProfileCardResult	XGameUiShowPlayerProfileCardAsync 呼び出しの結果を取得します。
XGameUiShowSendGameInviteAsync	選択したプレイヤーのフレンドリストと推奨フレンドリストから作成されたピッカー UI を表示します。
XGameUiShowSendGameInviteResult	XGameUIShowSendGameInviteAsync 呼び出しの結果を取得します。
XGameUiShowStateShareAsync	他のプレイヤーと状態を共有するための UI を表示します
XGameUiShowStateShareResult	XGameUIShowStateShareAsync 呼び出しの結果を取得します
XGameUiShowTextEntryAsync	ユーザーが情報を入力するためのテキストエントリ UI を表示します。
XGameUiShowTextEntryResult	XGameUiShowTextEntryAsync 呼び出しの結果を取得します。
XGameUiShowTextEntryResultSize	XGameUiShowTextEntryAsync 呼び出しからの戻りバッファーのサイズを取得します。
XGameUiShowWebAuthenticationAsync	実行中のタイトルに資格情報を直接提供することなく、外部の Web サイトやサービスへのアクセスをユーザーが委任できる Web UI を表示します。
XGameUiShowWebAuthenticationResult	XGameUiShowWebAuthenticationAsync 呼び出しの結果を取得します。
XGameUiShowWebAuthenticationResultSize	認証要求の結果を格納するために必要なバッファーのサイズを取得します。
XGameUiShowWebAuthenticationWithOptionsAsync	実行中のタイトルに資格情報を直接提供することなく、外部の Web サイトやサービスへのアクセスをユーザーが委任できる Web UI を、フルスクリーンで表示するオプション付きで表示します。
XGameUiTextEntryClose	仮想キーボードを閉じ、対応するリソースを解放します。
XGameUiTextEntryGetExtents	仮想キーボードの画面上の範囲を取得します。
XGameUiTextEntryGetState	開いている仮想キーボードの現在の状態を取得します。
XGameUiTextEntryOpen	タイトルがテキストのレンダリングを担当する仮想キーボードを開きます。
XGameUiTextEntryUpdatePositionHint	仮想キーボードの推奨配置を更新します。
XGameUiTextEntryUpdateVisibility	フルの仮想キーボードを表示するか、候補リストのみを表示するかを更新します。
XGameUISetUICallbacks	開発者が定義した UI コールバックを設定します。
XGameUISetMessageDialogUIResponse	XGameUiShowMessageDialogResult によって返される、結果となる XGameUiMessageDialogButton の値を設定します。
XGameUISetPlayerPickerUIResponse	XGameUiShowPlayerPickerResultCount と XGameUiShowPlayerPickerResult によって返される結果を設定します。
XGameUISetTextEntryUIResponse	XGameUiShowTextEntryAsync によって返される結果テキストの長さとテキストを設定します。
XGameUISetPlayerProfileCardUIResponse	XGameUiShowPlayerProfileCardAsync 呼び出しを完了します。
XGameUISetSendGameInviteUIResponse	XGameUiShowSendGameInviteAsync 呼び出しを完了します。
XGameUISetAchievementsUIResponse	XGameUiShowAchievementsAsync 呼び出しを完了します。
XGameUISetMultiplayerActivityGameInviteUIResponse	XGameUiShowMultiplayerActivityGameInviteAsync 呼び出しを完了します。
XGameUISetErrorDialogUIResponse	XGameUiShowErrorDialogAsync 呼び出しを完了します。
XGameUIShowPlayerProfileCardUICallback	XGameUiShowPlayerProfileCardAsync コールバックのシグネチャ。
XGameUIShowPlayerPickerUICallback	XGameUiShowPlayerPickerAsync コールバックのシグネチャ。
XGameUIShowSendGameInviteUICallback	XGameUiShowSendGameInviteAsync コールバックのシグネチャ。
XGameUIShowAchievementsUICallback	XGameUiShowAchievementsAsync コールバックのシグネチャ。
XGameUIShowMultiplayerActivityGameInviteUICallback	XGameUiShowMultiplayerActivityGameInviteAsync コールバックのシグネチャ。
XGameUIShowMessageDialogUICallback	XGameUiShowMessageDialogAsync コールバックのシグネチャ。
XGameUIShowErrorDialogUICallback	XGameUiShowErrorDialogAsync コールバックのシグネチャ。
XGameUIShowTextEntryUICallback	XGameUiShowTextEntryAsync コールバックのシグネチャ。

構造体

構造体	説明
XGameUiWebAuthenticationResultData	Web 認証要求からの応答が含まれます。
XGameUiTextEntryExtents	仮想キーボードの相対的な配置を記述します。
XGameUiTextEntryOptions	XGameUiTextEntryOpen で使用される仮想キーボードの初期オプションセット。
XGameUICallbackHandle	XGameUi コールバック呼び出しに関連付けられたハンドル。Set*Response API の呼び出しで使用されます。
XGameUIPlayerPickerInfo	開発者のカスタムプレイヤーピッカー UI で使用するユーザー情報をカプセル化する構造体。
XGameUIUICallbacks	開発者が定義した UI コールバックへのポインターを含む構造体。

列挙型

列挙型	説明
XGameUiMessageDialogButton	カスタマイズ可能なメッセージダイアログボックス内のボタンを列挙します。
XGameUiNotificationPositionHint	現在のタイトルでトースト通知を表示する推奨位置を記述します。
XGameUiTextEntryChangeTypeFlags	XGameUiTextEntryGetState の最後の呼び出しから何が変更されたかを示すフラグ。
XGameUiTextEntryInputScope	テキストエントリで想定される情報の種類を列挙します。
XGameUiTextEntryPositionHint	仮想キーボードを配置するのに最適な場所のヒント。
XGameUiTextEntryVisibilityFlags	仮想キーボードの表示状態を示すフラグ。
XGameUiWebAuthenticationOptions	Web 認証フローを表示するオプションを列挙します。

エラーコード

XGameUI API から次のエラーコードが返される場合があります。完全な一覧については、Error codes を参照してください。

コード	値	説明
E_GAMEUI_TEXTENTRY_NOT_SHOWN	—	XGameUiTextEntryHandle が有効ではありません。おそらく最初に XGameUiTextEntryOpen を呼び出す必要があります。

(all) API references

Error codes

Audio API reference

Chat API reference

Developer kit only API reference

Graphics API reference

Input API reference

Lighting API reference

Networking API reference

XBOX PC remote iteration API reference

System API reference

Tools API reference

Windows device portal REST API reference

XBOX services API reference

MicrosoftGame.config reference

XGameUI (API の内容)

XGameUI

関数

構造体

列挙型

エラーコード

概念ドキュメント

関連項目

​XGameUI

​関数

​構造体

​列挙型

​エラー コード

​概念ドキュメント

​関連項目

XGameUI

関数

構造体

列挙型

エラーコード

概念ドキュメント

関連項目