Interface que oferece acesso a funções utilitárias diversas.

Funções de membro

Funções de membro de ISteamUtils são chamadas por meio da função de acesso global SteamUtils().

BOverlayNeedsPresent

Verifica se o painel precisa de um "Present". Obrigatório apenas se estiver usando atualizações de renderização movidas a eventos.

Essa chamada costuma ser desnecessária se o jogo tiver um ciclo de quadros em execução constante que chama a API "Present" da D3D ou a API "SwapBuffers" da OpenGL a cada quadro que é o caso da maioria dos jogos. Contudo, se tiver um jogo que só atualiza a tela de acordo com eventos, o painel pode não funcionar corretamente por usar as chamadas "Present"/"SwapBuffers" para processar o ciclo de quadros interno, além de precisar chamar um Present() para a tela sempre que houver uma notificação ou quando o painel é ativado pelo usuário. You can use this API to ask the overlay if it currently need a present in that case, and then you can check for this periodically (roughly 33hz is desirable) and make sure you refresh the screen with Present or SwapBuffers to allow the overlay to do its work.

Retorna: bool
true se o painel precisar que atualize a tela; false caso contrário.

CheckFileSignature

Nome	Tipo	Descrição
szFileName	const char *	.

Em desuso.

Retorna: SteamAPICall_t, a ser usado com o resultado de chamada CheckFileSignature_t.

GetAPICallFailureReason

Nome	Tipo	Descrição
hSteamAPICall	SteamAPICall_t	O handle da chamada à API do Steam cuja falha verificar.

Usada para recuperar o motivo de uma falha para um resultado de chamada.

O uso principal para esta função é depuração. Os motivos para falha costumam ser fora do seu controle e tendem a não serem importantes. Continue tentando realizar a chamada à API até funcionar.

Retorna: ESteamAPICallFailure
[type]ESteamAPICallFailure[/type]

Consulte também: IsAPICallCompleted, GetAPICallResult

Exemplo:

GetAPICallResult

Nome	Tipo	Descrição
hSteamAPICall	SteamAPICall_t	O handle da chamada à API.
pCallback	void *	Retorna o retorno de chamada na memória pré-alocada indicada.
cubCallback	int	O tamanho alocado para o buffer pCallback.
iCallbackExpected	int	O número k_iCallback associado ao retorno de chamada.
pbFailed	bool *	Retorna se a chamada à API encontrou uma falha.

Recupera o conteúdo de uma chamada à API que foi concluída. Oferecida para o backend do encapsulador do resultado de chamada.

Não é aconselhável usar essa função manualmente.

Retorna: bool
true se a chamada à API for válida e concluída; false caso contrário.

Se a chamada foi bem-sucedida, copia o retorno de chamada no buffer pCallback e retorna falhas em pbFailed.

Consulte também: IsAPICallCompleted, GetAPICallFailureReason

GetAppID

Recupera o AppID do processo atual.

Retorna: uint32
Retorna o AppID.

GetConnectedUniverse

Recupera o universo ao qual o cliente está se conectando. (Uso interno da Valve.)

Retorna: EUniverse
[type]EUniverse[/type]

GetCSERIPPort

Nome	Tipo	Descrição
unIP	uint32 *	Retorna o endereço IP ao qual o cliente está conectado.
usPort	uint16 *	Retorna a porta à qual o cliente está conectado.

Gets the IP of the reporting server for Valve - currently only used in Source engine games

Retorna: bool
Retorna true se o usuário estiver conectado; false caso contrário.

GetCurrentBatteryPower

Recupera a porcentagem atual da carga da bateria do computador.

Retorna: uint8
A porcentagem atual da carga da bateria, no intervalo [0..100]%. Retorna 255 se estiver ligado à tomada.

GetEnteredGamepadTextInput

Nome	Tipo	Descrição
pchText	char *	Um buffer pré-alocado para o qual copiar a string de entrada de texto.
cchText	uint32	O tamanho do buffer alocado para pchText.

Recupera a entrada de texto do controle feita pelo painel do Big Picture.

Deve ser chamada no retorno de chamada GamepadTextInputDismissed_t, e apenas se o valor de GamepadTextInputDismissed_t.m_bSubmitted for true.

Provides the text input as UTF-8.

Retorna: bool
true se havia texto para receber e cchText for do mesmo tamanho de GamepadTextInputDismissed_t.m_unSubmittedText; false caso contrário.

