Version: 2021.2
LanguageEnglish
  • C#

Texture3D.SetPixelData

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

Declaration

public void SetPixelData(T[] data, int mipLevel, int sourceDataStartIndex = 0);

Declaration

public void SetPixelData(NativeArray<T> data, int mipLevel, int sourceDataStartIndex = 0);

Parameters

data Data array to initialize texture pixels with.
mipLevel Mip level to fill.
sourceDataStartIndex Index in the source array to start copying from (default 0).

Description

Set pixel values from raw preformatted data.

This function fills texture pixel memory of one mip level with raw data. This is useful if you want to load compressed or other non-color texture format data into a texture.

You should make the data that is passed the required size to fill the whole texture mip level according to its width, height, depth and data format. Unity throws an exception otherwise.

Note that not all platforms support compressed 3D Texture data so please consult SystemInfo.supportsCompressed3DTextures if you are using compressed formats.

Call Apply after setting image data to actually upload it to the GPU.

SetPixelData throws an exception when it fails.

See Also: SetPixels, GetPixelData, Apply, SystemInfo.supportsCompressed3DTextures.

using UnityEngine;

public class ExampleScript : MonoBehaviour { public Texture3D texture; public void Start() { texture = new Texture3D(2, 2, 2, TextureFormat.RGB24, true); var data = new byte[] { 255, 0, 0, // red 0, 255, 0, // green 0, 0, 255, // blue 255, 235, 4, // yellow 128, 0, 0, // dark red 0, 128, 0, // dark green 0, 0, 128, // dark blue 128, 117, 4, // dark yellow }; texture.SetPixelData(data, 0); texture.filterMode = FilterMode.Point; texture.Apply(updateMipmaps: false); } }