Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

Material.SetColor

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 SetColor(string name, Color value);

Declaration

public void SetColor(int nameID, Color value);

Parameters

nameID Property name ID, use Shader.PropertyToID to get it.
name Property name. For example, "_Color" in Built-in Render Pipeline, "_BaseColor" in URP.
value Color value to set.

Description

Sets a color value.

Many shaders use more than one color. Use SetColor to change the color (identified by shader property name, or unique property name ID).

When setting color values on materials using the Standard Shader, you should be aware that you may need to use EnableKeyword to enable features of the shader that were not previously in use. For more detail, read Accessing Materials via Script.

Color property names are defined in the Properties section in the shader code. Here are examples of the color properties in Unity pre-built shaders:
_Color: the main color of a material (URP: _BaseColor). You can access this shader property via the color property.
_EmissionColor: the emissive color of a material.

Additional resources: color, GetColor, Shader.PropertyToID, Properties in Shader Programs.

//Attach this script to any GameObject in your scene to spawn a cube and change the material color
using UnityEngine;

public class Example : MonoBehaviour { void Start() { // Create a new cube primitive to set the color on GameObject cube = GameObject.CreatePrimitive(PrimitiveType.Cube);

// Get the Renderer component from the new cube var cubeRenderer = cube.GetComponent<Renderer>();

// Use SetColor to set the main color shader property cubeRenderer.material.SetColor("_Color", Color.red); // If your project uses URP, uncomment the following line and use it instead of the previous line // cubeRenderer.material.SetColor("_BaseColor", Color.red); } }