Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

EncodeToJPG

Encodes this texture into JPG format.
Read time 2 minutesLast updated 11 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.ImageConversionModule

EncodeToJPG(Texture2D, int)

Encodes this texture into JPG format.
public static byte[] EncodeToJPG(this Texture2D tex, int quality)

Parameters

tex

Texture2D
Text texture to convert.

quality

int
JPG quality to encode with. The range is 1 through 100. 1 is the lowest quality. The default is 75.

Returns

Type

Description

byte[]

Remarks

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 does not work on any compressed format. Texture.isReadable must be 
true
. The encoded JPG data will be either 8bit grayscale, RGB or RGBA (depending on the passed in format).
// 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);
 }
}
Additional Resources: ImageConversion.EncodeArrayToJPG, ImageConversion.EncodeNativeArrayToJPG, ImageConversion.EncodeToPNG, ImageConversion.EncodeToTGA, ImageConversion.EncodeToEXR.

EncodeToJPG(Texture2D)

Encodes this texture into JPG format.
public static byte[] EncodeToJPG(this Texture2D tex)

Parameters

tex

Texture2D
Text texture to convert.

Returns

Type

Description

byte[]

Remarks

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 does not work on any compressed format. Texture.isReadable must be 
true
. The encoded JPG data will be either 8bit grayscale, RGB or RGBA (depending on the passed in format).
// 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);
 }
}
Additional Resources: ImageConversion.EncodeArrayToJPG, ImageConversion.EncodeNativeArrayToJPG, ImageConversion.EncodeToPNG, ImageConversion.EncodeToTGA, ImageConversion.EncodeToEXR.