XAppCaptureTakeDiagnosticScreenshot

从您的应用程序截取诊断屏幕截图。

语法

HRESULT XAppCaptureTakeDiagnosticScreenshot(  
         bool gamescreenOnly,  
         XAppCaptureScreenshotFormatFlag captureFlags,  
         const char* filenamePrefix,  
         XAppCaptureDiagnosticScreenshotResult* result  
)  

参数

gamescreenOnly _In_
类型:bool

确定是否将只捕获游戏屏幕。 如果设置为 false,则可能除了游戏屏幕之外,还可以捕获像屏幕键盘这样的 UI。

captureFlags _In_
类型:XAppCaptureScreenshotFormatFlag

确定捕获将是 SDR 还是 HDR 捕获。

filenamePrefix _In_opt_
类型:char*

文件名所需的前缀(可选)将附加到诊断文件名的前面。

result _Out_
类型:XAppCaptureDiagnosticScreenshotResult*

获得的屏幕截图。

返回值

类型:HRESULT

函数结果。

备注

注意

在时间敏感线程上调用此函数是不安全的。 有关详细信息,请参阅时间敏感线程

XAppCaptureTakeScreenshot 不同,调用此函数不会触发 UI 通知。 XAppCaptureTakeDiagnosticScreenshot 使用 XAppCaptureScreenshotFormatFlag 指定屏幕捕获是 SDR、HDR 还是两者。 但是,您仍然必须在 HDR 中运行才能进行 HDR 捕获。 屏幕截图保存到游戏可访问的分区。 XAppCaptureDiagnosticScreenshotResult 包含一个 XAppCaptureScreenshotFile 数组,每个结构包含屏幕截图的文件路径。

此函数将仅适用于开发工具包。 在零售工具包中,此 API 将立即返回错误。

要求

头文件:XAppCapture.h

库:xgameruntime.lib

支持平台:Windows、Xbox One 系列主机和 Xbox Series 主机

另请参阅

GameDVR 概述
XAppCapture 成员
XAppCaptureDiagnosticScreenshotResult
XAppCaptureScreenshotFormatFlag
XAppCaptureDiagnosticScreenshotResult
XAppCaptureScreenshotFile