Version: 2023.2
LanguageEnglish
  • C#

Cubemap.Apply

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 Apply(bool updateMipmaps = true, bool makeNoLongerReadable = false);

Parameters

updateMipmaps When the value is true, Unity recalculates mipmap levels, using mipmap level 0 as the source. The default value is true.
makeNoLongerReadable When the value is true, Unity deletes the texture in CPU memory after it uploads it to the GPU, and sets isReadable to false. The default value is false.

Description

Copies changes you've made in a CPU texture to the GPU.

For most types of textures, Unity can store a copy of the texture in both CPU and GPU memory. The CPU copy is optional. If the CPU copy exists, you can read from and write to the CPU copy more flexibly than the GPU copy. But to render the updated texture, you must use Apply to copy it from the CPU to the GPU.

If you set makeNoLongerReadable to true, Unity deletes the CPU copy of the texture after it uploads it to the GPU.

You usually only set updateMipmaps to false if you've already updated the mipmap levels, for example using SetPixels.

Apply is an expensive operation because it copies all the pixels in the texture even if you've only changed some of the pixels, so change as many pixels as possible before you call it.

using UnityEngine;

public class Example : MonoBehaviour { public Cubemap cubeMap;

void Start() { cubeMap.SetPixel(CubemapFace.PositiveX, 0, 0, Color.red); // Do more changes to the faces... cubeMap.Apply(); // Apply the stuff done to the Cubemap. } }