@texel/color 1.0.2 → 1.0.3

package/package.json

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

package/src/gamut.js

@@ -288,8 +288,14 @@ export const gamutMapOKLCH = (
   // convert oklch to base gamut space (i.e. linear sRGB)
   convert(out, OKLCH, gamutSpaceBase, rgbVec);
 
+  // Note: if the distance lies under this threshold, it's unlikely
+  // that gamut mapping will do anything, and it may simply produce a new
+  // point that lies the same or similar distance away from the gamut edge
+  // see test/test-gamut-epsilon.js
+  const RGB_CLIP_EPSILON = 0.000074;
+
   // check where the point lies in gamut space
-  if (!isRGBInGamut(rgbVec, 0)) {
+  if (!isRGBInGamut(rgbVec, RGB_CLIP_EPSILON)) {
     // we aren't in gamut, so let's map toward it
     const L = out[0];
     const C = out[1];
@@ -314,17 +320,7 @@ export const gamutMapOKLCH = (
     out[0] = lerp(LTarget, L, t);
     out[1] *= t;
 
-    // special case: if requested targetSpace is base=OKLCH, we can return early.
-    // note this creates a potential difference compared to other targetSpaces, which
-    // will be clipped in RGB before converting to the target space.
-    // however, due to floating point arithmetic, a user doing OKLCH -> RGB will still
-    // need to clip the result again anyways, so perhaps this difference is negligible.
-    const targetSpaceBase = targetSpace.base ?? targetSpaceBase;
-    if (targetSpaceBase == OKLab) {
-      return convert(out, OKLCH, targetSpace, out);
-    }
-
-    // now that we have a LCH that sits on the gamut, convert again to linear space
+    // now that we have a LCH that sits on (or nearly on) the gamut, convert again to linear space
     convert(out, OKLCH, gamutSpaceBase, rgbVec);
   }
   // clip the linear RGB to 0..1 range

package/test/bench-culori.js

@@ -19,6 +19,8 @@ import {
 import { p3, toGamut, oklch, okhsl, converter } from "culori";
 
 const N = 256 * 256;
+const gamut = DisplayP3Gamut;
+const target = gamut.space;
 
 // get N OKLCH in-gamut pixels by sampling uniformly from OKHSL cube
 const oklchPixelsInGamut = Array(N)
@@ -27,8 +29,8 @@ const oklchPixelsInGamut = Array(N)
     const t = i / (lst.length - 1);
     // note if we use the standard OKHSL space, it is bound to sRGB gamut...
     // so instead we use the OKHSLToOKLab function and pass P3 gamut
-    const okhsl = [t, t, t * 360];
-    const oklab = OKHSLToOKLab(okhsl, DisplayP3Gamut);
+    const okhsl = [t * 360, t, t];
+    const oklab = OKHSLToOKLab(okhsl, gamut);
     return convert(oklab, OKLab, OKLCH);
   });
 
@@ -44,12 +46,34 @@ const toP3Gamut = toGamut("p3", "oklch");
 // same perf as p3() it seems
 // const p3Converter = converter("p3");
 
-test(oklchPixelsInGamut, "Random Samling in P3 Gamut");
-test(oklchPixelsRandom, "Random Samling in OKLab L Planes");
+test(oklchPixelsInGamut, "Random Sampling in P3 Gamut");
+test(oklchPixelsRandom, "Random Sampling in OKLab L Planes");
+test(oklchPixelsRandom, "Random Sampling in OKLab L Planes", true);
+
+function test(inputPixelsOKLCH, label, fixedCusp) {
+  let cuspMap;
+  if (fixedCusp) {
+    cuspMap = new Array(360).fill(null);
+    inputPixelsOKLCH = inputPixelsOKLCH.map((oklch) => {
+      const H = constrainAngle(Math.round(oklch[2]));
+      oklch = oklch.slice();
+      oklch[2] = H;
+      if (!cuspMap[H]) {
+        const Hr = degToRad(H);
+        const a = Math.cos(Hr);
+        const b = Math.sin(Hr);
+        cuspMap[H] = findCuspOKLCH(a, b, gamut);
+      }
+      return oklch;
+    });
+  }
 
-function test(inputPixelsOKLCH, label) {
-  console.log("Testing with input type: %s", label);
-  const culoriInputsOKLCH = oklchPixelsRandom.map(([l, c, h]) => {
+  console.log(
+    "Testing with input type: %s%s",
+    label,
+    fixedCusp ? " (Fixed Cusp)" : ""
+  );
+  const culoriInputsOKLCH = inputPixelsOKLCH.map(([l, c, h]) => {
     return {
       mode: "oklch",
       l,
@@ -66,7 +90,7 @@ function test(inputPixelsOKLCH, label) {
   tmp = [0, 0, 0];
   now = performance.now();
   for (let oklch of inputPixelsOKLCH) {
-    convert(oklch, OKLCH, DisplayP3, tmp);
+    convert(oklch, OKLCH, target, tmp);
   }
   elapsedOurs = performance.now() - now;
 
@@ -74,7 +98,7 @@ function test(inputPixelsOKLCH, label) {
   for (let oklchColor of culoriInputsOKLCH) {
     p3(oklchColor);
 
-    // same perf
+    // same perf ?
     // p3Converter(oklchColor);
   }
   elapsedCulori = performance.now() - now;
@@ -83,11 +107,20 @@ function test(inputPixelsOKLCH, label) {
   //// gamut
 
   tmp = [0, 0, 0];
-  now = performance.now();
-  for (let oklch of inputPixelsOKLCH) {
-    gamutMapOKLCH(oklch, DisplayP3Gamut, DisplayP3, tmp);
+  if (fixedCusp && cuspMap) {
+    now = performance.now();
+    for (let oklch of inputPixelsOKLCH) {
+      const cusp = cuspMap[oklch[2]];
+      gamutMapOKLCH(oklch, gamut, target, tmp, undefined, cusp);
+    }
+    elapsedOurs = performance.now() - now;
+  } else {
+    now = performance.now();
+    for (let oklch of inputPixelsOKLCH) {
+      gamutMapOKLCH(oklch, gamut, target, tmp);
+    }
+    elapsedOurs = performance.now() - now;
   }
-  elapsedOurs = performance.now() - now;
 
   now = performance.now();
   for (let oklchColor of culoriInputsOKLCH) {

package/test/test-gamut-epsilon.js

@@ -0,0 +1,107 @@
+// When gamut mapping with OKLCH approximation,
+// the resulting points do not always lie exactly in gamut.
+// The same may be true of OKHSL to RGB spaces.
+// Let's figure out how far away they are:
+// if a given point is under this threshold, gamut mapping
+// will be redundant as it will just produce the same epsilon.
+// This value is used in gamut.js as the RGB_CLIP_EPSILON
+
+import {
+  A98RGBGamut,
+  clampedRGB,
+  convert,
+  degToRad,
+  DisplayP3Gamut,
+  findCuspOKLCH,
+  findGamutIntersectionOKLCH,
+  gamutMapOKLCH,
+  isRGBInGamut,
+  lerp,
+  MapToCuspL,
+  OKLCH,
+  Rec2020Gamut,
+  sRGBGamut,
+} from "../src/index.js";
+
+const huePlanes = Array(360)
+  .fill()
+  .map((_, i) => i);
+const gamut = sRGBGamut;
+const target = gamut.space.base; // linear form
+
+// slice the plane into a square
+const slices = 100;
+let avgDelta = 0;
+let avgCount = 0;
+let minDelta = Infinity;
+let maxDelta = -Infinity;
+
+const EPSILON = 0.000074;
+let totalPointsOutOfGamut = 0;
+let totalPointsUnderEpsilon = 0;
+
+for (let H = 0; H < 360; H += 0.5) {
+  for (let y = 0; y < slices; y++) {
+    for (let x = 0; x < slices; x++) {
+      const u = x / (slices - 1);
+      const v = y / (slices - 1);
+      const L = 1 - v;
+      const C = u * 0.4;
+
+      // try conversion
+      const rgbl = convert([L, C, H], OKLCH, target);
+
+      // not exactly in space
+      if (!isRGBInGamut(rgbl, 0)) {
+        // we aren't in gamut, so let's map toward it
+        const hueAngle = degToRad(H);
+        const aNorm = Math.cos(hueAngle);
+        const bNorm = Math.sin(hueAngle);
+
+        const out = [L, C, H];
+        // choose our strategy
+        const cusp = findCuspOKLCH(aNorm, bNorm, gamut);
+        const LTarget = MapToCuspL(out, cusp);
+
+        let t = findGamutIntersectionOKLCH(
+          aNorm,
+          bNorm,
+          L,
+          C,
+          LTarget,
+          cusp,
+          gamut
+        );
+        out[0] = lerp(LTarget, L, t);
+        out[1] *= t;
+
+        // convert again to rgb linear
+        const rgbl = convert(out, OKLCH, target);
+        const clipped = clampedRGB(rgbl);
+        const dr = Math.abs(rgbl[0] - clipped[0]);
+        const dg = Math.abs(rgbl[1] - clipped[1]);
+        const db = Math.abs(rgbl[2] - clipped[2]);
+        const avg = (dr + dg + db) / 3;
+        const min = Math.min(dr, dg, db);
+        const max = Math.max(dr, dg, db);
+        avgDelta += avg;
+        avgCount++;
+        minDelta = Math.min(min, minDelta);
+        maxDelta = Math.max(max, maxDelta);
+
+        totalPointsOutOfGamut++;
+        if (isRGBInGamut(rgbl, EPSILON)) {
+          totalPointsUnderEpsilon++;
+        }
+      }
+    }
+  }
+}
+avgDelta /= avgCount;
+
+console.log("Min Epsilon:", minDelta);
+console.log("Max Epsilon:", maxDelta);
+console.log("Average Epsilon:", avgDelta);
+console.log("Compare against epsilon:", EPSILON);
+console.log("Total points out of gamut:", totalPointsOutOfGamut);
+console.log("Total points under epsilon:", totalPointsUnderEpsilon);