Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

GetPixels

Gets the pixel color data for a mipmap level as Color structs.
Read time 2 minutesLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.AudioModule

GetPixels()

Gets the pixel color data for a mipmap level as Color structs.
public Color[] GetPixels()

Returns

Type

Description

Color[]An array that contains the pixel colors.

Remarks

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 WebCamTexture.GetPixel, especially for large textures. If a lower-precision representation is acceptable, WebCamTexture.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. Additional Resources: WebCamTexture.isDepth.

GetPixels(int, int, int, int)

Gets the pixel color data for part of the texture as Color structs.
public Color[] GetPixels(int x, int y, int blockWidth, int blockHeight)

Parameters

x

int
The starting x position of the section to fetch.

y

int
The starting y position of the section to fetch.

blockWidth

int
The width of the section to fetch.

blockHeight

int
The height of the section to fetch.

Returns

Type

Description

Color[]An array that contains the pixel colors.

Remarks

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. Additional Resources: WebCamTexture.isDepth.