Interfaz que proporciona acceso a una variedad de funciones prácticas.

Funciones de miembros

Las funciones miembro para ISteamUtils se llaman a través de la función de acceso global SteamUtils().

BOverlayNeedsPresent

Comprueba si la interfaz necesita Present. Solo es necesaria si se usan actualizaciones de representación orientadas a eventos.

Normalmente, esta llamada no es necesaria si el juego tiene un bucle de cuadros en constante ejecución que llama a la API Present de D3D o a la API SwapBuffers de OGL en cada cuadro, como suele ocurrir en la mayoría de los juegos. Sin embargo, si se trata de un juego que solo actualiza la pantalla a partir de eventos, se podría dañar la interfaz, ya que usa las llamadas a Present o SwapBuffers para dirigir su bucle de cuadros interno y es posible que también necesite usar Present() en la pantalla cada vez que surge una notificación o cuando un usuario hace que la interfaz se sitúe por encima del juego. En ese caso, se puede usar esta API para preguntar a la interfaz si necesita "Present", volver a comprobarlo periódicamente (lo ideal son unos 33 Hz) y asegurarse de actualizar la pantalla con "Present" o "SwapBuffers" para que la interfaz pueda funcionar.

Devuelve: bool
True si la interfaz necesita que actualices la pantalla; de lo contrario, false.

CheckFileSignature

Nombre	Tipo	Descripción
szFileName	const char *	.

Obsoleto.

Devuelve: SteamAPICall_t para usar con el resultado de la llamada CheckFileSignature_t.

GetAPICallFailureReason

Nombre	Tipo	Descripción
hSteamAPICall	SteamAPICall_t	El identificador de Steam API Call para el que se verifica el error.

Se usa para obtener el motivo del error de un resultado de llamada.

Esta función se usa principalmente para la depuración. Por lo general, las causas del error no se pueden controlar y son poco importantes. Se puede repetir la llamada a la API hasta que funcione.

Devuelve: ESteamAPICallFailure
[type]ESteamAPICallFailure[/type]

Véase también: IsAPICallCompleted, GetAPICallResult

Ejemplo:

GetAPICallResult

Nombre	Tipo	Descripción
hSteamAPICall	SteamAPICall_t	El identificador de la llamada a la API.
pCallback	void *	Devuelve la función callback y la almacena en la memoria reservada anteriormente.
cubCallback	int	Tamaño de pCallback que se pasa.
iCallbackExpected	int	El número k_iCallback asociado con la función callback.
pbFailed	bool *	Devuelve si la llamada a la API ha encontrado un error.

Obtiene el contenido de una llamada a la API completada. Se proporciona para el backend del contenedor CallResult.

Por lo general, no se recomienda utilizarlo manualmente.

Devuelve: bool
true en caso de éxito si la llamada a la API es válida y se ha completado, de lo contrario, false.

Si la llamada es exitosa, copiará la función callback en pCallback y devuelve errores en pbFailed.

Véase también: IsAPICallCompleted, GetAPICallFailureReason

GetAppID

Obtiene el id. de aplicación del proceso actual.

Devuelve: uint32
Devuelve el id. de aplicación.

GetConnectedUniverse

Obtiene el universo al que se está conectando el cliente actual. (Solo para uso de Valve).

Devuelve: EUniverse
[type]EUniverse[/type]

GetCSERIPPort

Nombre	Tipo	Descripción
unIP	uint32 *	Devuelve la IP a la que está conectado el cliente.
usPort	uint16 *	Devuelve el puerto al que está conectado el cliente.

Obtiene la IP del servidor de informes de Valve. Actualmente, se usa solo en juegos con motor Source.

Devuelve: bool
Devuelve true si el usuario está conectado actualmente; de lo contrario, false.

GetCurrentBatteryPower

Obtiene el nivel de carga actual de la batería del ordenador.

Devuelve: uint8
La potencia actual de la batería oscila entre [0..100] %. Devuelve 255 cuando el usuario está conectado a la red eléctrica.

