Version: 2021.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 X coordinate of the pixel to get.
y Y coordinate of the pixel to get.

Returns

Color Pixel color at the requested coordinate.

Description

Returns pixel color at coordinates (x, y).

If the pixel coordinates are out of bounds (larger than the width or height of the Texture or smaller than 0) Unity clamps or repeats the pixel coordinates. This result depends on the wrap mode of the Texture.

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

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