data | The array of data to use. |
mipLevel | The mipmap level to write to. The range is 0 through the texture's Texture.mipmapCount. The default value is 0 . |
face | The CubemapFace to write to. |
sourceDataStartIndex | The index in the source array to start copying from. The default value is 0 . |
element | The array slice to write to. |
Sets the raw data of an entire mipmap level of a face directly in CPU memory.
This method sets pixel data for the texture in CPU memory. Texture.isReadable must be true
, and you must call 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.
See Also: SetPixels, GetPixelData, Apply.
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); } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.