Consulte também: ShowGamepadTextInput, GetEnteredGamepadTextLength

Exemplo:

GetEnteredGamepadTextLength

Recupera o tamanho da entrada de texto do controle feita pelo painel do Big Picture.

Deve ser chamada no retorno de chamada GamepadTextInputDismissed_t, e apenas se o valor de GamepadTextInputDismissed_t.m_bSubmitted for true.

Retorna: uint32


Consulte também: ShowGamepadTextInput, GetEnteredGamepadTextInput

Exemplo:

GetImageRGBA

Nome	Tipo	Descrição
iImage	int	O handle da imagem que será recuperada.
pubDest	uint8 *	O buffer que será preenchido.
nDestBufferSize	int	O tamanho do buffer alocado para pubDest.

Recupera os bytes de uma imagem a partir de um handle de imagem.

Antes de chamar esta função, recupere o tamanho da mensagem pela função GetImageSize para que possa criar um buffer de tamanho apropriado. Você então poderá alocar o buffer usando esta fórmula: largura * altura * 4. A imagem é fornecida no formato RGBA. Essa chamada pode ser um pouco custosa, por converter do tipo comprimido (JPG, PNG, TGA) e não ter um armazenamento interno do buffer retornado, sendo aconselhável chamar uma vez por handle e fazer um armazenamento próprio. Essa função só é usada para imagens de avatares e conquistas, que raramente são alteradas durante uma partida.

Retorna: bool
true se o handle da imagem for válido e o buffer foi preenchido; false caso contrário.

Consulte também: ISteamFriends::GetSmallFriendAvatar, ISteamFriends::GetMediumFriendAvatar, ISteamFriends::GetLargeFriendAvatar, ISteamUserStats::GetAchievementIcon

Exemplo:

GetImageSize

Nome	Tipo	Descrição
iImage	int	O handle da imagem cujo tamanho recuperar.
pnWidth	uint32 *	Retorna a largura da imagem.
pnHeight	uint32 *	Retorna a altura da imagem.

Recupera o tamanho de um handle de imagem do Steam.

Essa função deve ser chamada antes de chamar a função GetImageRGBA para criar um buffer de tamanho adequado para receber os dados brutos da imagem.

Retorna: bool
true se o handle da imagem for válido e o tamanho foi preenchido; false caso contrário.

Consulte também: ISteamFriends::GetSmallFriendAvatar, ISteamFriends::GetMediumFriendAvatar, ISteamFriends::GetLargeFriendAvatar, ISteamUserStats::GetAchievementIcon

GetIPCCallCount

Retorna a quantidade de chamadas de comunicação entre processos (IPC) realizadas desde que esta função foi chamada pela última vez.

Usada para depuração de desempenho, para que possa verificar quantas chamadas de IPC o jogo realiza por quadro.
Cada chamada de IPC resulta, no mínimo, em uma troca de contexto de thread, ou mesmo uma troca de processo, então seja diligente e controle a frequência em que são feitas.

Retorna: uint32

GetIPCountry

Retorna o código ISO 3166-1 alfa-2, de dois dígitos, que indica o código do país em que o cliente está sendo executado.
ex.: "US" ou "BR".

O valor é convertido por meio de um banco de dados que mapeia endereços IP a localizações.

Retorna: const char *

GetSecondsSinceAppActive

Retorna o tempo de atividade do aplicativo, em segundos.

Retorna: uint32

GetSecondsSinceComputerActive

Retorna o tempo desde a última vez que o usuário moveu o mouse, em segundos.

Retorna: uint32

GetServerRealTime

Retorna o horário dos servidores Steam, no formato de Era Unix (segundos a partir de 1º de janeiro de 1970 UTC).

Retorna: uint32

GetSteamUILanguage

Retorna o idioma usado para execução do cliente Steam.

Recomendamos usar a função ISteamApps::GetCurrentGameLanguage no lugar desta, que deve ser usada apenas em casos muito específicos.

A lista completa de idiomas está disponível em Idiomas disponíveis.

Retorna: const char *


Consulte também: ISteamApps::GetCurrentGameLanguage, ISteamApps::GetAvailableGameLanguages

IsAPICallCompleted

Nome	Tipo	Descrição
hSteamAPICall	SteamAPICall_t	O handle da chamada à API a verificar.
pbFailed	bool *	Retorna se a chamada à API encontrou uma falha (true) ou não (false).

Verifica se uma chamada à API foi concluída. Fornece o backend do encapsulador do resultado de chamada.

