XGameUI
As APIs XboxGameUI permitem que os títulos exibam interfaces do usuário predefinidas no console XBOX One. Essas interfaces do usuário predefinidas incluem seletores de usuário, cartões de perfil e convites de jogo, entre outras interfaces.Funções
| Função | Descrição |
|---|---|
| XGameUiSetNotificationPositionHint | Define a posição preferencial para as notificações do sistema serem exibidas no título atual. |
| XGameUiShowAchievementsAsync | Exibe a interface do usuário que apresenta as conquistas do jogador solicitante para o título especificado. |
| XGameUiShowAchievementsResult | Obtém o resultado de uma chamada para XGameUiShowAchievementsAsync. |
| XGameUiShowErrorDialogAsync | Exibe a interface do usuário de uma caixa de diálogo de erro com uma cadeia de caracteres de erro definida pelo serviço para o código de erro especificado. |
| XGameUiShowErrorDialogResult | Obtém o resultado de uma chamada para XGameUiShowErrorDialogAsync. |
| XGameUiShowMessageDialogAsync | Exibe a interface do usuário de uma caixa de diálogo de mensagem personalizável. |
| XGameUiShowMessageDialogResult | Obtém o resultado de uma chamada para XGameUiShowMessageDialogAsync. |
| XGameUiShowMultiplayerActivityGameInviteAsync | A definir |
| XGameUiShowMultiplayerActivityGameInviteResult | A definir |
| XGameUiShowPlayerPickerAsync | Exibe uma interface do usuário de seletor que permite que uma pessoa que está jogando selecione jogadores em uma lista apresentada de pessoas. |
| XGameUiShowPlayerPickerResult | Obtém os resultados de uma chamada de XGameUiShowPlayerPickerAsync. |
| XGameUiShowPlayerPickerResultCount | Obtém a contagem de resultados de uma chamada de XGameUiShowPlayerPickerAsync. |
| XGameUiShowPlayerProfileCardAsync | Exibe a interface do usuário do cartão de perfil do jogador especificado. |
| XGameUiShowPlayerProfileCardResult | Obtém o resultado de uma chamada para XGameUiShowPlayerProfileCardAsync. |
| XGameUiShowSendGameInviteAsync | Mostra uma interface do usuário de seletor preenchida com a lista de amigos e a lista de amigos sugeridos do jogador selecionado. |
| XGameUiShowSendGameInviteResult | Obtém o resultado de uma chamada para XGameUIShowSendGameInviteAsync. |
| XGameUiShowStateShareAsync | Exibe a interface do usuário para compartilhar um estado com outros jogadores |
| XGameUiShowStateShareResult | Obtém o resultado de uma chamada para XGameUIShowStateShareAsync |
| XGameUiShowTextEntryAsync | Exibe uma interface do usuário de entrada de texto para que um usuário insira informações. |
| XGameUiShowTextEntryResult | Obtém os resultados de uma chamada de XGameUiShowTextEntryAsync. |
| XGameUiShowTextEntryResultSize | Obtém o tamanho do buffer de retorno de uma chamada de XGameUiShowTextEntryAsync. |
| XGameUiShowWebAuthenticationAsync | Exibe uma interface do usuário da Web que permite ao usuário delegar acesso a sites e serviços externos sem fornecer diretamente suas credenciais ao título em execução. |
| XGameUiShowWebAuthenticationResult | Obtém os resultados de uma chamada de XGameUiShowWebAuthenticationAsync. |
| XGameUiShowWebAuthenticationResultSize | Recupera o tamanho do buffer necessário para conter os resultados de uma solicitação de autenticação. |
| XGameUiShowWebAuthenticationWithOptionsAsync | Exibe uma interface do usuário da Web, com a opção de mostrá-la em tela inteira, que permite ao usuário delegar acesso a sites e serviços externos sem fornecer diretamente suas credenciais ao título em execução. |
| XGameUiTextEntryClose | Fecha o teclado virtual e libera os recursos correspondentes. |
| XGameUiTextEntryGetExtents | Obtém as extensões de tela do teclado virtual. |
| XGameUiTextEntryGetState | Obtém o estado atual do teclado virtual aberto. |
| XGameUiTextEntryOpen | Abre um teclado virtual em que o título é responsável por renderizar o texto. |
| XGameUiTextEntryUpdatePositionHint | Atualiza o posicionamento preferencial do teclado virtual. |
| XGameUiTextEntryUpdateVisibility | Atualiza se deve ser exibido o teclado virtual completo ou apenas a lista de candidatos. |
| XGameUISetUICallbacks | Define os retornos de chamada de interface do usuário definidos pelo desenvolvedor. |
| XGameUISetMessageDialogUIResponse | Define o valor XGameUiMessageDialogButton resultante a ser retornado por XGameUiShowMessageDialogResult. |
| XGameUISetPlayerPickerUIResponse | Define os resultados a serem retornados por XGameUiShowPlayerPickerResultCount e XGameUiShowPlayerPickerResult. |
| XGameUISetTextEntryUIResponse | Define o comprimento do texto resultante e o texto a serem retornados por XGameUiShowTextEntryAsync. |
| XGameUISetPlayerProfileCardUIResponse | Conclui a chamada para XGameUiShowPlayerProfileCardAsync. |
| XGameUISetSendGameInviteUIResponse | Conclui a chamada para XGameUiShowSendGameInviteAsync. |
| XGameUISetAchievementsUIResponse | Conclui a chamada para XGameUiShowAchievementsAsync. |
| XGameUISetMultiplayerActivityGameInviteUIResponse | Conclui a chamada para XGameUiShowMultiplayerActivityGameInviteAsync. |
| XGameUISetErrorDialogUIResponse | Conclui a chamada para XGameUiShowErrorDialogAsync. |
| XGameUIShowPlayerProfileCardUICallback | Assinatura de um retorno de chamada de XGameUiShowPlayerProfileCardAsync. |
| XGameUIShowPlayerPickerUICallback | Assinatura de um retorno de chamada de XGameUiShowPlayerPickerAsync. |
| XGameUIShowSendGameInviteUICallback | Assinatura de um retorno de chamada de XGameUiShowSendGameInviteAsync. |
| XGameUIShowAchievementsUICallback | Assinatura de um retorno de chamada de XGameUiShowAchievementsAsync. |
| XGameUIShowMultiplayerActivityGameInviteUICallback | Assinatura de um retorno de chamada de XGameUiShowMultiplayerActivityGameInviteAsync. |
| XGameUIShowMessageDialogUICallback | Assinatura de um retorno de chamada de XGameUiShowMessageDialogAsync. |
| XGameUIShowErrorDialogUICallback | Assinatura de um retorno de chamada de XGameUiShowErrorDialogAsync. |
| XGameUIShowTextEntryUICallback | Assinatura de um retorno de chamada de XGameUiShowTextEntryAsync. |
Estruturas
| Estrutura | Descrição |
|---|---|
| XGameUiWebAuthenticationResultData | Contém a resposta de uma solicitação de autenticação na Web. |
| XGameUiTextEntryExtents | Descreve o posicionamento relativo do teclado virtual. |
| XGameUiTextEntryOptions | Conjunto inicial de opções para o teclado virtual usado por XGameUiTextEntryOpen. |
| XGameUICallbackHandle | Identificador associado a uma invocação de retorno de chamada do XGameUi. Usado em chamadas para APIs Set*Response. |
| XGameUIPlayerPickerInfo | Struct que encapsula as informações do usuário a serem usadas pela interface do usuário personalizada de seletor de jogadores do desenvolvedor. |
| XGameUIUICallbacks | Struct que contém ponteiros para retornos de chamada de interface do usuário definidos pelo desenvolvedor. |
Enumerações
| Enumeração | Descrição |
|---|---|
| XGameUiMessageDialogButton | Enumera os botões em uma caixa de diálogo de mensagem personalizável. |
| XGameUiNotificationPositionHint | Descreve a posição preferencial para as notificações do sistema serem exibidas no título atual. |
| XGameUiTextEntryChangeTypeFlags | Sinalizadores que indicam o que mudou desde a última chamada para XGameUiTextEntryGetState. |
| XGameUiTextEntryInputScope | Enumera os tipos de informações esperados na entrada de texto. |
| XGameUiTextEntryPositionHint | Dica de onde posicionar melhor o teclado virtual. |
| XGameUiTextEntryVisibilityFlags | Sinalizadores que indicam o estado de visibilidade do teclado virtual. |
| XGameUiWebAuthenticationOptions | Enumera as opções para apresentar o fluxo de autenticação na Web. |
Códigos de erro
Os códigos de erro a seguir podem ser retornados pelas APIs XGameUI. Para obter uma lista completa, consulte Códigos de erro.| Código | Valor | Descrição |
|---|---|---|
| E_GAMEUI_TEXTENTRY_NOT_SHOWN | — | O XGameUiTextEntryHandle não é válido, provavelmente porque você precisa chamar XGameUiTextEntryOpen primeiro. |
Documentação conceitual
- Objetivos e melhorias do design da programação assíncrona
- Threads sensíveis ao tempo
- O que é o Microsoft Game Development Kit?
- Usando wrappers C# para APIs do GDK no seu projeto Unity