Version: 2019.2
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
public void SetColor(string name, Color value);
public void SetColor(int nameID, Color value);

Parameters

nameIDProperty name ID, use Shader.PropertyToID to get it.
nameProperty name, e.g. "_Color".
valueColor value to set.

Description

Sets a named 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.

Common color names used by Unity's builtin shaders:
"_Color" is the main color of a material. This can also be accessed via color property.
"_EmissionColor" is the emissive color of a material.

See Also: 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>();

//Call SetColor using the shader property name "_Color" and setting the color to red cubeRenderer.material.SetColor("_Color", Color.red); } }

Did you find this page useful? Please give it a rating: