Version: 2018.2 (switch to 2018.1 or 2017.4)
LanguageEnglish
  • C#

Mathf.InverseLerp

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

public static float InverseLerp(float a, float b, float value);

Parameters

aStart value.
bEnd value.
valueValue between start and end.

Returns

float Percentage of value between start and end.

Description

Calculates the linear parameter t that produces the interpolant value within the range [a, b].

The a and b values define the start and end of the line. Value is a location between a and b. Subtract a from both a and b and value to make a', b' and value'. This makes a' to be zero and b' and value' to be reduced. Finally divide value' by b'. This gives the InverseLerp amount.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public float walkSpeed = 5.0f; public float runSpeed = 10.0f; public float speed = 8.0f;

void Start() { float parameter = Mathf.InverseLerp(walkSpeed, runSpeed, speed); Debug.Log("InverseLerp: 5, 10, 8 = " + parameter); } }

See Also: Lerp.

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