Version: 2021.2
LanguageEnglish
  • C#

Texture2D.GetPixels32

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 Color32[] GetPixels32(int miplevel = 0);

Parameters

miplevel The mip level to read pixel data from. The default is 0.

Returns

Color32[] An array that contains a copy of the requested pixel colors.

Description

Retrieves a copy of the pixel color data at a given mip level. The colors are represented by lower-precision Color32 structs.

A single call to this function is usually faster than multiple calls to GetPixel, especially for large textures. This function is faster than GetPixels and uses less memory because it does not perform integer-to-float conversions. For a direct view into the pixel data, use GetPixelData or GetRawTextureData.

For this function to succeed, Texture.isReadable must be true.

The returned array is a flattened 2D array, where the data appears row by row: the pixels are laid out left to right, bottom to top. The dimensions of the array are width * height of the mip level. If this function fails, Unity throws an exception.

using UnityEngine;

public class Texture2DExample : MonoBehaviour { public Texture2D source; public Texture2D destination;

void Start() { // Get a copy of the color data from the source Texture2D, in lower-precision int format. // Each element in the array represents the color data for an individual pixel. int sourceMipLevel = 0; Color32[] pixels = source.GetPixels32(sourceMipLevel);

// If required, manipulate the pixels before applying them to the destination Texture2D. // This example code reverses the array, which rotates the image 180 degrees. System.Array.Reverse(pixels, 0, pixels.Length);

// Set the pixels of the destination Texture2D. int destinationMipLevel = 0; destination.SetPixels32(pixels, destinationMipLevel);

// Apply changes to the destination Texture2D, which uploads its data to the GPU. destination.Apply(); } }