Não é aconselhável usar essa função.

Retorna: bool
true se a chamada à API for válida e estiver concluída; false caso contrário.

Consulte também: GetAPICallResult, GetAPICallFailureReason

IsOverlayEnabled

Verifica se o Painel Steam está em execução e o usuário pode acessá-lo.

O processo do painel pode levar alguns minutos para ser iniciado e se vincular ao processo do jogo, então essa função retornará false enquanto o painel estiver sendo carregado.

Retorna: bool

IsSteamChinaLauncher

Retorna se o inicializador atual é o do Steam China. Para forçar o cliente Steam a se comportar como o inicializador do Steam China, adicione -dev -steamchina à linha de comando ao executar o Steam.

InitFilterText

Inicializa a filtragem de texto, carregando os dicionários do idioma de execução do jogo.

Usuários podem personalizar o comportamento do filtro nas preferências da conta Steam.

Retorna: bool
true se a inicialização for bem-sucedida; false se a filtragem não estiver disponível no idioma do jogo — nesse caso, a função FilterText() não fará nada e retornará o mesmo texto de entrada.

Consulte também: FilterText

FilterText

Nome	Tipo	Descrição
eContext	ETextFilteringContext	O tipo de conteúdo da string de entrada.
sourceSteamID	CSteamID	O ID Steam que gerou a string de entrada (ou seja, o usuário com o nome ou que enviou a mensagem na conversa).
pchInputText	const char*	A string de entrada que será filtrada, codificada em ASCII ou UTF-8.
pchOutFilteredText	char*	Onde a saída será armazenada, mesmo se não houver filtragem aplicada.
nByteSizeOutFilteredText	uint32	O tamanho do buffer alocado para pchOutFilteredText, em bytes. Tamanho mínimo: strlen(pchInputText)+1.

Filtra a mensagem de entrada informada, inserindo o resultado filtrado no ponteiro pchOutFilteredText. Regras de filtragem exigidas por lei sempre serão aplicadas. Além disso, pode ocorrer uma filtragem adicional de acordo com o contexto e as configurações do usuário.

Retorna: int
Retorna a quantidade de caracteres (e não bytes) filtrados.

Consulte também: InitFilterText

IsSteamInBigPictureMode

Verifica se o Steam e o Painel Steam estão em execução no modo Big Picture.

Games must be launched through the Steam client to enable the Big Picture overlay.
During development, a game can be added as a non-steam game to the developer's library to test this feature.

Retorna: bool
true se o painel do Big Picture estiver disponível; false caso contrário.
Sempre retornará false se o aplicativo não for do tipo de aplicativo "game".

IsSteamRunningInVR

Verifica se o Steam está em execução no modo de realidade virtual (RV).

Retorna: bool
true se o Steam estiver em execução no modo de RV; false caso contrário.

IsVRHeadsetStreamingEnabled

Checks if the HMD view is being streamed via Steam Remote Play.

Retorna: bool
true se o modo de RV estiver ativado e a visão do headset estiver sendo transmitida; false caso contrário.

Consulte também: SetVRHeadsetStreamingEnabled

IsSteamRunningOnSteamDeck

Verifica se o Steam está em execução em um dispositivo Steam Deck.

Retorna: bool
true se o Steam estiver em execução em um dispositivo Steam Deck; false caso contrário.

SetOverlayNotificationInset

Nome	Tipo	Descrição
nHorizontalInset	int	A distância horizontal, em pixels, contados a partir do canto esquerdo da tela.
nVerticalInset	int	A distância vertical, em pixels, contados a partir do canto superior da tela.

Define a distância da notificação do painel a partir do canto da tela especificado pela função SetOverlayNotificationPosition.

Um valor (0, 0) coloca a notificação "grudada" no canto da tela.

Essa posição é definida por jogo e redefinida a cada inicialização.

SetOverlayNotificationPosition

Nome	Tipo	Descrição
eNotificationPosition	ENotificationPosition

Define em qual canto da tela as notificações do Painel Steam devem ser exibidas.

Também é possível definir a distância ao canto especificado por meio da função SetOverlayNotificationInset.

Essa posição é definida por jogo e redefinida a cada inicialização.

SetVRHeadsetStreamingEnabled

Nome	Tipo	Descrição
bEnabled	bool	Ativa (true) ou desativa (false) a transmissão da visão do headset.

Define se o conteúdo exibido no headset será transmitido pelo Steam Remote Play.

