Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SetPixelData

Sets the raw data of an entire mipmap level of a face directly in CPU memory.
Read time 3 minutesLast updated 4 days ago

Definition

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

SetPixelData<T>(`<>[], int, CubemapFace, int, int)

Sets the raw data of an entire mipmap level of a face directly in CPU memory.
public void SetPixelData<T>(T[] data, int mipLevel, CubemapFace face, int element, int sourceDataStartIndex = 0)

Parameters

data

<T>[]
The array of data to use.

mipLevel

int
The mipmap level to write to. The range is 
0
through the texture's Texture.mipmapCount. The default value is 
0
.

face

CubemapFace
The CubemapFace to write to.

element

int
The array slice to write to.

sourceDataStartIndex

int
The index in the source array to start copying from. The default value is 
0
.

Remarks

This method sets pixel data for the texture in CPU memory. Texture.isReadable must be 
true
, and you must call CubemapArray.Apply after 
SetPixelData
to upload the changed pixels to the GPU.
SetPixelData
is useful if you want to load compressed or other non-color texture format data into a texture.
The size of the 
data
array must be the width × height of the mipmap level of the face, and the data layout must match the texture format, otherwise 
SetPixelData
fails. You can use 
byte
for 
T
if you don't want to define a custom struct to match the texture format.
Unity throws an exception when 
SetPixelData
fails.
Additional Resources: CubemapArray.SetPixels, CubemapArray.GetPixelData, CubemapArray.Apply.

Examples

using UnityEngine;public class ExampleScript : MonoBehaviour{    public CubemapArray texture;    public void Start()    {        texture = new CubemapArray(2, 2, TextureFormat.RGB24, true);        var data = new byte[]        {            // mip 0: 2x2 size            255, 0, 0, // red            0, 255, 0, // green            0, 0, 255, // blue            255, 255, 255, // white            // mip 1: 1x1 size            255, 255, 0 // yellow        };        texture.SetPixelData(data, 0, CubemapFace.PositiveX, 0, 0);        texture.SetPixelData(data, 1, CubemapFace.PositiveX, 0, 12);        texture.Apply(updateMipmaps: false);    }}

SetPixelData<T>(NativeArray<T>, int, CubemapFace, int, int)

Sets the raw data of an entire mipmap level of a face directly in CPU memory.
public void SetPixelData<T>(NativeArray<T> data, int mipLevel, CubemapFace face, int element, int sourceDataStartIndex = 0) where T : struct

Parameters

data

NativeArray<T>
The array of data to use.

mipLevel

int
The mipmap level to write to. The range is 
0
through the texture's Texture.mipmapCount. The default value is 
0
.

face

CubemapFace
The CubemapFace to write to.

element

int
The array slice to write to.

sourceDataStartIndex

int
The index in the source array to start copying from. The default value is 
0
.

Remarks

This method sets pixel data for the texture in CPU memory. Texture.isReadable must be 
true
, and you must call CubemapArray.Apply after 
SetPixelData
to upload the changed pixels to the GPU.
SetPixelData
is useful if you want to load compressed or other non-color texture format data into a texture.
The size of the 
data
array must be the width × height of the mipmap level of the face, and the data layout must match the texture format, otherwise 
SetPixelData
fails. You can use 
byte
for 
T
if you don't want to define a custom struct to match the texture format.
Unity throws an exception when 
SetPixelData
fails.
Additional Resources: CubemapArray.SetPixels, CubemapArray.GetPixelData, CubemapArray.Apply.

Examples

using UnityEngine;public class ExampleScript : MonoBehaviour{    public CubemapArray texture;    public void Start()    {        texture = new CubemapArray(2, 2, TextureFormat.RGB24, true);        var data = new byte[]        {            // mip 0: 2x2 size            255, 0, 0, // red            0, 255, 0, // green            0, 0, 255, // blue            255, 255, 255, // white            // mip 1: 1x1 size            255, 255, 0 // yellow        };        texture.SetPixelData(data, 0, CubemapFace.PositiveX, 0, 0);        texture.SetPixelData(data, 1, CubemapFace.PositiveX, 0, 12);        texture.Apply(updateMipmaps: false);    }}