Version: 2020.3
LanguageEnglish
  • C#

ImageConversion.EncodeToJPG

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

Declaration

public static byte[] EncodeToJPG(Texture2D tex, int quality);

Declaration

public static byte[] EncodeToJPG(Texture2D tex);

Parameters

tex Text texture to convert.
quality JPG quality to encode with. The range is 1 through 100. 1 is the lowest quality. The default is 75.

Description

Encodes this texture into JPG format.

This function returns a byte array which is the JPG file data. You can store the encoded data as a file or send it over the network without further processing.

This function works only on uncompressed, non-HDR texture formats. You must enable the texture's Read/Write Enabled flag in the Texture Import Settings. The encoded JPG data will have no alpha channel, and for single-channel red textures ( R8, R16, RFloat and RHalf ) the encoded JPG data will be in 8-bit grayscale.

// Saves screenshot as JPG file.
using UnityEngine;
using System.Collections;
using System.IO;

public class JPGScreenSaver : MonoBehaviour { // Take a shot immediately IEnumerator Start() { yield return SaveScreenJPG(); }

IEnumerator SaveScreenJPG() { // Read the screen buffer after rendering is complete yield return new WaitForEndOfFrame();

// Create a texture in RGB24 format the size of the screen int width = Screen.width; int height = Screen.height; Texture2D tex = new Texture2D(width, height, TextureFormat.RGB24, false);

// Read the screen contents into the texture tex.ReadPixels(new Rect(0, 0, width, height), 0, 0); tex.Apply();

// Encode the texture in JPG format byte[] bytes = ImageConversion.EncodeToJPG(tex); Object.Destroy(tex);

// Write the returned byte array to a file in the project folder File.WriteAllBytes(Application.dataPath + "/../SavedScreen.jpg", bytes); } }