Version: 2020.3
LanguageEnglish
  • C#

WebCamTexture.GetPixels

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[] GetPixels();

Returns

Color[] An array that contains the pixel colors.

Description

Gets the pixel color data for a mipmap level as Color structs.

This method gets pixel data from the texture in CPU memory. Texture.isReadable must be true.

The array contains the pixels row by row, starting at the bottom left of the texture. The size of the array is the width × height of the texture.

Each pixel is a Color struct.

A single call to GetPixels is usually faster than multiple calls to GetPixel, especially for large textures. If a lower-precision representation is acceptable, GetPixels32 is faster and uses less memory because it does not perform integer-to-float conversions.

If GetPixels fails, Unity throws an exception. GetPixels might fail if the array contains too much data.

Note: For depth data based WebCamTexture instances, this method returns an array of the depth values via Color.r property. See Also: WebCamTexture.isDepth.


Declaration

public Color[] GetPixels(int x, int y, int blockWidth, int blockHeight);

Parameters

x The starting x position of the section to fetch.
y The starting y position of the section to fetch.
blockWidth The width of the section to fetch.
blockHeight The height of the section to fetch.

Returns

Color[] An array that contains the pixel colors.

Description

Gets the pixel color data for part of the texture as Color structs.

This version of GetPixels returns part of the texture instead of the whole texture.

Note: For depth data based WebCamTexture instances, this method returns an array of the depth values via Color.r property. See Also: WebCamTexture.isDepth.