GetEnteredGamepadTextInput

Nombre	Tipo	Descripción
pchText	char *	Un búfer preasignado en el que se copia la cadena de entrada del texto.
cchText	uint32	El tamaño del búfer pchText.

Obtiene la entrada de texto del gamepad desde la interfaz de Big Picture.

Esto debe llamarse dentro de la función callback GamepadTextInputDismissed_t, y solo si GamepadTextInputDismissed_t.m_bSubmitted es true.

Proporciona la entrada de texto como UTF-8.

Devuelve: bool
true si había texto para recibir y cchText es del mismo tamaño que GamepadTextInputDismissed_t.m_unSubmittedText; de lo contrario, false.

Véase también: ShowGamepadTextInput, GetEnteredGamepadTextLength

Ejemplo:

GetEnteredGamepadTextLength

Obtiene la longitud de la entrada de texto del gamepad desde la interfaz de Big Picture.

Esto debe llamarse dentro de la función callback GamepadTextInputDismissed_t, y solo si GamepadTextInputDismissed_t.m_bSubmitted es true.

Devuelve: uint32


Véase también: ShowGamepadTextInput, GetEnteredGamepadTextInput

Ejemplo:

GetImageRGBA

Name	Tipo	Descripción
iImage	int	Handle de la imagen que se va a obtener.
pubDest	uint8 *	Búfer que se va a llenar.
nDestBufferSize	int	El tamaño total del búfer pubDest.

Obtiene los bytes de la imagen a partir del identificador o handle de una imagen.

Antes de llamar a esta función, se debe obtener el tamaño de la imagen mediante una llamada a GetImageSize para poder crear el búfer con el tamaño adecuado. Después, se puede reservar en la memoria del búfer el alto y el ancho de esta forma: ancho * alto * 4. La imagen se proporciona en formato RGBA. Esta llamada puede consumir muchos recursos, ya que realiza una conversión desde el tipo comprimido (JPG, PNG, TGA) y no ofrece almacenamiento en la caché interna para el búfer que se devuelve. Por esta razón, lo más recomendable es realizar la llamada una sola vez por cada identificador o handle de la imagen y almacenar en la caché el resultado. Esta función solo se usa para las imágenes de avatares y logros de Steam, que normalmente no cambian durante el juego.

Devuelve: bool
true en caso de éxito, si el identificador de la imagen es válido y se llenó el búfer, de lo contrario, false.

Véase también: ISteamFriends::GetSmallFriendAvatar, ISteamFriends::GetMediumFriendAvatar, ISteamFriends::GetLargeFriendAvatar, ISteamUserStats::GetAchievementIcon

Ejemplo:

GetImageSize

Nombre	Tipo	Descripción
iImage	int	Handle de la imagen cuyo tamaño se va a obtener.
pnWidth	uint32 *	Devuelve la anchura de la imagen.
pnHeight	uint32 *	Devuelve la altura de la imagen.

Obtiene el tamaño de un identificador o handle de la imagen de Steam.

Se debe invocar antes de llamar a GetImageRGBA para crear un búfer del tamaño adecuado que se llenará con los datos de la imagen sin procesar.

Devuelve: bool
true en caso de éxito, si el identificador de la imagen es válido y se llenaron los tamaños, de lo contrario, false.

Véase también: ISteamFriends::GetSmallFriendAvatar, ISteamFriends::GetMediumFriendAvatar, ISteamFriends::GetLargeFriendAvatar, ISteamUserStats::GetAchievementIcon

GetIPCCallCount

Devuelve el número de llamadas IPC (Inter-Process Communication o comunicación entre procesos) realizadas desde la última vez que se llamó a esta función.

Se utiliza para la depuración perfecta para que puedas determinar cuántas llamadas IPC (Comunicación entre procesos) realiza tu juego por fotograma.
Cada llamada de IPC es, como mínimo, un cambio de contexto de subproceso, si no es un proceso, por lo que querrás controlar la frecuencia con la que las realiza.

