Skip to main content

XDisplayAcquireTimeoutDeferral

Acquiert un report du délai d’expiration de l’écran.

Syntaxe

Paramètres

handle   _Out_
Type : XDisplayTimeoutDeferralHandle*
Pointeur vers le handle du report du délai d’expiration de l’écran.

Valeur de retour

Type : HRESULT Retourne S_OK en cas de réussite; sinon, retourne un code d’erreur. Pour obtenir la liste des codes d’erreur, consultez Codes d’erreur.

Remarques

Il n’est pas sécuritaire d’appeler cette fonction sur un thread sensible au temps. Pour plus d’informations, consultez Threads sensibles au temps.
Un report du délai d’expiration de l’écran garantit que l’écran ne s’assombrira pas, ne se verrouillera pas et ne s’éteindra pas pendant l’inactivité de l’utilisateur. Après un certain temps d’inactivité, le délai d’expiration de l’écran survient. En réponse à l’expiration du délai de l’écran, les appareils peuvent assombrir l’affichage, activer l’écran de verrouillage ou éteindre l’écran. La durée d’inactivité requise avant l’expiration du délai de l’écran dépend des paramètres utilisateur de l’appareil. Si votre jeu effectue une activité qui ne nécessite aucune interaction de l’utilisateur, comme le chargement de ressources de jeu ou l’affichage d’une longue cinématique, les expirations du délai de l’écran peuvent être gênantes. Vous pouvez empêcher ces expirations en acquérant un report du délai d’expiration de l’écran. Pour acquérir un report du délai d’expiration de l’écran, appelez d’abord XDisplayAcquireTimeoutDeferral pour acquérir un handle de report du délai d’expiration de l’écran, puis appelez XDisplayCloseTimeoutDeferralHandle pour fermer le handle lorsqu’il n’est plus nécessaire. Les reports du délai d’expiration de l’écran sont ignorés si le jeu perd le focus, et ils sont libérés si le jeu se ferme.
Si vous utilisez cette fonction pour acquérir un handle de report du délai d’expiration de l’écran, vous devez fermer ce handle en appelant XDisplayCloseTimeoutDeferralHandle. Plusieurs handles de report du délai d’expiration de l’écran peuvent être acquis, et le délai d’expiration de l’écran n’est réactivé pour le jeu qu’une fois tous ces handles fermés.
L’assombrissement de l’écran ne se produit pas pendant qu’un titre est en cours de débogage actif.
L’exemple suivant lit une longue cinématique d’introduction après avoir appelé XDisplayAcquireTimeoutDeferral pour acquérir un nouveau handle de report du délai d’expiration de l’écran. Si le nouveau handle est acquis avec succès, la longue cinématique d’introduction peut être lue sans que le délai de l’écran expire en raison de l’inactivité de l’utilisateur. Une fois la lecture de la cinématique terminée, l’exemple appelle XDisplayCloseTimeoutDeferralHandle pour fermer le handle. Une fois tous les handles de report du délai d’expiration de l’écran fermés, le délai d’expiration de l’écran peut de nouveau survenir en raison de l’inactivité de l’utilisateur.

Configuration requise

En-tête : XDisplay.h Bibliothèque : xgameruntime.lib Plateformes prises en charge : Windows, consoles de la famille XBOX One et consoles XBOX Series

Documentation conceptuelle

Voir aussi

XDisplayCloseTimeoutDeferralHandle
XDisplay
Last modified on October 6, 2026