Version: 2021.2
LanguageEnglish
  • C#

Cubemap.SetPixel

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 SetPixel(CubemapFace face, int x, int y, Color color, int mip = 0);

Parameters

face Face of the Cubemap to set.
x X coordinate of the pixel to set.
y Y coordinate of the pixel to set.
color Color to set.
mip Mip level to set, must be in the range [0, mipCount[.

Description

Sets pixel color at coordinates (face, x, y).

Call Apply to actually upload the changed pixels to the graphics card. Uploading is an expensive operation, so you'll want to change as many pixels as possible between Apply calls.

This method works only on RGBA32, ARGB32, RGB24 and Alpha8 texture formats. For other formats SetPixel is ignored.

See Also: SetPixelData, Apply method.

using UnityEngine;

public class Example : MonoBehaviour { public Cubemap cubeMap;

void Start() { // Set the pixel at (0,0) of the +X face red. cubeMap.SetPixel(CubemapFace.PositiveX, 0, 0, Color.red); cubeMap.Apply(); // Apply the stuff done to the Cubemap. } }