Devuelve: uint32

GetIPCountry

Devuelve el código de país en formato ISO 3166-1-alpha-2 de 2 dígitos en el que se está ejecutando el cliente.
por ejemplo, "US" o "UK".

Se consulta en una base de datos que asocia las IP con ubicaciones.

Devuelve: const char *

GetSecondsSinceAppActive

Devuelve el número de segundos transcurridos desde que la aplicación estuvo activa.

Devuelve: uint32

GetSecondsSinceComputerActive

Devuelve el número de segundos transcurridos desde que el usuario movió el mouse por última vez.

Devuelve: uint32

GetServerRealTime

Devuelve la hora del servidor de Steam en formato de tiempo Unix (segundos transcurridos desde el 1 de enero de 1970 UTC).

Devuelve: uint32

GetSteamUILanguage

Devuelve el idioma en el que se está ejecutando el cliente de Steam.

Probablemente quieras ISteamApps::GetCurrentGameLanguage en su lugar, esto solo debe usarse en casos muy especiales.

Para ver la lista completa de idiomas, consulta Idiomas disponibles.

Devuelve: const char *


Véase también: ISteamApps::GetCurrentGameLanguage, ISteamApps::GetAvailableGameLanguages

IsAPICallCompleted

Nombre	Tipo	Descripción
hSteamAPICall	SteamAPICall_t	El handle de API Call a comprobar.
pbFailed	bool *	Devuelve si la llamada a la API ha encontrado un error (true) o no (false).

Comprueba si se ha completado una llamada a la API. Proporciona el backend del contenedor CallResult.

En general, no es recomendable usar esta función manualmente.

Devuelve: bool
true si la llamada a la API es válida y se ha completado, de lo contrario, false.

Véase también: GetAPICallResult, GetAPICallFailureReason

IsOverlayEnabled

Comprueba si Steam Overlay se está ejecutando y el usuario puede acceder a él.

El proceso de la interfaz puede tardar unos segundos en iniciarse y enlazarse al proceso del juego, por lo que esta función devolverá false inicialmente hasta que la interfaz se cargue.

Devuelve: bool

IsSteamChinaLauncher

Devuelve si el lanzador actual es un lanzador de Steam China. Puedes hacer que el cliente se comporte como el lanzador de Steam China agregando -dev -steamchina a la línea de comandos cuando ejecutas Steam.

InitFilterText

Inicia el filtrado de texto, carga los diccionarios para el idioma en el que se está jugando.

Los usuarios pueden personalizar los filtrados de texto en sus preferencias de cuenta de Steam

Devuelve: bool
true si la inicialización se cumple con éxito, y false si el filtrado no está disponible para el idioma del juego, en cuyo caso FilterText() solo pasará el valor.

Véase también: FilterText

FilterText

Nombre	Tipo	Descripción
eContext	ETextFilteringContext	El tipo de contenido de la cadena introducida.
sourceSteamID	CSteamID	El Id. de Steam de quien introdujo la cadena de texto (por ejemplo, el jugador con el nombre, o quien escribió este texto en el chat).
pchInputText	const char*	La cadena introducida que se tiene que filtrar, que puede ser ASCII o UTF-8
pchOutFilteredText	char*	Donde se almacenará el resultado, incluso si no se realiza ningún filtrado
nByteSizeOutFilteredText	uint32	El tamaño en (bytes) de pchOutFilteredText, debe ser, al menos, de longitud strlen(pchInputText)+1

Filtra el mensaje de entrada proporcionado y almacena el resultado filtrado en pchOutFilteredText. Los filtros exigidos por la legislación se aplican siempre. Puede producirse un filtrado adicional basado en el contexto y en la configuración del usuario.

Devuelve: int
Devuelve el número de caracteres (no bytes) filtrados.

Véase también: InitFilterText

