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.
CloseFor 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.
Closearray | The byte array to convert. |
format | The pixel format of the image data. |
width | The width of the image data in pixels. |
height | The height of the image data in pixels. |
rowBytes | The length of a single row in bytes. The default is 0, which means Unity calculates the length automatically. |
quality | JPG quality to encode with. The range is 1 through 100. 1 is the lowest quality. The default is 75. |
Encodes this array 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 does not work on any compressed format.
The encoded JPG data will be either 8bit grayscale, RGB or RGBA (depending on the passed in format).
This method is thread safe.
// Saves screenshot as JPG file. using System.Collections; using System.IO; using UnityEngine;
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 bytes in JPG format byte[] bytes = ImageConversion.EncodeArrayToJPG(tex.GetRawTextureData(), tex.graphicsFormat, (uint)width, (uint)height); Object.Destroy(tex);
// Write the returned byte array to a file in the project folder File.WriteAllBytes(Application.dataPath + "/../SavedScreen.jpg", bytes); } }
Additional resources: EncodeToJPG, EncodeNativeArrayToJPG, EncodeArrayToPNG, EncodeArrayToTGA, EncodeArrayToEXR.
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.