Version: 2018.3 (switch to 2019.1b or 2017.4)
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

public Color32[] GetPixels32(int miplevel);

Description

Get a block of pixel colors in Color32 format.

This function returns an array of pixel colors of the whole mip level of the texture.

The returned array is a flattened 2D array, where pixels are laid out left to right, bottom to top (i.e. row after row). Array size is width by height of the mip level used. The default mip level is zero (the base texture) in which case the size is just the size of the texture. In general case, mip level size is mipWidth=max(1,width>>miplevel) and similarly for height.

The texture must have the read/write enabled flag set in the texture import settings, otherwise this function will fail. GetPixels32 is not available on Textures using Crunch texture compression.

Using GetPixels32 can be faster than calling GetPixel repeatedly, especially for large textures. In addition, GetPixels32 can access individual mipmap levels.

using UnityEngine;

public class Example : MonoBehaviour { // Rotate an image 180 degrees by reversing the order // of the pixels.

// Source texture. Texture2D sourceTex;

void Start() { // Get the pixel block and reverse the array to // rotate the image. var pix = sourceTex.GetPixels32(); System.Array.Reverse(pix);

// Copy the reversed image data to a new texture. var destTex = new Texture2D(sourceTex.width, sourceTex.height); destTex.SetPixels32(pix); destTex.Apply();

// Set the current object's texture to show the // rotated image. GetComponent<Renderer>().material.mainTexture = destTex; } }

Did you find this page useful? Please give it a rating: