Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

Cubemap.GetPixel

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public function GetPixel(face: CubemapFace, x: int, y: int): Color;
public Color GetPixel(CubemapFace face, int x, int y);
public def GetPixel(face as CubemapFace, x as int, y as int) as Color

Description

Returns pixel color at coordinates (face, x, y).

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

The texture must have the Is Readable flag set in the import settings, otherwise this function will fail.

	// prints the color of the pixel at (0,0) of the +X face
	var c : Cubemap;
	Debug.Log(c.GetPixel(CubemapFace.PositiveX, 0, 0));
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public Cubemap c;
    void Example() {
        Debug.Log(c.GetPixel(CubemapFace.PositiveX, 0, 0));
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public c as Cubemap

	def Example() as void:
		Debug.Log(c.GetPixel(CubemapFace.PositiveX, 0, 0))