Version: 2022.3
LanguageEnglish
  • C#

WebCamTexture.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

Declaration

public Color GetPixel(int x, int y);

Parameters

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

Returns

Color The pixel color.

Description

Gets the pixel color at coordinates (x, y).

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.

If you need to get a large block of pixels, it might be faster to use GetPixels.

Note: For depth data based WebCamTexture instances, the depth value (distance in meters) can be accessed using the Color.r property. Additional resources: WebCamTexture.isDepth.

Additional resources: GetPixels32, GetPixels.