Version: 2021.2
LanguageEnglish
  • C#

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

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

Switch to Manual

Declaration

public Color GetPixel(CubemapFace face, int x, int y, int mip = 0);

Parameters

face The Cubemap face to reference.
mip Mip level to sample, must be in the range [0, mipCount[.
x The X-axis pixel coordinate.
y The Y-axis pixel coordinate.

Returns

Color The pixel requested.

Description

Returns pixel color at coordinates (face, mip, 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 method will fail. GetPixel is not available on Textures using Crunch texture compression.

using UnityEngine;

public class Example : MonoBehaviour { public Cubemap texture;

void Start() { // prints the color of the pixel at (0,0) of the +X face Debug.Log(texture.GetPixel(CubemapFace.PositiveX, 0, 0)); } }