constrain - nodef/extra-math GitHub Wiki

Constrain a number within a minimum and a maximum value.

Similar: constrain, normalize, remap, lerp.

function constrain(x, min, max)
// x:   a number
// min: minimum value
// max: maximum value

const xmath = require('extra-math');


xmath.constrain(20, 0, 50);
// → 20

xmath.constrain(-10, 0, 100);
// → 0

xmath.constrain(120, 0, 100);
// → 100

References

• constrain(): Processing reference
• clamp package by Hugh Kennedy
• std::clamp: cppreference
• std.algorithm.comparison.clamp: D-lang documentation
• clamp(): raster package by R documentation
• Math.Clamp: .NET docs
• clamp: Direct3D HLSL
• clamp: OpenGL Reference pages
• Mathf.Clamp: Unity documentation
• Clamping (graphics): Wikipedia