LanguageEnglish
  • C#

ScreenCapture.CaptureScreenshot

Leave feedback
Suggest a change

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.

Close

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.

Close

Cancel

public static void CaptureScreenshot(string filename, int superSize);
public static void CaptureScreenshot(string filename, ScreenCapture.StereoScreenCaptureMode stereoCaptureMode);

Parameters

filenamePathname to save the screenshot file to.
superSizeFactor by which to increase resolution.
stereoCaptureModeSpecifies the eye texture to capture when stereo rendering is enabled.

Description

Captures a screenshot at path filename as a PNG file.

If the file exists already, it will be overwritten.

On mobile platforms the filename is appended to the persistent data path. See Application.persistentDataPath for more information.

When superSize parameter is more than 1, a larger resolution screenshot will be produced. For example, passing 4 will make the screenshot be 4x4 larger than normal. This is useful to produce screenshots for printing.

using UnityEngine;

// Generate a screenshot and save to disk with the name SomeLevel.png.

public class ExampleScript : MonoBehaviour
{
    void OnMouseDown()
    {
        ScreenCapture.CaptureScreenshot("SomeLevel");
    }
}

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.

对文档有任何疑问，请移步至开发者社区提问，我们将尽快为您解答