Interface qui donne accès à une série de fonctions utilitaires diverses.
Fonctions membres
Les fonctions membres d'
ISteamUtils sont appelées par le biais de la fonction d'accesseur global
SteamUtils().
BOverlayNeedsPresent
bool BOverlayNeedsPresent();
Vérifie si l'overlay a besoin de Present. Uniquement nécessaire en cas d'utilisation de mises à jour de rendu en réponse à certains évènements.
En général, cet appel est inutile si votre jeu dispose d'une boucle d'images qui s'exécute en permanence pour appeler l'API Present de D3D ou l'API SwapBuffers d'OGL à chaque image, comme c'est le cas dans la plupart des jeux. Toutefois, si votre jeu ne rafraichit l'écran qu'en fonction de certains évènements, cela peut perturber l'overlay, car celui-ci utilise vos appels Present/SwapBuffers pour gérer sa boucle d'images interne. Il peut aussi avoir besoin d'appeler Present() à l'écran à chaque fois qu'une notification survient ou lorsque l'overlay est invoqué par la personne en jeu. Dans ce cas, vous pouvez utiliser cette API pour demander à l'overlay s'il a besoin de Present. Vous pouvez ensuite effectuer une vérification périodique (une fréquence d'environ 33 Hz est conseillée) et appeler Present ou SwapBuffers pour permettre à l'overlay de faire son travail.
Éléments renvoyés : bool
true si l'overlay a besoin que vous rafraichissiez l'écran. Autrement, renvoie
false.
CheckFileSignature
SteamAPICall_t CheckFileSignature( const char *szFileName );
| Nom | Type | Description |
|---|
| szFileName | const char * | . |
Obsolète.
Éléments renvoyés : SteamAPICall_t, à utiliser avec un résultat d'appel
CheckFileSignature_t.
GetAPICallFailureReason
ESteamAPICallFailure GetAPICallFailureReason( SteamAPICall_t hSteamAPICall );
| Nom | Type | Description |
|---|
| hSteamAPICall | SteamAPICall_t | Handle d'appel de l'API Steam pour lequel il faut vérifier l'échec. |
Sert à obtenir la cause de l'échec d'un résultat d'appel.
Cette fonction sert principalement au débogage. Les causes d'un échec sont généralement hors de votre contrôle et ont tendance à ne pas être très importantes. Essayez simplement de recommencer votre appel d'API jusqu'à ce que cela fonctionne.
Éléments renvoyés : ESteamAPICallFailure[type]ESteamAPICallFailure[/type]
Consultez également IsAPICallCompleted et
GetAPICallResult.
Exemplevoid CHTMLSurface::OnBrowserReady( HTML_BrowserReady_t *pBrowserReady, bool bIOFailure )
{
if ( bIOFailure ) {
SteamUtils()->GetAPICallFailureReason( handle ); // Le handle doit être stocké séparément.
return;
}
}
GetAPICallResult
bool GetAPICallResult( SteamAPICall_t hSteamAPICall, void *pCallback, int cubCallback, int iCallbackExpected, bool *pbFailed );
| Nom | Type | Description |
|---|
| hSteamAPICall | SteamAPICall_t | Handle d'appel de l'API. |
| pCallback | void * | Renvoie le rappel dans la mémoire préallouée fournie. |
| cubCallback | int | Taille de pCallback que vous passez. |
| iCallbackExpected | int | Numéro de k_iCallback associé au rappel. |
| pbFailed | bool * | Renvoyé si l'appel de l'API a échoué. |
Obtient le contenu d'un appel d'API terminé. Fournit pour l'interface de l'encapsuleur CallResult.
Il n'est généralement pas recommandé d'utiliser cette fonction manuellement.
Éléments renvoyés : bool
true en cas de réussite si l'appel d'API est valide et est terminé. Autrement, renvoie
false.
Si l'appel est réussi, le rappel est copié dans
pCallback, et les échecs sont renvoyés dans
pbFailed.
Consultez également IsAPICallCompleted et
GetAPICallFailureReason.
GetAppID
uint32 GetAppID();
Obtient l'AppID du processus actuel.
Éléments renvoyés : uint32.
Renvoie l'AppID.
GetConnectedUniverse
EUniverse GetConnectedUniverse();
Obtient l'univers auquel le client actuel se connecte (utilisation réservée à Valve).
Éléments renvoyés : EUniverse[type]EUniverse[/type]
GetCSERIPPort
bool GetCSERIPPort( uint32 *unIP, uint16 *usPort );
| Nom | Type | Description |
|---|
| unIP | uint32 * | Renvoie l'adresse IP à laquelle est connecté le client. |
| usPort | uint16 * | Renvoie le port auquel est connecté le client. |
Obtient l'adresse IP du serveur de rapports pour Valve : actuellement utilisé uniquement dans les jeux utilisant le moteur Source.
Éléments renvoyés : bool
Renvoie
true si le client est connecté actuellement. Autrement, renvoie
false.
GetCurrentBatteryPower
uint8 GetCurrentBatteryPower();
Obtient le pourcentage de batterie actuel de l'ordinateur.
Éléments renvoyés : uint8Le pourcentage de batterie actuel, entre 0 et 100 %. Renvoie 255 lorsque l'ordinateur est branché sur secteur.
GetEnteredGamepadTextInput
bool GetEnteredGamepadTextInput( char *pchText, uint32 cchText );
| Nom | Type | Description |
|---|
| pchText | char * | Tampon préalloué dans lequel sera copiée la chaine de saisie de texte. |
| cchText | uint32 | Taille du tampon pchText. |
Obtient la saisie de texte de la manette depuis l'overlay Big Picture.
Cette fonction doit être appelée dans le rappel
GamepadTextInputDismissed_t, et ce uniquement si
GamepadTextInputDismissed_t.m_bSubmitted vaut true.
Fournit la saisie de texte avec l'encodage UTF-8.
Éléments renvoyés : bool
true si du texte a été reçu et si
cchText a la même taille que GamepadTextInputDismissed_t.m_unSubmittedText. Autrement, renvoie
false.
Consultez également ShowGamepadTextInput et
GetEnteredGamepadTextLength.
Exemplevoid OnGamepadTextInputDismissed_t( GamepadTextInputDismissed_t* pCallback )
{
// Prise en charge de l'annulation par la personne en jeu.
if ( !pCallback.m_bSubmitted )
return;
// Utilisation d'une longueur de texte maximum, passée dans ShowGamepadTextInput (+1 pour la marque de fin null).
const uint32 MAX_INPUT_LENGTH = 64 + 1;
uint32 length = SteamUtils()->GetEnteredGamepadTextLength();
char* szTextInput[MAX_INPUT_LENGTH];
bool success = SteamUtils()->GetEnteredGamepadTextInput( szTextInput, length );
if ( !success )
{
// Consignez une erreur. Cela ne devrait se produire que si la longueur est supérieure à MaxInputLength.
return;
}
// Affichez la chaine mise à jour.
}
GetEnteredGamepadTextLength
uint32 GetEnteredGamepadTextLength();
Obtient la longueur de la saisie de texte de la manette depuis l'overlay Big Picture.
Cette fonction doit être appelée dans le rappel
GamepadTextInputDismissed_t, et ce uniquement si
GamepadTextInputDismissed_t.m_bSubmitted vaut true.
Éléments renvoyés : uint32.
Consultez également ShowGamepadTextInput et
GetEnteredGamepadTextInput.
Exemplevoid OnGamepadTextInputDismissed_t( GamepadTextInputDismissed_t* pCallback )
{
// Prise en charge de l'annulation par la personne en jeu.
if ( !pCallback.m_bSubmitted )
return;
// Utilisation d'une longueur de texte maximum, passée dans ShowGamepadTextInput (+1 pour la marque de fin null).
const uint32 MAX_INPUT_LENGTH = 64 + 1;
uint32 length = SteamUtils()->GetEnteredGamepadTextLength();
const char* szTextInput[MAX_INPUT_LENGTH];
bool success = SteamUtils()->GetEnteredGamepadTextInput( szTextInput, length );
if ( !success )
{
// Consignez une erreur. Cela ne devrait se produire que si la longueur est supérieure à MaxInputLength.
return;
}
// Affichez la chaine mise à jour.
}
GetImageRGBA
bool GetImageRGBA( int iImage, uint8 *pubDest, int nDestBufferSize );
| Nom | Type | Description |
|---|
| iImage | int | Handle de l'image qui sera obtenue. |
| pubDest | uint8 * | Tampon qui sera rempli. |
| nDestBufferSize | int | Taille totale du tampon pubDest. |
Obtient les octets d'une image à partir d'un handle d'image.
Avant d'appeler cette fonction, vous devez obtenir la taille de l'image en appelant
GetImageSize afin de créer un tampon de la bonne taille. Vous pouvez ensuite allouer votre tampon avec la largeur et la hauteur comme suit : largeur × hauteur × 4. L'image est fournie au format RGBA. Cet appel peut s'avérer gourmand, car il effectue une conversion depuis le type compressé (JPG, PNG, TGA) et ne fournit pas de mise en cache interne du tampon renvoyé. Ainsi, il est vivement recommandé de n'appeler ceci qu'une fois par handle d'image et de mettre en cache le résultat. Cette fonction est utilisée uniquement pour les avatars Steam et les images de succès, car ceux-ci ne sont pas censés changer en cours de jeu.
Éléments renvoyés : bool
true en cas de réussite si le handle d'image est valide et que le tampon a été rempli. Autrement, renvoie
false.
Consultez également ISteamFriends::GetSmallFriendAvatar,
ISteamFriends::GetMediumFriendAvatar,
ISteamFriends::GetLargeFriendAvatar et
ISteamUserStats::GetAchievementIcon.
ExempleHGAMETEXTURE GetSteamImageAsTexture( int iImage )
{
HGAMETEXTURE hTexture = 0;
// Vérifiez d'abord que l'image a été mise en cache, par exemple dans un dictionnaire ou une map
// avec « iImage » comme clé, puis renvoyez le handle de texture associé s'il existe.
// Autrement, poursuivez puis ajoutez la texture à la map avant de la renvoyer à la fin de la fonction.
// S'il faut vérifier la taille de l'image…
uint32 uAvatarWidth, uAvatarHeight;
bool success = SteamUtils()->GetImageSize( iImage, &uAvatarWidth, &uAvatarHeight );
if ( !success ) {
// Vous pouvez définir un message d'avertissement ici.
return hTexture;
}
// On récupère les données RGBA brutes de Steam et on les transforme en texture dans le moteur de jeu.
const int uImageSizeInBytes = uAvatarWidth * uAvatarHeight * 4;
uint8 *pAvatarRGBA = new uint8[uImageSizeInBytes];
success = SteamUtils()->GetImageRGBA( iImage, pAvatarRGBA, uImageSizeInBytes );
if( !success )
{
// Ici, convertissez la texture RGBA dans votre format de texture interne afin de l'afficher.
// hTexture = m_pGameEngine->HCreateTexture( pAvatarRGBA, uAvatarWidth, uAvatarHeight );
// Mettez ensuite en cache la texture.
}
// N'oubliez pas de libérer la mémoire !
delete[] pAvatarRGBA;
return hTexture;
}
GetImageSize
bool GetImageSize( int iImage, uint32 *pnWidth, uint32 *pnHeight );
| Nom | Type | Description |
|---|
| iImage | int | Handle d'image pour lequel il faut obtenir la taille. |
| pnWidth | uint32 * | Renvoie la largeur de l'image. |
| pnHeight | uint32 * | Renvoie la hauteur de l'image. |
Obtient la taille d'un handle d'image Steam.
Cet appel doit être effectué avant d'appeler
GetImageRGBA pour créer un tampon de taille appropriée qui sera rempli avec les données d'image brutes.
Éléments renvoyés : bool
true en cas de réussite si le handle d'image est valide et que les tailles ont été déterminées. Autrement, renvoie
false.
Consultez également ISteamFriends::GetSmallFriendAvatar,
ISteamFriends::GetMediumFriendAvatar,
ISteamFriends::GetLargeFriendAvatar et
ISteamUserStats::GetAchievementIcon.
GetIPCCallCount
uint32 GetIPCCallCount();
Renvoie le nombre d'appels IPC effectués depuis la dernière fois que cette fonction a été appelée.
Sert au débogage des performances pour que vous puissiez déterminer combien d'appels IPC (Inter-Process Communication) sont effectués par votre jeu à chaque image.
Chaque appel IPC est au minimum un commutateur de contexte de thread quand il n'est pas un commutateur de processus. Alors, essayez de contrôler le rythme auquel vous les effectuez.
Éléments renvoyés : uint32.
GetIPCountry
const char * GetIPCountry();
Renvoie le code pays au format 2 chiffres ISO 3166-1-alpha-2, qui indique l'endroit où le client est exécuté.
Par exemple : « FR » ou « BE ».
La recherche s'effectue via une base de données qui associe IP et emplacement.
Éléments renvoyés : const char *
GetSecondsSinceAppActive
uint32 GetSecondsSinceAppActive();
Renvoie le nombre de secondes écoulées depuis que l'application est active.
Éléments renvoyés : uint32.
GetSecondsSinceComputerActive
uint32 GetSecondsSinceComputerActive();
Renvoie le nombre de secondes écoulées depuis que la souris a été bougée pour la dernière fois.
Éléments renvoyés : uint32.
GetServerRealTime
uint32 GetServerRealTime();
Renvoie l'heure du serveur Steam au format horaire Unix (nombre de secondes écoulées depuis le 1ᵉʳ janvier 1970).
Éléments renvoyés : uint32.
GetSteamUILanguage
const char * GetSteamUILanguage();
Renvoie la langue utilisée par le client Steam.
Vous auriez plutôt intérêt à utiliser
ISteamApps::GetCurrentGameLanguage, car cette fonction ne doit être utilisée que dans des cas très spécifiques.
Pour obtenir la liste complète des langues prises en charge, consultez
cet article.
Éléments renvoyés : const char *
Consultez également ISteamApps::GetCurrentGameLanguage et
ISteamApps::GetAvailableGameLanguages.
IsAPICallCompleted
bool IsAPICallCompleted( SteamAPICall_t hSteamAPICall, bool *pbFailed );
| Nom | Type | Description |
|---|
| hSteamAPICall | SteamAPICall_t | Handle d'appel d'API à vérifier. |
| pbFailed | bool * | Renvoie si l'appel d'API a échoué (true) ou non (false). |
Vérifie si un appel d'API est terminé. Fournit l'interface de l'encapsuleur CallResult.
Il n'est généralement pas recommandé d'utiliser cette fonction.
Éléments renvoyés : bool
true si l'appel d'API est valide et est terminé. Autrement, renvoie
false.
Consultez également GetAPICallResult et
GetAPICallFailureReason.
IsOverlayEnabled
bool IsOverlayEnabled();
Vérifie si l'
overlay Steam est en cours d'exécution et si la personne en jeu peut y accéder.
Le processus de l'overlay peut prendre quelques secondes pour démarrer et s'accrocher au processus du jeu ; cette fonction renverra donc d'abord « false » pendant le chargement de l'overlay.
Éléments renvoyés : bool.
IsSteamChinaLauncher
bool IsSteamChinaLauncher();
Renvoie si le lanceur actuel est celui de Steam China. Vous pouvez simuler le lanceur Steam China en ajoutant les commandes « -dev -steamchina » à la ligne de commande quand vous exécutez Steam.
InitFilterText
bool InitFilterText();
Initialise le filtrage de texte et charge les dictionnaires de la langue dans laquelle le jeu est exécuté.
Les personnes utilisant Steam peuvent personnaliser leurs préférences de filtres depuis les
paramètres de leur compte.
Éléments renvoyés : bool
true si l'initialisation réussit ;
false si le filtrage n'est pas disponible pour la langue dans lequel le jeu est exécuté, auquel cas
FilterText() n'agira pas et retournera la saisie telle quelle.
Consultez également FilterText.
FilterText
int FilterText( ETextFilteringContext eContext, CSteamID sourceSteamID, const char *pchInputMessage, char *pchOutFilteredText, uint32 nByteSizeOutFilteredText );
| Nom | Type | Description |
|---|
| eContext | ETextFilteringContext | Type de contenu dans la chaine d'entrée. |
| sourceSteamID | CSteamID | SteamID ayant émis la chaine d'entrée (par exemple, une personne avec un nom à filtrer ou qui a envoyé un message dans le chat). |
| pchInputText | const char* | Chaine d'entrée à filtrer, encodée en ASCII ou en UTF-8. |
| pchOutFilteredText | char* | Là où sera stocké le résultat, même si aucun filtrage n'a lieu. |
| nByteSizeOutFilteredText | uint32 | Taille en octets de pchOutFilteredText. Taille minimum : strlen(pchInputText) + 1. |
Filtre le message d'entrée fourni et stocke le résultat filtré dans pchOutFilteredText. Les filtres requis par la loi sont toujours appliqués. D'autres filtres peuvent être appliqués en fonction du contexte et des paramètres du compte.
Éléments renvoyés : int
Renvoie le nombre de caractères (et non pas d'octets) filtrés.
Consultez également InitFilterText.
IsSteamInBigPictureMode
bool IsSteamInBigPictureMode();
Vérifie si Steam et l'overlay Steam sont en cours d'exécution en mode Big Picture.
Pour que l'overlay Big Picture soit activé, les jeux doivent être lancés depuis le client Steam.
Si votre jeu est en cours de développement, vous pouvez l'ajouter sous forme de jeu non Steam à votre bibliothèque pour tester cette fonctionnalité.
Éléments renvoyés : bool
true si l'overlay Big Picture est disponible. Autrement, renvoie
false.
Renverra toujours
false si le
type d'application n'est pas égal à « game ».
IsSteamRunningInVR
bool IsSteamRunningInVR();
Vérifie si Steam est en cours d'exécution en mode VR.
Éléments renvoyés : bool
true si Steam est en cours d'exécution en mode VR. Autrement, renvoie
false.
IsVRHeadsetStreamingEnabled
bool IsVRHeadsetStreamingEnabled();
Vérifie si la vue du casque VR est en train d'être diffusée depuis Steam Remote Play.
Éléments renvoyés : bool
true si la VR est activée et que la vue du casque VR est en train d'être streamée. Autrement, renvoie
false.
Consultez également SetVRHeadsetStreamingEnabled.
IsSteamRunningOnSteamDeck
bool IsSteamRunningOnSteamDeck();
Vérifie si Steam est en cours d'exécution sur Steam Deck.
Éléments renvoyés : bool
true si Steam est en cours d'exécution sur Steam Deck. Autrement, renvoie
false.
SetOverlayNotificationInset
void SetOverlayNotificationInset( int nHorizontalInset, int nVerticalInset );
| Nom | Type | Description |
|---|
| nHorizontalInset | int | La distance horizontale (gauche-droite) en pixels depuis le coin. |
| nVerticalInset | int | La distance verticale (haut-bas) en pixels depuis le coin. |
Définit l'incrustation de la notification de l'overlay depuis le coin spécifié avec
SetOverlayNotificationPosition.
Une valeur de (0, 0) réinitialise la position de la notification dans le coin.
Cette position dépend du jeu et est réinitialisée à chaque lancement.
SetOverlayNotificationPosition
void SetOverlayNotificationPosition( ENotificationPosition eNotificationPosition );
Définit dans quel coin la fenêtre de notification de l'overlay Steam va s'afficher.
Vous pouvez aussi définir la distance par rapport au coin spécifié en utilisant
SetOverlayNotificationInset.
Cette position dépend du jeu et est réinitialisée à chaque lancement.
SetVRHeadsetStreamingEnabled
void SetVRHeadsetStreamingEnabled( bool bEnabled );
| Nom | Type | Description |
|---|
| bEnabled | bool | Active (true) ou désactive (false) le streaming de la vue du casque VR. |
Définit si la vue du casque VR sera streamée depuis Steam Remote Play.
Si cette option est activée, la scène dans le casque VR sera streamée et aucune entrée à distance ne sera autorisée. Si cette option est désactivée, c'est la fenêtre de l'application qui sera streamée, et les entrées à distance seront autorisées. L'option est activée par défaut dans les jeux VR, sauf si le streaming asymétrique est désactivé dans les paramètres VR sur Steamworks.
Cela est utile pour les jeux qui disposent d'un mode de jeu multijoueur asymétrique.
Consultez également IsVRHeadsetStreamingEnabled.
SetWarningMessageHook
void SetWarningMessageHook( SteamAPIWarningMessageHook_t pFunction );
| Nom | Type | Description |
|---|
| pFunction | SteamAPIWarningMessageHook_t | Pointeur de fonction vers la fonction de rappel. |
Définit un hook de message d'avertissement destiné à recevoir des messages d'avertissement et d'information de l'API Steam dans une fonction de rappel.
Le prototype de fonction doit correspondre à la définition dans SteamAPIWarningMessageHook_t. Cela inclut la liaison « extern C » et la convention d'appel __cdecl.
« int nSeverity » correspond à la gravité du message (0 pour un message d'information, 1 pour un message d'avertissement). En cas d'exécution depuis un débogueur, seuls les messages d'avertissement seront envoyés. Si vous ajoutez « -debug_steamapi » à la ligne de commande, les messages d'information seront aussi envoyés.
« const char * pchDebugText » est le texte du message.
Les rappels surviendront directement après l'appel de la fonction de l'API ayant généré le message d'avertissement ou d'information.
Passer NULL supprimera le hook.
Exempleextern "C" void __cdecl SteamAPIDebugTextHook( int nSeverity, const char *pchDebugText )
{
::OutputDebugString( pchDebugText );
if ( nSeverity >= 1 )
{
// Vous pouvez définir un point d'arrêt ici pour intercepter les erreurs de l'API.
int x = 3;
x = x;
}
}
void EnableWarningMessageHook()
{
SteamUtils()->SetWarningMessageHook( &SteamAPIDebugTextHook );
}
ShowGamepadTextInput
bool ShowGamepadTextInput( EGamepadTextInputMode eInputMode, EGamepadTextInputLineMode eLineInputMode, const char *pchDescription, uint32 unCharMax, const char *pchExistingText );
| Nom | Type | Description |
|---|
| eInputMode | EGamepadTextInputMode | Sélectionne le mode d'entrée à utiliser : « Normal » ou « Password » (texte masqué). |
| eLineInputMode | EGamepadTextInputLineMode | Ordonne l'utilisation ou non d'entrée à ligne simple ou multiple. |
| pchDescription | const char * | Définit la description utilisée pour indiquer à quoi sert la boite de dialogue à l'utilisateur ou l'utilisatrice. |
| unCharMax | uint32 | Nombre maximum de caractères que l'utilisateur ou l'utilisatrice peut saisir. |
| pchExistingText | const char * | Définit le texte prérempli que l'utilisateur ou l'utilisatrice peut modifier. |
Active la boite de dialogue de saisie de texte en mode Big Picture. Celle-ci ne prend en charge que la saisie par manette.
Éléments renvoyés : bool
true si l'overlay Big Picture est en cours d'exécution. Autrement, renvoie
false.
Consultez également GetEnteredGamepadTextLength et
GetEnteredGamepadTextInput.
ShowFloatingGamepadTextInput
bool ShowFloatingGamepadTextInput( EFloatingGamepadTextInputMode eKeyboardMode, int nTextFieldXPosition, int nTextFieldYPosition, int nTextFieldWidth, int nTextFieldHeight );
| Nom | Type | Description |
|---|
| eKeyboardMode | EFloatingGamepadTextInputMode | Définit le type de clavier à utiliser. |
| nTextFieldXPosition | int | Coordonnée X du champ de texte qui ne doit pas être masqué par le clavier flottant. |
| nTextFieldYPosition | int | Coordonnée Y du champ de texte qui ne doit pas être masqué par le clavier flottant. |
| nTextFieldWidth | int | Largeur du champ de texte qui ne doit pas être masqué par le clavier flottant. |
| nTextFieldHeight | int | Hauteur du champ de texte qui ne doit pas être masqué par le clavier flottant. |
Ouvre un clavier flottant par-dessus le jeu et envoie au jeu les entrées du clavier du système d'exploitation.
La position du clavier flottant est indiquée en pixels, relativement à l'origine de la fenêtre du jeu. Cela permet de positionner le clavier flottant de manière à ce qu'il ne cache pas le champ de texte.
Éléments renvoyés : bool
true si le clavier flottant est ouvert. Autrement, renvoie
false.
Consultez également FloatingGamepadTextInputDismissed_t.
StartVRDashboard
void StartVRDashboard();
Demande à Steam de créer et d'effectuer le rendu du tableau de bord OpenVR.
SetGameLauncherMode
void SetGameLauncherMode( bool bLauncherMode);
| Nom | Type | Description |
|---|
| bLauncherMode | bool | Indique si le lanceur est actif ou non. |
Si votre lanceur en jeu ne prend pas en charge les contrôleurs, appelez cette fonction pour que Steam Input convertisse les entrées du contrôleur en entrées souris et clavier afin de permettre la navigation dans le lanceur.
Rappels
Voici les rappels qui peuvent être activés en appelant
SteamAPI_RunCallbacks. La plupart seront activés directement en réponse aux fonctions membres d'
ISteamUtils.
CheckFileSignature_t
Réponse d'appel à
CheckFileSignature.
Fonctions associées : CheckFileSignatureGamepadTextInputDismissed_t
Appelé lorsque la saisie de texte à la manette du mode Big Picture a été fermée.
| Nom | Type | Description |
|---|
| m_bSubmitted | bool | true si la personne a saisi du texte et a validé (appelez GetEnteredGamepadTextInput pour recevoir le texte). Autrement, renvoie false si la personne a annulé. |
| m_unSubmittedText | uint32 | Contient la longueur en octets du texte. |
FloatingGamepadTextInputDismissed_t
Appelé lorsque le clavier flottant appelé par
ShowFloatingGamepadTextInput a été fermé.
IPCountry_t
Appelé lorsque le pays de la personne a changé. Le pays doit être mis à jour avec
GetIPCountry.
Ce rappel n'a pas de champ.
LowBatteryPower_t
Appelé lorsque le jeu est exécuté sur un ordinateur portable et qu'il reste moins de 10 minutes de batterie. Se déclenche ensuite toutes les minutes.
| Nom | Type | Description |
|---|
| m_nMinutesBatteryLeft | uint8 | Quantité de batterie restante estimée, en minutes. |
SteamAPICallCompleted_t
Appelé lorsqu'un appel SteamAPICall_t s'est terminé ou a échoué.
| Nom | Type | Description |
|---|
| m_hAsyncCall | SteamAPICall_t | Handle d'appel de l'API Steam qui s'est terminé. |
| m_iCallback | int | Il s'agit de la constante k_iCallback, qui identifie de façon unique le rappel terminé. |
| m_cubParam | uint32 | Taille en octets du rappel terminé. |
AppResumingFromSuspend_t
Envoyé lorsque l'appareil sort du mode veille ou après une interruption de session.
Ce rappel n'a pas de champ.
SteamShutdown_t
Appelé lorsque Steam veut se fermer.
Ce rappel n'a pas de champ.
Énumérations
Voici les énumérations destinées à être utilisées avec ISteamUtils.
ECheckFileSignature
Résultat d'un appel de
CheckFileSignature.
| Nom | Valeur | Description |
|---|
| k_ECheckFileSignatureInvalidSignature | 0 | |
| k_ECheckFileSignatureValidSignature | 1 | |
| k_ECheckFileSignatureFileNotFound | 2 | |
| k_ECheckFileSignatureNoSignaturesFoundForThisApp | 3 | |
| k_ECheckFileSignatureNoSignaturesFoundForThisFile | 4 | |
EGamepadTextInputLineMode
Contrôle le nombre de lignes autorisées pour la saisie de texte à la manette en mode Big Picture.
| Nom | Valeur | Description |
|---|
| k_EGamepadTextInputLineModeSingleLine | 0 | |
| k_EGamepadTextInputLineModeMultipleLines | 1 | |
EGamepadTextInputMode
Modes d'entrée pour la saisie de texte à la manette en mode Big Picture.
| Nom | Valeur | Description |
|---|
| k_EGamepadTextInputModeNormal | 0 | |
| k_EGamepadTextInputModePassword | 1 | |
EFloatingGamepadTextInputMode
Contrôle le mode d'entrée du clavier flottant.
| Nom | Valeur | Description |
|---|
| k_EFloatingGamepadTextInputModeModeSingleLine | 0 | Le clavier se ferme quand on appuie sur Entrée. |
| k_EFloatingGamepadTextInputModeModeMultipleLines | 1 | Le clavier doit être fermé manuellement. |
| k_EFloatingGamepadTextInputModeModeEmail | 2 | Le clavier est affiché dans un mode spécial qui facilite la saisie d'adresses e-mail. |
| k_EFloatingGamepadTextInputModeModeNumeric | 3 | Le pavé numérique est affiché. |
ESteamAPICallFailure
Résultats de l'échec de l'appel de l'API Steam renvoyés par
GetAPICallFailureReason.
| Nom | Valeur | Description |
|---|
| k_ESteamAPICallFailureNone | -1 | Pas d'échec. |
| k_ESteamAPICallFailureSteamGone | 0 | Le processus Steam local ne répond plus. Il a peut-être été fermé de force ou il est figé. |
| k_ESteamAPICallFailureNetworkFailure | 1 | La connexion réseau aux serveurs Steam a été perdue ou avait déjà été interrompue.
Un rappel SteamServersDisconnected_t sera envoyé au même moment et un rappel SteamServersConnected_t sera envoyé quand le client pourra à nouveau communiquer avec les serveurs Steam. |
| k_ESteamAPICallFailureInvalidHandle | 2 | Le handle SteamAPICall_t passé n'existe plus. |
| k_ESteamAPICallFailureMismatchedCallback | 3 | GetAPICallResult a été appelé avec le mauvais type de rappel pour cet appel d'API. |
Constantes
Voici les constantes destinées à être utilisées avec ISteamUtils.
| Nom | Type | Valeur | Description |
|---|
| STEAMUTILS_INTERFACE_VERSION | const char * | "SteamUtils009" | |
