@OPEN-KAPPA/COLORS
    Preparing search index...

    Class ColorMathAbstract

    Class to wrap math utils.

    Index

    Accessors

    deg2radFactor epsilon rad2degFactor

    Methods

    clip degToRad equals hueInterpolation isZero lerp linearToSrgb normalizeHue radToDeg round roundDecimals srgbToLinear wrap zeroDiv

    Accessors

    • get deg2radFactor(): number

      Get the degrees to radiants conversion factor.

      Returns number

      The factor.

    • get epsilon(): number

      Precision for float comparisons. 1e-6 should be enough for HDR and humar eye perception.

      Returns number

      The precision.

    • get rad2degFactor(): number

      Get the radiants to degrees conversion factor.

      Returns number

      The factor.

    Methods

    • Clip.

      Parameters

      • val: number

        The value to clip.

      • min: number

        The min value.

      • max: number

        The max value.

      Returns number

      The clipped value.

    • Convert degrees to radiants.

      Parameters

      • deg: number

        The angle in degrees.

      Returns number

      The angle in radiants.

    • Safe floating point comparison.

      Parameters

      • v1: number

        The first value.

      • v2: number

        The second value.

      • Optionalepsilon: number

        Optional comparison precision.

      Returns boolean

      The comparison result.

    • Interpolate two hue channels.

      Parameters

      • channel1: number

        The first component.

      • channel2: number

        The second component.

      • isC1Achromatic: boolean

        Whether the first color is achromatic.

      • isC2Achromatic: boolean

        Whether the first color is achromatic.

      • weight: number

        The interpolation weight.

      • hueMethod: HueMethod

        The interpolation strategy.

      Returns number

      The interpolation result.

    • Safe floating point zero check.

      Parameters

      • val: number

        The value to check.

      • Optionalzero: number

        Optional comparison precision.

      Returns boolean

      True if the value is zero-aproximable.

    • Linear interpolation.

      Parameters

      • v1: number

        The first value.

      • v2: number

        The second value.

      • weight: number

        The interpolation weight.

      Returns number

      The interpolation result.

    • Converison from Lienar to sRGB.

      Parameters

      • value: number

        The value to convert.

      Returns number

      The converted value.

    • Normalize Hue angle between 0 and 360.

      Parameters

      • hue: number

        The hue.

      Returns number

      The normalized value.

    • Convert radiants to degrees.

      Parameters

      • rad: number

        The angle in radiants.

      Returns number

      The angle in degrees.

    • Round a number in a robust way. Fast implementation using numbers.

      Parameters

      • num: number

        The number.

      • decimals: number

        The decimals.

      Returns number

      The rounded number.

    • Round a number in a robust way. Slower implemmentation since uses strings, but more robust on very extreme edge cases w.r.t. round().

      Parameters

      • num: number

        The number.

      • decimals: number

        The decimals.

      Returns number

      The rounded number.

    • Converison from sRGB to Linear.

      Parameters

      • value: number

        The value to convert.

      Returns number

      The converted value.

    • Module. Support negative numbers.

      Parameters

      • val: number

        The value.

      • min: number

        The min value.

      • max: number

        The max value.

      Returns number

      The module result.

    • Safe division. If denominator is almost zero (Epsilon), return 0. In color science, if a division by 0 happens (e.g. calculation the saturation of a gray), the semantically correct result is "no saturation" (0), not Infinity.

      Parameters

      • nn: number

        The numerator.

      • dd: number

        The denominator.

      • Optionalfallback: number

        Optional value to return in case the denominator is zero. Default is zero.

      Returns number

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods