XDisplayAcquireTimeoutDeferral
Acquires a screen timeout deferral.Syntax
Parameters
handle _Out_Type: XDisplayTimeoutDeferralHandle* A pointer to the handle for the screen timeout deferral.
Return value
Type: HRESULT Returns S_OK if successful; otherwise, returns an error code. For a list of error codes, see Error Codes.Remarks
This function isn’t safe to call on a time-sensitive thread. For more information, see Time-sensitive threads.
If you use this function to acquire a screen timeout deferral handle, you must close that handle by calling XDisplayCloseTimeoutDeferralHandle. Multiple screen timeout deferral handles can be acquired, and screen timeout is enabled for the game only after all screen timeout deferral handles are closed.
Screen dimming will not take place while a title is actively getting debugged.
Requirements
Header: XDisplay.h Library: xgameruntime.lib Supported platforms: Windows, XBOX One family consoles and XBOX Series consolesConceptual documentation
See also
XDisplayCloseTimeoutDeferralHandleXDisplay