IsSteamInBigPictureMode

Comprueba si Steam y la interfaz de Steam se están ejecutando en el modo Big Picture.

Los juegos deben iniciarse a través del cliente de Steam para activar la interfaz de Big Picture.
Durante el desarrollo de un juego, este puede agregarse como producto que no es de Steam a la biblioteca de los desarrolladores para probar esta característica.

Devuelve: bool
true si la interfaz de Big Picture está disponible; de lo contrario,
false.
Siempre devolverá false si tu aplicación no es una aplicación de tipo "juego". Ver tipos de aplicación.

IsSteamRunningInVR

Comprueba si Steam se está ejecutando en modo de RV.

Devuelve: bool
true si Steam se está ejecutando en modo de RV; de lo contrario, false.

IsVRHeadsetStreamingEnabled

Comprueba si la vista del visor se está retransmitiendo a través de Steam Remote Play.

Devuelve: bool
true si la RV está habilitada y la vista de visor se está retransmitiendo; de lo contrario, false.

Véase también: SetVRHeadsetStreamingEnabled

IsSteamRunningOnSteamDeck

Comprueba si Steam se está ejecutando en un dispositivo Steam Deck.

Devuelve: bool
true si Steam se está ejecutando en un dispositivo Steam Deck; de lo contrario, false.

SetOverlayNotificationInset

Nombre	Tipo	Descripción
nHorizontalInset	int	Distancia horizontal (de izquierda a derecha) en píxeles desde la esquina.
nVerticalInset	int	Distancia vertical (de arriba a abajo) en píxeles desde la esquina.

Establece el encuadre de la ventana de notificación desde la esquina especificada en SetOverlayNotificationPosition.

Un valor de (0, 0) restablece la posición a la esquina.

La posición es independiente para cada juego y se restablece en cada inicio.

SetOverlayNotificationPosition

Nombre	Tipo	Descripción
eNotificationPosition	ENotificationPosition

Establece en qué esquina de la interfaz de Steam se debe mostrar la ventana de notificación emergente.

También puedes establecer la distancia desde la esquina especificada en SetOverlayNotificationInset.

La posición es independiente para cada juego y se restablece en cada inicio.

SetVRHeadsetStreamingEnabled

Nombre	Tipo	Descripción
bEnabled	bool	Activa la retransmisión del visor de RV (true) o la desactiva (false).

Establece si el contenido del visor se retransmitirá a través de Steam Remote Play.

Si se activa, se retransmitirá la escena del visor y no se permitirá la entrada remota. Si se desactiva, se retransmitirá la ventana de la aplicación y se permitirá la entrada remota. Los juegos de RV están activados de forma predeterminada, a menos que tengan "VRHeadsetStreaming" "0" en la información de aplicación extendida para un juego.

Esto es útil para los juegos que tienen un modo multijugador asimétrico.

Véase también: IsVRHeadsetStreamingEnabled

SetWarningMessageHook

Nombre	Tipo	Descripción
pFunction	SteamAPIWarningMessageHook_t	Un puntero a la función callback.

Establece un enlace para recibir mensajes de advertencia e información de la API de Steam en una función callback.

La función prototipo debe coincidir con la definición en SteamAPIWarningMessageHook_t. Esto incluye la vinculación extern "C" y la convención de llamada __cdecl.

'int nSeverity' es el nivel de gravedad: 0 para mensaje y 1 para advertencia. Si la ejecución se está haciendo a través de un depurador, solo se enviarán advertencias. Si agregas -debug_steamapi a la línea de comandos, también se enviarán mensajes informativos.

'const char * pchDebugText' es el texto del mensaje.
La función callback se ejecuta directamente después de que se llame a la función API que generó la advertencia o el mensaje.

Si se pasa el valor NULL, se cancela el enlace.

Ejemplo:

ShowGamepadTextInput

