Version: 2021.3
LanguageEnglish
  • C#

ImageConversion.EncodeArrayToEXR

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[] EncodeArrayToEXR(Array array, Experimental.Rendering.GraphicsFormat format, uint width, uint height, uint rowBytes, Texture2D.EXRFlags flags);

Parameters

array 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.
flags Flags used to control compression and the output format. The default is Texture2D.EXRFlags.None

Description

Encodes this array into the EXR format.

This function returns a byte array which is the EXR file data. Write this data to disk to get the data in the EXR file format.

It is best to use this function for HDR texture formats (either 16-bit or 32-bit floats). The default output format is 16-bit float EXR.

The encoded EXR data will always contain an alpha channel.

For single-channel red textures ( R8, R16, RFloat and RHalf ), the encoded data will be in grayscale mode.

This method is thread safe.

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

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

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

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

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

// Encode the bytes in EXR format byte[] bytes = ImageConversion.EncodeArrayToEXR(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.exr", bytes); } }