Mirror Engine API / math / smoothstep

Function: smoothstep()

function smoothstep(min: number, max: number, x: number): number

The function interpolates smoothly between two input values based on a third one that should be between the first two. The returned value is clamped between 0 and 1.

The slope (i.e. derivative) of the smoothstep function starts at 0 and ends at 0. This makes it easy to create a sequence of transitions using smoothstep to interpolate each segment rather than using a more sophisticated or expensive interpolation technique.

See https://en.wikipedia.org/wiki/Smoothstep for more details.

Parameters

min

number

The lower bound of the interpolation range.

max

number

The upper bound of the interpolation range.

x

number

The value to interpolate.

Returns

number

The smoothly interpolated value clamped between zero and one.