Unity - Scripting API: ScreenCapture.CaptureScreenshot
Success!
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
Submission failed
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Declaration
public static void CaptureScreenshot(string filename, int superSize);
Parameters
| Parameter | Description |
|---|---|
| filename | The path to save the screenshot file to. |
| superSize | The factor to increase resolution with. |
| stereoCaptureMode | The eye texture to capture when stereo rendering is enabled. |
Description
Captures a screenshot and saves it as a .png file to a specified path.
If the screenshot exists already, ScreenCapture.CaptureScreenshot overwrites it with a new screenshot.
Add .png to the end of filename to save the screenshot as a .png file.
Mobile platforms (such as Android and iOS): filename is appended to the persistent data path. For more information, refer to Application.persistentDataPath.
Windows Editor, macOS Editor, and other non-mobile platforms: filename is interpreted relative to the project directory (the folder containing the Assets folder), not relative to Application.persistentDataPath. Therefore, a relative path such as SomeLevel.png is saved in the project folder, not in %userprofile%\AppData\LocalLow\... on Windows.
To save screenshots to the persistent data path (for example, %userprofile%\AppData\LocalLow\<companyname>\<productname> on Windows Editor), pass a full path: System.IO.Path.Combine(Application.persistentDataPath, "screenshot.png").
When the superSize parameter is more than 1, a larger resolution screenshot is
produced. For example, if you pass 4, you create a screenshot 4x4 larger than normal. This is useful to produce screenshots you want to print.
The CaptureScreenshot returns immediately on Android. The screen capture continues in the background. The resulting screen shot is saved in the file system after a few seconds.