GetPixels
Gets the pixel color data for a mipmap level as Color structs.
Read time 4 minutesLast updated 4 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
GetPixels(int)
Gets the pixel color data for a mipmap level as Color structs.
public Color[] GetPixels(int miplevel)
Parameters
The mipmap level to get. The range is through the texture's Texture.mipmapCount. The default value is .
00Returns
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 .
trueThe array contains the pixels slice by slice starting at the front of the texture. Each slice contains the pixels row by row, starting at the bottom left of the texture. The size of the array is the width × height × depth of the mipmap level.
Each pixel is a Color struct. might be slower than some other texture methods because it converts the format the texture uses into Color. also needs to decompress compressed textures, and use memory to store the decompressed area. To get pixel data more quickly, use Texture3D.GetPixelData instead.
GetPixelsGetPixelsA single call to is usually faster than multiple calls to Texture3D.GetPixel, especially for large textures.
GetPixelsIf fails, Unity throws an exception. might fail if the array contains too much data. Use Texture3D.GetPixelData instead for very large textures.
GetPixelsGetPixelsYou can't use with textures that use Crunch texture compression. Use Texture3D.GetPixels32 instead.
GetPixelusing UnityEngine;public class Texture3DExample : MonoBehaviour{ public Texture3D source; public Texture3D destination; void Start() { // Get a copy of the color data from the source Texture3D, in high-precision float format. // Each element in the array represents the color data for an individual pixel. int sourceMipLevel = 0; Color[] pixels = source.GetPixels(sourceMipLevel); // If required, manipulate the pixels before applying them to the destination texture. // This example code reverses the array, which rotates the image 180 degrees. System.Array.Reverse(pixels, 0, pixels.Length); // Set the pixels of the destination Texture3D. int destinationMipLevel = 0; destination.SetPixels(pixels, destinationMipLevel); // Apply changes to the destination Texture3D, which uploads its data to the GPU. destination.Apply(); }}
Additional Resources: Texture3D.SetPixel, Texture3D.SetPixels, Texture3D.SetPixels32, Texture3D.GetPixel, Texture3D.GetPixelBilinear, Texture3D.GetPixels32, Texture3D.GetPixelData, Texture3D.Apply functions.
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 .
trueThe array contains the pixels slice by slice starting at the front of the texture. Each slice contains the pixels row by row, starting at the bottom left of the texture. The size of the array is the width × height × depth of the mipmap level.
Each pixel is a Color struct. might be slower than some other texture methods because it converts the format the texture uses into Color. also needs to decompress compressed textures, and use memory to store the decompressed area. To get pixel data more quickly, use Texture3D.GetPixelData instead.
GetPixelsGetPixelsA single call to is usually faster than multiple calls to Texture3D.GetPixel, especially for large textures.
GetPixelsIf fails, Unity throws an exception. might fail if the array contains too much data. Use Texture3D.GetPixelData instead for very large textures.
GetPixelsGetPixelsYou can't use with textures that use Crunch texture compression. Use Texture3D.GetPixels32 instead.
GetPixelusing UnityEngine;public class Texture3DExample : MonoBehaviour{ public Texture3D source; public Texture3D destination; void Start() { // Get a copy of the color data from the source Texture3D, in high-precision float format. // Each element in the array represents the color data for an individual pixel. int sourceMipLevel = 0; Color[] pixels = source.GetPixels(sourceMipLevel); // If required, manipulate the pixels before applying them to the destination texture. // This example code reverses the array, which rotates the image 180 degrees. System.Array.Reverse(pixels, 0, pixels.Length); // Set the pixels of the destination Texture3D. int destinationMipLevel = 0; destination.SetPixels(pixels, destinationMipLevel); // Apply changes to the destination Texture3D, which uploads its data to the GPU. destination.Apply(); }}
Additional Resources: Texture3D.SetPixel, Texture3D.SetPixels, Texture3D.SetPixels32, Texture3D.GetPixel, Texture3D.GetPixelBilinear, Texture3D.GetPixels32, Texture3D.GetPixelData, Texture3D.Apply functions.