Se ativado, então a cena exibida no headset será transmitida, impedindo o controle remoto. Caso contrário, a janela do aplicativo será transmitida no lugar, permitindo o controle remoto. Ativado por padrão para jogos de realidade virtual, a menos que o parâmetro "VRHeadsetStreaming" esteja com o valor "0" nos dados estendidos de aplicativo para o jogo.

Útil para jogos com mecânicas assimétricas (onde o jogador com o headset faz uma coisa e os jogadores usando o Remote Play fazem outra).

Consulte também: IsVRHeadsetStreamingEnabled

SetWarningMessageHook

Nome	Tipo	Descrição
pFunction	SteamAPIWarningMessageHook_t	Ponteiro de função para a função de retorno de chamada.

Define um gancho de mensagem de alerta para receber mensagens de alerta e informação da SteamAPI em uma função de retorno de chamada.

O protótipo da função deve ser equivalente à definição em SteamAPIWarningMessageHook_t. Isso inclui a vinculação "extern C" e a convenção de chamadas __cdecl.

"int nSeverity" é a gravidade. 0 para mensagens, 1 para alertas. Se estiver executando por meio de um depurador, apenas alertas serão enviados. Se adicionar -debug_steamapi à linha de comando, então mensagens informativas também serão enviadas.
"const char * pchDebugText" é o texto da mensagem.
Retornos de chamada serão disparados assim que a função da API chamada gerar o alerta ou a mensagem.

Passar um valor NULL removerá o gancho.

Exemplo:

ShowGamepadTextInput

Nome	Tipo	Descrição
eInputMode	EGamepadTextInputMode	Seleciona o modo de entrada a usar, normal ou senha (texto oculto).
eLineInputMode	EGamepadTextInputLineMode	Seleciona se a entrada será em uma ou várias linhas.
pchDescription	const char *	Define a descrição usada para informar ao usuário o motivo da entrada.
unCharMax	uint32	A quantidade máxima de caracteres permitida.
pchExistingText	const char *	Define o texto pré-existente, que pode ser editado pelo usuário.

Ativa o painel de entrada de texto do Big Picture, exclusivo para uso com controles.

Retorna: bool
true se o painel do Big Picture estiver em execução; false caso contrário.

Consulte também: GetEnteredGamepadTextLength, GetEnteredGamepadTextInput

ShowFloatingGamepadTextInput

Nome	Tipo	Descrição
eKeyboardMode	EFloatingGamepadTextInputMode	Seleciona o tipo de teclado que será usado.
nTextFieldXPosition	int	X coordinate of text field which shouldn't be obscured by the floating keyboard
nTextFieldYPosition	int	Y coordinate of text field which shouldn't be obscured by the floating keyboard
nTextFieldWidth	int	width of text field which shouldn't be obscured by the floating keyboard
nTextFieldHeight	int	height of text field which shouldn't be obscured by the floating keyboard

Abre um teclado flutuante sobreposto ao conteúdo do jogo e envia sinais de teclas do teclado do SO diretamente ao jogo.
A posição do campo de texto é especificada em pixels relativos à origem da janela do jogo e é usada para posicionar o teclado flutuante de forma que não cubra o campo de texto.

Retorna: bool
true se o teclado flutuante foi aberto; false caso contrário.

Consulte também: FloatingGamepadTextInputDismissed_t

StartVRDashboard

Pede que o Steam crie e renderize o painel do OpenVR.

SetGameLauncherMode

Nome	Tipo	Descrição
bLauncherMode	bool	Define se um inicializador está ativo ou não.

Chame esta função em inicializadores sem compatibilidade com controle para que a Entrada Steam traduza a entrada do controle em comandos de mouse/teclado para navegar pelo inicializador.

Retornos de chamada

These are callbacks which can be fired by calling SteamAPI_RunCallbacks. Many of these will be fired directly in response to the member functions of ISteamUtils.

CheckFileSignature_t

CallResult for CheckFileSignature.

Nome	Tipo	Descrição
m_eCheckFileSignature	ECheckFileSignature	Contains the result of the file signature check. k_ECheckFileSignatureNoSignaturesFoundForThisApp - This app has not been configured on the signing tab of the partner site to enable this function. k_ECheckFileSignatureNoSignaturesFoundForThisFile - This file is not listed on the signing tab for the partner site. k_ECheckFileSignatureFileNotFound - The file does not exist on disk. k_ECheckFileSignatureInvalidSignature - The file exists, and the signing tab has been set for this file, but the file is either not signed or the signature does not match. k_ECheckFileSignatureValidSignature - The file is signed and the signature is valid.

