vec2-fn
    Preparing search index...

    Function clamp

    • Clamp a vector by min and max limits.

      Type Parameters

      Parameters

      • target: T

        Target object.

      • vMin: number | Vec2Param

        Minimum vector.

      • vMax: number | Vec2Param

        Maximum vector.

      Returns T

      • A reference to the modified target object.

      Error - When a computed component is NaN or non-finite.

      clamp({ x: 5, y: -5 }, -1, 1); // -> { x: 1, y: -1 }
      
    • Clamp a vector by min and max limits.

      Type Parameters

      Parameters

      • target: Vec2Param

        Target object.

      • vMin: number | Vec2Param

        Minimum vector.

      • vMax: number | Vec2Param

        Maximum vector.

      • dest: D

        Destination object to store the values.

      Returns D

      • A reference to the modified destination object.

      Error - When a computed component is NaN or non-finite.

      const result = { x: 0, y: 0 };
      clamp({ x: 5, y: -5 }, -1, 1, result); // result -> { x: 1, y: -1 }