Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

Lerp

Linearly interpolates between colors a and b using the interpolation ratio t.
Read time 2 minutesLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

Lerp(Color, Color, float)

Linearly interpolates between colors 
a
and 
b
using the interpolation ratio 
t
.
public static Color Lerp(Color a, Color b, float t)

Parameters

a

Color
The start color, returned when t = 0.

b

Color
The end color, returned when t = 1.

t

float
The interpolation ratio. Will be clamped to the range [0; 1].

Returns

Type

Description

ColorThe color resulting from linear interpolation between 
a
and 
b
.

Remarks

t
is clamped to be between 0 and 1. When 
t
is 0, the function returns 
a
. When 
t
is 1, the function returns 
b
.
The code sample sets the color of a GameObject's material to a value between white and black, based on the amount of time that has elapsed.
using UnityEngine;public class ColorLerp : MonoBehaviour{    Color lerpedColor = Color.white;    Renderer renderer;    void Start()    {        renderer = GetComponent<Renderer>();    }    void Update()    {        lerpedColor = Color.Lerp(Color.white, Color.black, Mathf.PingPong(Time.time, 1));        renderer.material.color = lerpedColor;    }}
Additional Resources: Color.LerpUnclamped.

Lerp(Color, Color, float)

Linearly interpolates between colors 
a
and 
b
using the interpolation ratio 
t
.
public static Color Lerp(in Color a, in Color b, float t)

Parameters

a

Color
The start color, returned when t = 0.

b

Color
The end color, returned when t = 1.

t

float
The interpolation ratio. Will be clamped to the range [0; 1].

Returns

Type

Description

ColorThe color resulting from linear interpolation between 
a
and 
b
.

Remarks

t
is clamped to be between 0 and 1. When 
t
is 0, the function returns 
a
. When 
t
is 1, the function returns 
b
.
The code sample sets the color of a GameObject's material to a value between white and black, based on the amount of time that has elapsed.
using UnityEngine;public class ColorLerp : MonoBehaviour{    Color lerpedColor = Color.white;    Renderer renderer;    void Start()    {        renderer = GetComponent<Renderer>();    }    void Update()    {        lerpedColor = Color.Lerp(Color.white, Color.black, Mathf.PingPong(Time.time, 1));        renderer.material.color = lerpedColor;    }}
Additional Resources: Color.LerpUnclamped.