Version: 2020.1
LanguageEnglish
  • C#

Cubemap.GetPixelData

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

Switch to Manual
public NativeArray<T> GetPixelData(int mipLevel, CubemapFace face);

Parameters

mipLevelThe mip level to reference.
faceThe Cubemap face to reference.

Description

Gets raw data from a Texture for reading or writing.

This function returns a direct "view" into the Texture pixel data as a Unity.Collections.NativeArray.

A slice of the data will be returned according to the requested mip level and Cubemap face. For example, for a 16x16 sized Texture of RGBA32 format, getting the mip=1 level (8x8 size) will result in a 256-byte array or a 64-element array if Color32 is used as a type.

You can read from and write to the returned array. If you write to it, you must call the Apply method to upload the Texture to the GPU. If an array returned by GetPixelData was used to fill up a non-0 level mip map, then updateMipmaps must be set to false before calling the Apply method.

GetPixelData does not allocate memory; the returned NativeArray directly points to the Texture system memory data buffer.

It is recommended to immediately use or modify the data retrieved by this method and to not store the returned array for later use as the returned array can become invalid (i.e. it no longer points to valid memory) if the Texture is modified or updated after you called this method.

See Also: Apply, SetPixels, GetPixelData.

using UnityEngine;

public class ExampleScript : MonoBehaviour { public void Start() { var m_Cubemap = new Cubemap(16, TextureFormat.RGBA32, true); var mip0Face4 = m_Cubemap.GetPixelData<Color32>(1, CubemapFace.PositiveZ);

// pixels in mip = 1, CubemapFace.PositiveZ are filled with white color for (int i = 0; i < mip0Face4.Length; i++) { mip0Face4[i] = new Color32(255, 255, 255, 255); }

m_Cubemap.Apply(false); } }

Did you find this page useful? Please give it a rating: