Documentation / Vec2 / clamp

clamp()

function clamp(
   min, 
   n, 
   max): number;

Defined in: Utils/vec2.ts:53

Clamps a value between a minimum and maximum value.

Parameters

min

The minimum clamping value. If undefined, no minimum clamping is done.

undefined | number

n

number

The value to clamp.

max

The maximum clamping value. If undefined, no maximum clamping is done.

undefined | number

Returns

number

The clamped value.

Example

let value = 1.5
let clampedValue = clamp(0, value, 1) // clampedValue is 1