Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetPixel(int, int, int)

Gets the pixel color at coordinates ( x, y ).
Read time 2 minutesLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public Color GetPixel(int x, int y, int mipLevel)

Parameters

x

int
The x coordinate of the pixel to get. The range is 
0
through (texture width - 1).

y

int
The y coordinate of the pixel to get. The range is 
0
through (texture height - 1).

mipLevel

int
The mipmap level to sample. The range is 
0
through the texture's Texture.mipmapCount. The default value is 
0
.

Returns

Type

Description

ColorThe pixel color.

Remarks

This method gets pixel data from the texture in CPU memory. Texture.isReadable must be 
true
.
The lower left corner is (0, 0). If the pixel coordinate is outside the texture's dimensions, Unity clamps or repeats it, depending on the texture's TextureWrapMode.
GetPixel
might be slower than some other texture methods because it converts the format the texture uses into Color. 
GetPixel
also needs to decompress compressed textures, and use memory to store the decompressed area. To get pixel data more quickly, use Texture2D.GetPixelData instead.
If you need to get a large block of pixels, it might be faster to use Texture2D.GetPixels32 or Texture2D.GetPixels.
You can't use 
GetPixel
with textures that use Crunch texture compression.
Additional Resources: Texture2D.GetPixels32, Texture2D.GetPixels, Texture2D.SetPixel, Texture2D.GetPixelBilinear.

Examples

// Sets the y coordinate of the transform to follow a heightmapusing UnityEngine;using System.Collections;public class ExampleClass : MonoBehaviour{    public Texture2D heightmap;    public Vector3 size = new Vector3(100, 10, 100);    void Update()    {        int x = Mathf.FloorToInt(transform.position.x / size.x * heightmap.width);        int z = Mathf.FloorToInt(transform.position.z / size.z * heightmap.height);        Vector3 pos = transform.position;        pos.y = heightmap.GetPixel(x, z).grayscale * size.y;        transform.position = pos;    }}