Funções associadas: CheckFileSignature

GamepadTextInputDismissed_t

Called when the big picture gamepad text input has been closed.

Nome	Tipo	Descrição
m_bSubmitted	bool	true se o usuário inseriu e aceitou o envio do texto (chame a função GetEnteredGamepadTextInput para recebê-lo), false se a entrada foi cancelada.
m_unSubmittedText	uint32	Contém o tamanho da entrada, em bytes, se houve envio de texto.

FloatingGamepadTextInputDismissed_t

Called when the floating keyboard invoked from ShowFloatingGamepadTextInput has been closed.

IPCountry_t

Called when the country of the user changed. The country should be updated with GetIPCountry.

This callback has no fields.

LowBatteryPower_t

Called when running on a laptop and less than 10 minutes of battery is left, and then fires then every minute afterwards.

Nome	Tipo	Descrição
m_nMinutesBatteryLeft	uint8	A duração estimada da carga da bateria, em minutos.

SteamAPICallCompleted_t

Called when a SteamAPICall_t has completed (or failed)

Nome	Tipo	Descrição
m_hAsyncCall	SteamAPICall_t	O handle da chamada à API do Steam que foi concluída.
m_iCallback	int	A constante k_iCallback que identifica o retorno de chamada concluído.
m_cubParam	uint32	O tamanho, em bytes, do retorno de chamada concluído.

AppResumingFromSuspend_t

Sent after the device returns from sleep/suspend mode.

This callback has no fields.

SteamShutdown_t

Called when Steam wants to shutdown.

Este retorno de chamada não possui campos.

Enumerações

These are enums which are defined for use with ISteamUtils.

ECheckFileSignature

The result of a call to CheckFileSignature

Nome	Valor	Descrição
k_ECheckFileSignatureInvalidSignature	0
k_ECheckFileSignatureValidSignature	1
k_ECheckFileSignatureFileNotFound	2
k_ECheckFileSignatureNoSignaturesFoundForThisApp	3
k_ECheckFileSignatureNoSignaturesFoundForThisFile	4

EGamepadTextInputLineMode

Controls number of allowed lines for the Big Picture gamepad text entry

Nome	Valor	Descrição
k_EGamepadTextInputLineModeSingleLine	0
k_EGamepadTextInputLineModeMultipleLines	1

EGamepadTextInputMode

Input modes for the Big Picture gamepad text entry

Nome	Valor	Descrição
k_EGamepadTextInputModeNormal	0
k_EGamepadTextInputModePassword	1

EFloatingGamepadTextInputMode

Controls the mode for the floating keyboard

Nome	Valor	Descrição
k_EFloatingGamepadTextInputModeModeSingleLine	0	O teclado é fechado quando o usuário apertar Enter.
k_EFloatingGamepadTextInputModeModeMultipleLines	1	O usuário precisa fechar o teclado manualmente.
k_EFloatingGamepadTextInputModeModeEmail	2	O teclado apresentará teclas específicas para facilitar a digitação de endereços de e-mail.
k_EFloatingGamepadTextInputModeModeNumeric	3	Um teclado numérico será exibido.

ESteamAPICallFailure

Steam API call failure results returned by GetAPICallFailureReason.

Nome	Valor	Descrição
k_ESteamAPICallFailureNone	-1	Sem falhas.
k_ESteamAPICallFailureSteamGone	0	O processo local do Steam parou de responder, pode ter sido encerrado à força ou estar congelado.
k_ESteamAPICallFailureNetworkFailure	1	A conexão de rede aos servidores Steam foi perdida ou não existia. Um retorno de chamada SteamServersDisconnected_t será disparado ao mesmo tempo, e um retorno de chamada SteamServersConnected_t será disparado quando o cliente restabelecer a comunicação aos servidores Steam.
k_ESteamAPICallFailureInvalidHandle	2	O handle SteamAPICall_t passado não existe mais.
k_ESteamAPICallFailureMismatchedCallback	3	A função GetAPICallResult foi chamada com o tipo de retorno de chamada errado para a chamada.

Constantes

These are constants which are defined for use with ISteamUtils.

Nome	Tipo	Valor	Descrição
STEAMUTILS_INTERFACE_VERSION	const char *	"SteamUtils009"