Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Texture2D.GetPixel

Switch to Manual
public function GetPixel(x: int, y: int): Color;

Parameters

Description

Returns pixel color at coordinates (x, y).

If the pixel coordinates are out of bounds (larger than width/height or small than 0), they will be clamped or repeated based on the texture's wrap mode.

Texture coordinates start at lower left corner.

If you are reading a large block of pixels from the texture, it may be faster to use GetPixels32 or GetPixels which returns a whole block of pixel colors.

The texture must have the Read/Write Enabled flag set in the import settings, otherwise this function will fail.

See Also: GetPixels32, GetPixels, SetPixel, GetPixelBilinear.

#pragma strict
// Sets the y coordinate of the transform to follow the heightmap
public var heightmap;
public var size = new Vector3(100, 10, 100);
function Update() {
	var x = Mathf.FloorToInt(transform.position.x / size.x * heightmap.width);
	var z = Mathf.FloorToInt(transform.position.z / size.z * heightmap.height);
	var pos = transform.position;
	pos.y = heightmap.GetPixel(x, z).grayscale * size.y;
	transform.position = pos;
}