Nombre	Tipo	Descripción
eInputMode	EGamepadTextInputMode	Selecciona el modo de entrada que se usará, ya sea Normal o Password (texto oculto).
eLineInputMode	EGamepadTextInputLineMode	Controla si la entrada podrá tener una sola línea o varias.
pchDescription	const char *	Establece la descripción que informará al usuario de la utilidad del diálogo de entrada.
unCharMax	uint32	Número máximo de caracteres que puede introducir el usuario.
pchExistingText	const char *	Establece el texto preexistente que el usuario puede editar.

Activa el cuadro de diálogo de entrada de texto de Big Picture, que solo admite la entrada mediante gamepad.

Devuelve: bool
true si se está ejecutando la interfaz de Big Picture; de lo contrario, false.

Véase también: GetEnteredGamepadTextLength, GetEnteredGamepadTextInput

ShowFloatingGamepadTextInput

Nombre	Tipo	Descripción
eKeyboardMode	EFloatingGamepadTextInputMode	Selecciona el tipo de teclado que se debe utilizar.
nTextFieldXPosition	int	Coordenada X del campo de texto que no debe quedar oculto bajo el teclado flotante.
nTextFieldYPosition	int	Coordenada Y del campo de texto que no debe quedar oculto bajo el teclado flotante.
nTextFieldWidth	int	Anchura del campo de texto que no debe quedar oculto bajo el teclado flotante.
nTextFieldHeight	int	Altura del campo de texto que no debe quedar oculto bajo el teclado flotante.

Abre un teclado flotante sobre el contenido del juego y envía las pulsaciones en el teclado del sistema operativo directamente al juego.
La posición del campo de texto se especifica en píxeles relativos al origen de la ventana del juego y se utiliza para situar el teclado flotante de forma que no cubra el campo de texto.

Devuelve: bool
true si se mostró el teclado flotante; de lo contrario, false.

Véase también: FloatingGamepadTextInputDismissed_t

StartVRDashboard

Solicita a Steam que cree y represente el panel de OpenVR.

SetGameLauncherMode

Nombre	Tipo	Descripción
bLauncherMode	bool	Si hay un lanzador activo o no.

En los lanzadores de juegos que no son compatibles con control, se puede llamar a esta función para que Steam Input convierta las entradas del control en entradas de mouse y teclado para desplazarse por el lanzador.

Devoluciones de llamada

Estas son funciones callback que se activan al llamar a SteamAPI_RunCallbacks. Muchas de estas se activarán directamente en respuesta a las funciones miembro de ISteamUtils.

CheckFileSignature_t

CallResult para CheckFileSignature.

Nombre	Tipo	Descripción
m_eCheckFileSignature	ECheckFileSignature	Incluye el resultado de la comprobación de la firma del archivo. k_ECheckFileSignatureNoSignaturesFoundForThisApp: esta aplicación no se ha configurado en la pestaña de firma del sitio asociado para habilitar esta función. k_ECheckFileSignatureNoSignaturesFoundForThisFile: este archivo no está en la lista de la pestaña de firma del sitio asociado. k_ECheckFileSignatureFileNotFound: este archivo no existe en el disco. k_ECheckFileSignatureInvalidSignature: el archivo existe y se ha configurado en la pestaña de firma, pero el archivo no está firmado o la firma no coincide. k_ECheckFileSignatureValidSignature: el archivo está firmado y la firma es válida.

Funciones asociadas: CheckFileSignature

GamepadTextInputDismissed_t

Se llama a esta función cuando se cierra la entrada de texto a través del gamepad en modo Big Picture.

Nombre	Tipo	Descripción
m_bSubmitted	bool	True si el usuario ingresó y aceptó el texto (llama a GetEnteredGamepadTextInput para recibir el texto), false si se canceló la entrada.
m_unSubmittedText	uint32	Si se envió texto, contiene su longitud en bytes.

FloatingGamepadTextInputDismissed_t

Se llama cuando se ha cerrado el teclado flotante invocado desde ShowFloatingGamepadTextInput.

