filename | Pathname to save the screenshot file to. |
superSize | Factor by which to increase resolution. |
stereoCaptureMode | Specifies the eye texture to capture when stereo rendering is enabled. |
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.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.