Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


CaptureScreenshotIntoRenderTexture(RenderTexture)

Captures a screenshot of the game view into a RenderTexture object.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.ScreenCaptureModule
public static void CaptureScreenshotIntoRenderTexture(RenderTexture renderTexture)

Parameters

renderTexture

RenderTexture that will get filled with the screen content.

Remarks

This variant of screen capture makes it possible to read pixels asynchronously using AsyncGPUReadback, making the process consume less time on the main thread.
Important: 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;using UnityEngine.Rendering;public class ScreenCaptureIntoRenderTexture : MonoBehaviour{ private RenderTexture renderTexture; IEnumerator Start() { yield return new WaitForEndOfFrame(); renderTexture = new RenderTexture(Screen.width, Screen.height, 0); ScreenCapture.CaptureScreenshotIntoRenderTexture(renderTexture); AsyncGPUReadback.Request(renderTexture, 0, TextureFormat.RGBA32, ReadbackCompleted); } void ReadbackCompleted(AsyncGPUReadbackRequest request) { // Render texture no longer needed, it has been read back. DestroyImmediate(renderTexture); using (var imageBytes = request.GetData<byte>()) { // do something with the pixel data. } }}