Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

LineRenderer.colorGradient

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 var colorGradient: Gradient;
public Gradient colorGradient;

Description

Set the color gradient describing the color of the line at various points along its length.

See Also: Gradient.

#pragma strict
private var lr: LineRenderer;
function Start() {
	lr = GetComponent.<LineRenderer>();
	lr.material = new Material(Shader.Find("Sprites/Default"));
	// Set some positions
	var positions: Vector3[] = new Vector3[3];
	positions[0] = new Vector3(-2.0f, -2.0f, 0.0f);
	positions[1] = new Vector3(0.0f, 2.0f, 0.0f);
	positions[2] = new Vector3(2.0f, -2.0f, 0.0f);
	lr.positionCount = positions.Length;
	lr.SetPositions(positions);
	// A simple 2 color gradient with a fixed alpha of 1.0f.
	var alpha: float = 1.0f;
	var gradient: Gradient = new Gradient();
	gradient.SetKeys([new GradientColorKey(Color.green, 0.0f), new GradientColorKey(Color.red, 1.0f)], [new GradientAlphaKey(alpha, 0.0f), new GradientAlphaKey(alpha, 1.0f)]);
	lr.colorGradient = gradient;
}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { private LineRenderer lr;

void Start() { lr = GetComponent<LineRenderer>(); lr.material = new Material(Shader.Find("Sprites/Default"));

// Set some positions Vector3[] positions = new Vector3[3]; positions[0] = new Vector3(-2.0f, -2.0f, 0.0f); positions[1] = new Vector3(0.0f, 2.0f, 0.0f); positions[2] = new Vector3(2.0f, -2.0f, 0.0f); lr.positionCount = positions.Length; lr.SetPositions(positions);

// A simple 2 color gradient with a fixed alpha of 1.0f. float alpha = 1.0f; Gradient gradient = new Gradient(); gradient.SetKeys( new GradientColorKey[] { new GradientColorKey(Color.green, 0.0f), new GradientColorKey(Color.red, 1.0f) }, new GradientAlphaKey[] { new GradientAlphaKey(alpha, 0.0f), new GradientAlphaKey(alpha, 1.0f) } ); lr.colorGradient = gradient; } }

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