@texel/color 1.0.5 → 1.0.6

package/README.md

@@ -85,7 +85,7 @@ The return value is the new coordinates in the destination space; such as `[r,g,
 
 #### `output = gamutMapOKLCH(oklch, gamut = sRGBGamut, targetSpace = gamut.space, out = [0, 0, 0], mapping = MapToCuspL, [cusp])`
 
-Performs fast gamut mapping in OKLCH as [described by Björn Ottoson](https://bottosson.github.io/posts/gamutclipping/) (2021). This takes an input `[l,c,h]` coords in OKLCH space, and ensures the final result will lie within the specified color `gamut` (default `sRGBGamut`). You can further specify a different target space (which default's the the gamut's space), for example to get a linear-light sRGB and avoid the transfer function, or to keep the result in OKLCH:
+Performs fast gamut mapping in OKLCH as [described by Björn Ottoson](https://bottosson.github.io/posts/gamutclipping/) (2021). This takes an input `[l,c,h]` coords in OKLCH space, and ensures the final result will lie within the specified color `gamut` (default `sRGBGamut`). You can further specify a different target space (which default's to the gamut's space), for example to get a linear-light sRGB and avoid the transfer function, or to keep the result in OKLCH:
 
 ```js
 import { gamutMapOKLCH, sRGBGamut, sRGBLinear, OKLCH } from "@texel/color";
@@ -142,6 +142,7 @@ const cuspLC = findCuspOKLCH(a, b, gamut);
 
 // ... somewhere else in your program ...
 // pass 'cusp' parameter for faster evaluation
+// expected that your OKLCH coord has the same hue as the cusp (H)
 gamutMapOKLCH(oklch, gamut, gamut.space, out, MapToCuspL, cuspLC);
 ```
 
@@ -162,7 +163,7 @@ serialize([1, 0, 0], OKLCH, sRGB); // "rgb(255, 255, 255)"
 serialize([1, 0, 0], OKLCH); // "oklch(1 0 0)"
 ```
 
-#### `coords = deserialize(colorString)`
+#### `info = deserialize(colorString)`
 
 The inverse of `serialize`, this will take a string and determine the color space `id` it is referencing, and the 3 or 4 (for alpha) `coords`. This is intentionally limited in functionality, only supporting hex RGB, `rgb()` and `rgba()` bytes, and `oklch()`, `oklab()`, and plain `color()` functions with no modifiers.
 
@@ -331,7 +332,7 @@ OKHSLToOKLab([h, s, l], DisplayP3Gamut, optionalOutVec);
 
 [Colorjs](https://colorjs.io/) is fantastic and perhaps the current leading standard in JavaScript, but it's not very practical for creative coding and real-time web applications, where the requirements are often (1) leaner codebases, (2) highly optimized, and (3) minimal GC thrashing.
 
-Colorjs, and simialrly, [Culori](https://culorijs.org/)), are focused on matching CSS spec, which means it will very likely continue to grow in complexity over time, and performance will often be marred (for example, `@texel/color` cusp intersection gamut mapping is ~125 times faster than Colorjs and ~60 times faster than culori).
+Colorjs, and simialrly, [Culori](https://culorijs.org/), are focused on matching CSS spec, which means it will very likely continue to grow in complexity over time, and performance will often be marred (for example, `@texel/color` cusp intersection gamut mapping is ~125 times faster than Colorjs and ~60 times faster than culori).
 
 There are many other options such as [color-space](https://www.npmjs.com/package/color-space) or [color-convert](https://www.npmjs.com/package/color-convert), however, these do not support modern spacse such as OKLab and OKHSL, and/or have dubious levels of accuracy (many libraries, for example, do not distinguish between D50 and D65 whitepoints in XYZ).
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@texel/color",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "a minimal and modern color library",
   "type": "module",
   "main": "./src/index.js",

package/src/util.js

@@ -26,9 +26,12 @@ export const hexToRGB = (str, out = vec3()) => {
   return out;
 };
 
-export const RGBtoHex = (rgb) =>
+export const RGBToHex = (rgb) =>
   `#${rgb.map((n) => floatToByte(n).toString(16).padStart(2, "0")).join("")}`;
 
+/** @deprecated use RGBToHex */
+export const RGBtoHex = (rgb) => RGBToHex;
+
 export const isRGBInGamut = (lrgb, ep = GAMUT_EPSILON) => {
   const r = lrgb[0];
   const g = lrgb[1];

package/test/test.js

@@ -5,7 +5,7 @@ import {
   floatToByte,
   hexToRGB,
   isRGBInGamut,
-  RGBtoHex,
+  RGBToHex,
   linear_sRGB_to_LMS_M,
   LMS_to_linear_sRGB_M,
   LMS_to_XYZ_M,
@@ -320,7 +320,7 @@ test("should deserialize color string information", async (t) => {
 });
 
 test("utils", async (t) => {
-  t.deepEqual(RGBtoHex([0, 0.5, 1]), "#0080ff");
+  t.deepEqual(RGBToHex([0, 0.5, 1]), "#0080ff");
   t.deepEqual(hexToRGB("#0080ff"), [0, 0.5019607843137255, 1]);
   const tmp = [0, 0, 0];
   hexToRGB("#0080ff", tmp);