constrain()

Math / Calculation

Description

Constrains a value to not exceed a maximum and minimum value.

Syntax

float constrain(float v, float lo, float hi)

Parameters

NameTypeDescription
vfloatthe value to constrain
lofloatminimum limit
hifloatmaximum limit

Returns

float

Related

Under the Hood

From Processing.h:

float constrain(float,float,float); inline float constrain(V val,A lo,B hi){ return _api::constrain((float)val,(float)lo,(float)hi); static float constrain(float v,float lo,float hi) { return v<lo?lo:(v>hi?hi:v); } inline float constrain(float v,float lo,float hi){ return PApplet::constrain(v,lo,hi); } inline float constrain(float v,float lo,float hi){ return PApplet::constrain(v,lo,hi);