CaptureScreenshotAsTexture
Captures a screenshot of the game view into a Texture2D object.
Read time 2 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.ScreenCaptureModule
CaptureScreenshotAsTexture()
Captures a screenshot of the game view into a Texture2D object.
public static Texture2D CaptureScreenshotAsTexture()
Returns
Type | Description |
|---|---|
| Texture2D |
Remarks
When parameter is larger than 1, a larger resolution screenshot will be produced. For example, passing 4 will make the screenshot be 4x4 larger than it normally would. This is useful to produce screenshots for printing.
superSizeImportant: To ensure reliable results, always wait until the frame rendering process is complete before calling this method. To guarantee this, you can call it from a coroutine that yields on WaitForEndOfFrame.
Examples
using UnityEngine;using System.Collections;public class ScreenShotter : MonoBehaviour{ IEnumerator RecordFrame() { yield return new WaitForEndOfFrame(); var texture = ScreenCapture.CaptureScreenshotAsTexture(); // do something with texture // cleanup Object.Destroy(texture); } public void LateUpdate() { StartCoroutine(RecordFrame()); }}
CaptureScreenshotAsTexture(int)
Captures a screenshot of the game view into a Texture2D object.
public static Texture2D CaptureScreenshotAsTexture(int superSize)
Parameters
Factor by which to increase resolution.
Returns
Type | Description |
|---|---|
| Texture2D |
Remarks
When parameter is larger than 1, a larger resolution screenshot will be produced. For example, passing 4 will make the screenshot be 4x4 larger than it normally would. This is useful to produce screenshots for printing.
superSizeImportant: To ensure reliable results, always wait until the frame rendering process is complete before calling this method. To guarantee this, you can call it from a coroutine that yields on WaitForEndOfFrame.
Examples
using UnityEngine;using System.Collections;public class ScreenShotter : MonoBehaviour{ IEnumerator RecordFrame() { yield return new WaitForEndOfFrame(); var texture = ScreenCapture.CaptureScreenshotAsTexture(); // do something with texture // cleanup Object.Destroy(texture); } public void LateUpdate() { StartCoroutine(RecordFrame()); }}
CaptureScreenshotAsTexture(StereoScreenCaptureMode)
Captures a screenshot of the game view into a Texture2D object.
public static Texture2D CaptureScreenshotAsTexture(ScreenCapture.StereoScreenCaptureMode stereoCaptureMode)
Parameters
Specifies the eye texture to capture when stereo rendering is enabled.
Returns
Type | Description |
|---|---|
| Texture2D |
Remarks
When parameter is larger than 1, a larger resolution screenshot will be produced. For example, passing 4 will make the screenshot be 4x4 larger than it normally would. This is useful to produce screenshots for printing.
superSizeImportant: To ensure reliable results, always wait until the frame rendering process is complete before calling this method. To guarantee this, you can call it from a coroutine that yields on WaitForEndOfFrame.
Examples
using UnityEngine;using System.Collections;public class ScreenShotter : MonoBehaviour{ IEnumerator RecordFrame() { yield return new WaitForEndOfFrame(); var texture = ScreenCapture.CaptureScreenshotAsTexture(); // do something with texture // cleanup Object.Destroy(texture); } public void LateUpdate() { StartCoroutine(RecordFrame()); }}