@texel/color 1.1.7 → 1.1.9

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "@texel/color",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "description": "a minimal and modern color library",
   "type": "module",
   "main": "./src/index.js",
+  "types": "./types.d.ts",
   "exports": {
-    "import": "./src/index.js"
+    "import": "./src/index.js",
+    "types": "./types.d.ts"
   },
   "license": "MIT",
   "author": {
@@ -30,8 +32,8 @@
   },
   "scripts": {
     "visualize": "canvas-sketch-cli test/canvas-graph.js --open",
-    "docs": "jsdoc src -t node_modules/better-docs -c tools/.jsdoc.json -d docs -R DOC.md",
-    "types": "jsdoc src -t node_modules/tsd-jsdoc/dist -c tools/.jsdoc.types.json -d .",
+    "docs": "jsdoc src -r -t node_modules/better-docs -c tools/.jsdoc.json -d docs -R DOC.md",
+    "types": "jsdoc src -r -t node_modules/tsd-jsdoc/dist -c tools/.jsdoc.types.json -d .",
     "test": "faucet test/test*.js",
     "bench": "node test/bench-colorjs.js",
     "bench:node": "NODE_ENV=production node --prof --no-logfile-per-isolate test/bench-node.js && node --prof-process v8.log",

package/src/core.js

@@ -20,6 +20,10 @@ import { listColorSpaces, sRGB, XYZ } from "./spaces.js";
  * const vec = [ x, y, z ];
  */
 
+/**
+ * @typedef {number[][][]} ColorGamutCoefficients
+ */
+
 /**
  * @typedef {Object} ChromaticAdaptation
  * @property {Matrix3x3} from the matrix to convert from the source whitepoint to the destination whitepoint
@@ -42,6 +46,7 @@ import { listColorSpaces, sRGB, XYZ } from "./spaces.js";
 /**
  * @typedef {Object} ColorGamut
  * @property {ColorSpace} space the color space associated with this color gamut
+ * @property {ColorGamutCoefficients} [coefficients] the coefficients used during gamut mapping from OKLab
  */
 
 const tmp3 = vec3();

package/src/gamut.js

@@ -92,8 +92,8 @@ const setYZ = (v, a, b) => {
  * the RGB gamut, using the given coefficients.
  * @param {number} a The normalized a component of the hue.
  * @param {number} b The normalized b component of the hue.
- * @param {number[][]} lmsToRgb The LMS to RGB conversion matrix.
- * @param {number[][][]} okCoeff The OKLab coefficients.
+ * @param {Matrix3x3} lmsToRgb The LMS to RGB conversion matrix.
+ * @param {ColorGamutCoefficients} okCoeff The OKLab coefficients.
  * @returns {number} The maximum saturation.
  * @method
  * @category mapping

package/types.d.ts

@@ -15,6 +15,7 @@ declare module "@texel/color" {
      * const vec = [ x, y, z ];
      */
     type Vector = number[];
+    type ColorGamutCoefficients = number[][][];
     /**
      * @property from - the matrix to convert from the source whitepoint to the destination whitepoint
      * @property to - the matrix to convert from the destination whitepoint to the source whitepoint
@@ -47,9 +48,11 @@ declare module "@texel/color" {
     };
     /**
      * @property space - the color space associated with this color gamut
+     * @property [coefficients] - the coefficients used during gamut mapping from OKLab
      */
     type ColorGamut = {
         space: ColorSpace;
+        coefficients?: ColorGamutCoefficients;
     };
     /**
      * Converts OKLab color to another color space.
@@ -156,7 +159,7 @@ declare module "@texel/color" {
      * @param okCoeff - The OKLab coefficients.
      * @returns The maximum saturation.
      */
-    function computeMaxSaturationOKLC(a: number, b: number, lmsToRgb: number[][], okCoeff: number[][][]): number;
+    function computeMaxSaturationOKLC(a: number, b: number, lmsToRgb: Matrix3x3, okCoeff: ColorGamutCoefficients): number;
     /**
      * Retrieves the LMS to RGB conversion matrix from the given gamut.
      * @param gamut - The gamut object.
@@ -216,6 +219,116 @@ declare module "@texel/color" {
      * @returns The OKHSV color as an array [h, s, v].
      */
     function OKLabToOKHSV(lab: Vector, gamut?: ColorGamut, out?: Vector): Vector;
+    /**
+     * The Adobe RGB (1998) color space in linear form, without a transfer function, aliased as <code>"a98-rgb-linear"</code>.
+     */
+    const A98RGBLinear: ColorSpace;
+    /**
+     * The Adobe RGB (1998) color space, with a transfer function, aliased as <code>"a98-rgb"</code>. Inherits from the {@link A98RGBLinear} color space.
+     */
+    const A98RGB: ColorSpace;
+    /**
+     * A color gamut for the {@link A98RGB}, or Adobe RGB (1998), color space.
+     */
+    const A98RGBGamut: ColorGamut;
+    /**
+     * The Display-P3 color space in linear form, without a transfer function, aliased as <code>"display-p3-linear"</code>.
+     */
+    const DisplayP3Linear: ColorSpace;
+    /**
+     * The Display-P3 color space, with a transfer function, aliased as <code>"display-p3"</code>. Inherits from the {@link DisplayP3Linear} color space.
+     */
+    const DisplayP3: ColorSpace;
+    /**
+     * A color gamut for the {@link DisplayP3} color space.
+     */
+    const DisplayP3Gamut: ColorGamut;
+    /**
+     * The OKLab color space.
+     */
+    const OKLab: ColorSpace;
+    /**
+     * The OKLCH color space, with Lightness, Chroma, and Hue components. This is the cylindrical form of the {@link OKLab} color space.
+     */
+    const OKLCH: ColorSpace;
+    /**
+     * An implementation of the OKHSL color space, fixed to the {@link sRGBGamut}. This is useful for color pickers and other applications where
+     * you wish to work with components in a well-defined and enclosed cylindrical form. If you wish to use OKHSL with a different gamut, you'll
+     * need to use the {@link OKHSLToOKLab} and {@link OKLabToOKHSL} methods directly, passing your desired gamut.
+     */
+    const OKHSL: ColorSpace;
+    /**
+     * An implementation of the OKHSV color space, fixed to the {@link sRGBGamut}. This is useful for color pickers and other applications where
+     * you wish to work with components in a well-defined and enclosed cylindrical form. If you wish to use OKHSL with a different gamut, you'll
+     * need to use the {@link OKHSLToOKLab} and {@link OKLabToOKHSL} methods directly, passing your desired gamut.
+     */
+    const OKHSV: ColorSpace;
+    /**
+     * The ProPhotoRGB color space in linear form, without a transfer function, aliased as <code>"prophoto-rgb-linear"</code>.
+     */
+    const ProPhotoRGBLinear: ColorSpace;
+    /**
+     * The ProPhotoRGB color space, with a transfer function, aliased as <code>"prophoto-rgb"</code>. Inherits from the {@link ProPhotoRGBLinear} color space.
+     */
+    const ProPhotoRGB: ColorSpace;
+    /**
+     * The Rec2020 color space in linear form, without a transfer function, aliased as <code>"rec2020-linear"</code>.
+     */
+    const Rec2020Linear: ColorSpace;
+    /**
+     * The Rec2020 color space, with a transfer function, aliased as <code>"rec2020"</code>. Inherits from the {@link Rec2020Linear} color space.
+     */
+    const Rec2020: ColorSpace;
+    /**
+     * A color gamut for the {@link Rec2020} color space.
+     */
+    const Rec2020Gamut: ColorGamut;
+    /**
+     * The sRGB color space in linear form, without a transfer function, aliased as <code>"srgb-linear"</code>.
+     */
+    const sRGBLinear: ColorSpace;
+    /**
+     * The sRGB color space, with a transfer function, aliased as <code>"srgb"</code>. Inherits from the {@link sRGBLinear} color space.
+     */
+    const sRGB: ColorSpace;
+    /**
+     * A color gamut for the {@link sRGB} color space.
+     */
+    const sRGBGamut: ColorGamut;
+    /**
+     * Converts a single sRGB gamma-corrected channel value to linear light (un-companded) form.
+     * @param val - The sRGB gamma-corrected channel value in the range [0, 1].
+     * @returns The linear light channel value.
+     */
+    function sRGBGammaToLinear(val: number): number;
+    /**
+     * Converts a single linear-light channel value to sRGB gamma-corrected form.
+     * @param val - The linear-light channel value in the range [0, 1].
+     * @returns The sRGB gamma-corrected channel value.
+     */
+    function sRGBLinearToGamma(val: number): number;
+    /**
+     * Converts a color from XYZ with D65 whitepoint to XYZ with D50 whitepoint.
+     * @param XYZ - The input color in XYZ with D65 whitepoint.
+     * @param [out = vec3()] - The output color in XYZ with D50 whitepoint.
+     * @returns The converted color in XYZ with D50 whitepoint.
+     */
+    function XYZD65ToD50(XYZ: Vector, out?: Vector): Vector;
+    /**
+     * Converts a color from XYZ with D50 whitepoint to XYZ with D65 whitepoint.
+     * @param XYZ - The input color in XYZ with D50 whitepoint.
+     * @param [out = vec3()] - The output color in XYZ with D65 whitepoint.
+     * @returns The converted color in XYZ with D65 whitepoint.
+     */
+    function XYZD50ToD65(XYZ: Vector, out?: Vector): Vector;
+    /**
+     * XYZ color space with D65 whitepoint, aliased as <code>"xyz"</code>.
+     */
+    const XYZ: ColorSpace;
+    /**
+     * XYZ color space with D50 whitepoint, aliased as <code>"xyz-d50"</code>.
+     */
+    const XYZD50: ColorSpace;
     /**
      * Returns a list of color spaces.
      * @returns An array of color space objects.