Share via

XAppCaptureTakeScreenshotResult

  • Article

Represents the results of taking a screenshot.

Syntax

typedef struct XAppCaptureTakeScreenshotResult {  
    char localId[APPCAPTURE_MAX_LOCALID_LENGTH];  
    XAppCaptureScreenshotFormatFlag availableScreenshotFormats;  
} XAppCaptureTakeScreenshotResult

Members

localId
Type: char[APPCAPTURE_MAX_LOCALID_LENGTH]

Local ID of the screenshot result.

availableScreenshotFormats
Type: XAppCaptureScreenshotFormatFlag

Image formats available resulting from the taking the screenshot.

Remarks

Information about the resulting screenshot and whether both HDR and SDR formats are available, or only SDR format is available. You will use the localID to access the correct screenshot stream when calling XAppCaptureOpenScreenShotStream. XAppCaptureTakeScreenshotResult is an output parameter for XAppCaptureTakeScreenshot.

Requirements

Header: XAppCapture.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

GameDVR Overview
XAppCapture Members
XAppCaptureOpenScreenShotStream
XAppCaptureTakeScreenshot