Documentation Steamworks
Overlay Steam

Présentation

L'overlay Steam est un élément de l'interface utilisateur Steam qui peut être activé par-dessus n'importe quel jeu lancé via Steam. Il permet à l'utilisateur d'accéder à sa liste d'amis, au navigateur Web, au chat, et à l'achat de DLC en jeu.

La commande par défaut pour accéder à l'overlay en jeu est MAJ+TAB, mais l'utilisateur peut la modifier dans la boîte de dialogue Steam -> Paramètres.

Conditions requises

Votre jeu n'a rien à faire de spécial pour que l'overlay fonctionne, ce dernier s'accroche automatiquement à tout jeu lancé depuis Steam ! Pendant le développement et l'exécution de votre jeu dans un débogueur, l'overlay est chargé lorsque vous appelez SteamAPI_Init. À ce titre, vous devrez vous assurer d'appeler SteamAPI_Init avant d'initialiser le périphérique OpenGL/D3D, ou l'overlay ne sera pas capable d'accrocher la création du périphérique.

L'overlay supporte les jeux qui utilisent DirectX 7-12, OpenGL, Metal et Vulkan. L'overlay ne sera pas actif dans les jeux rastérisés par programme.
REMARQUE : l'overlay est automatiquement désactivé pour les applications de type « logiciel ». Si vous souhaitez activer l'overlay, veuillez contacter le Support Steam.

Activer l'overlay depuis votre application

Voici un ensemble de fonctions de l'API Steamworks qui vous permettront d'accéder directement au déclenchement de l'overlay du jeu.

Communication de l'overlay vers votre jeu

Les signaux suivants (rappels) sont envoyés de Steam à votre jeu, en fonction de l'action de l'utilisateur dans l'overlay :
  • GameOverlayActivated_t
    Envoyé quand l'overlay du jeu s'active ou se désactive. Le jeu peut utiliser ce rappel pour mettre en pause ou reprendre le jeu dans les jeux en solo.
  • GameServerChangeRequested_t
    Envoyé quand l'utilisateur choisit un match d'amis à rejoindre. Contient les informations sur le serveur de jeu à rejoindre.
  • GameLobbyJoinRequested_t
    Envoyé quand l'utilisateur choisit un match d'amis à rejoindre. Contient les informations sur la salle d'attente (lobby) à rejoindre.

FAQ

REMARQUE : Vous trouverez peut-être d'autres réponses sur le site d'assistance destiné aux clients. Voyez par exemple cet article : L'overlay de la communauté Steam ne s'active pas.

Q . Pourquoi l'overlay Steam fait-il planter mon application ?

R . L'overlay Steam est utilisé dans des milliers de jeux et a fait l'objet de très nombreux tests, il est donc rarement la cause d'un plantage. Toutefois, en raison de la manière dont il s'injecte dans le jeu, il révèle souvent des fuites ou des corruptions de mémoire dans l'utilisation de votre API de rendu, qui peuvent ne pas avoir affecté l'expérience de jeu.

Pour diagnostiquer les plantages de l'overlay avec DirectX par exemple, essayez de déterminer comment D3D s'est retrouvé en mauvais état en utilisant le runtime de débogage de D3D avec toutes les options d'information (info/alerte/erreur/avertissement) activées. Ceci pourrait vous donner des indices quant aux ressources D3D orphelines. Si vous ne trouvez rien ainsi, il pourrait s'agir d'un problème de corruption de mémoire plus général. Si ces plantages ont toujours lieu au moment de l'arrêt, il s'agit probablement d'un problème d'ordre d'arrêt, le jeu n'effectuant pas de purge quand il s'arrête.

Si après débogage l'app continue à planter dans l'overlay, veuillez nous en faire part dans le groupe de développement Steamworks.

Q . Pourquoi l'overlay Steam n'apparaît-il pas dans mon application ?

R . Assurez-vous d'abord que les Conditions requises ci-dessus sont remplies. Si les conditions sont remplies et que l'overlay n'apparaît toujours pas, assurez-vous de lancer l'application via le client Steam, soit directement depuis la salle d'attente ou la liste de lancement rapide, soit en appelant l'API SteamAPI_RestartAppIfNecessary.