IPCountry_t

Se llama cuando el país del usuario ha cambiado. El país debe actualizarse con GetIPCountry.

Esta función callback no tiene campos.

LowBatteryPower_t

Se llama cuando se está usando un equipo portátil y quedan menos de 10 minutos de batería, y una vez por minuto a partir de la primera llamada.

Nombre	Tipo	Descripción
m_nMinutesBatteryLeft	uint8	La batería restante estimada en minutos.

SteamAPICallCompleted_t

Se llama cuando SteamAPICall_t se ha completado (o ha fallado).

Nombre	Tipo	Descripción
m_hAsyncCall	SteamAPICall_t	El identificador handle de la llamada a la API de Steam que se completó.
m_iCallback	int	Esta es la constante k_iCallback que identifica de forma única a la función callback que se ha completado.
m_cubParam	uint32	El tamaño en bytes de la función callback que se ha completado.

AppResumingFromSuspend_t

Se envía cuando el dispositivo sale del modo de suspensión.

Esta función callback no tiene campos.

SteamShutdown_t

Se llama cuando Steam quiere cerrarse.

Esta función callback no tiene campos.

Enums

Estas son las enumeraciones establecidas para usarse con ISteamUtils.

ECheckFileSignature

El resultado de una llamada a CheckFileSignature.

Nombre	Valor	Descripción
k_ECheckFileSignatureInvalidSignature	0
k_ECheckFileSignatureValidSignature	1
k_ECheckFileSignatureFileNotFound	2
k_ECheckFileSignatureNoSignaturesFoundForThisApp	3
k_ECheckFileSignatureNoSignaturesFoundForThisFile	4

EGamepadTextInputLineMode

Controla el número de líneas permitidas para la entrada de texto mediante gamepad en modo Big Picture.

Nombre	Valor	Descripción
k_EGamepadTextInputLineModeSingleLine	0
k_EGamepadTextInputLineModeMultipleLines	1

EGamepadTextInputMode

Modos de entrada de texto mediante gamepad en modo Big Picture.

Nombre	Valor	Descripción
k_EGamepadTextInputModeNormal	0
k_EGamepadTextInputModePassword	1

EFloatingGamepadTextInputMode

Controla el modo del teclado flotante.

Nombre	Valor	Descripción
k_EFloatingGamepadTextInputModeModeSingleLine	0	Al pulsar Intro, se descarta el teclado.
k_EFloatingGamepadTextInputModeModeMultipleLines	1	El usuario necesita descartar el teclado de forma explícita.
k_EFloatingGamepadTextInputModeModeEmail	2	El teclado se muestra en un modo especial para introducir emails más fácilmente.
k_EFloatingGamepadTextInputModeModeNumeric	3	Muestra el teclado numérico.

ESteamAPICallFailure

Los resultados de la llamada fallida a Steam API devueltos por GetAPICallFailureReason.

Nombre	Valor	Descripción
k_ESteamAPICallFailureNone	-1	No hay errores.
k_ESteamAPICallFailureSteamGone	0	El proceso de Steam local ha dejado de responder: podría haberse cerrado forzosamente o estar inmovilizado.
k_ESteamAPICallFailureNetworkFailure	1	La conexión de red a los servidores de Steam se ha perdido, o ya estaba rota. Una función callback SteamServersDisconnected_t se enviará casi al mismo tiempo, y una función callback SteamServersConnected_t se enviará cuando el cliente pueda hablar con los servidores Steam de nuevo.
k_ESteamAPICallFailureInvalidHandle	2	El identificador SteamAPICall_t pasado ya no existe.
k_ESteamAPICallFailureMismatchedCallback	3	GetAPICallResult con el tipo de función callback incorrecto para esta llamada de API.

Constantes

Estas son constantes definidas para usarse con ISteamUtils.

Nombre	Tipo	Valor	Descripción
STEAMUTILS_INTERFACE_VERSION	const char *	"SteamUtils009"