@osdlc/color 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.0.1
+
+### Patch Changes
+
+- 828fa0f: `compositeOver` clamps a finite source alpha to 0-1, so `a: 2` is treated as opaque and `a: -1` as transparent, as `withAlpha` does.
+
 ## 1.0.0
 
 ### Major Changes

package/README.md

@@ -83,7 +83,8 @@ No function changes its arguments.
 - `fromPixel(px)` reads an `[r, g, b, a]` pixel from `ImageData.data`, where
   alpha is 0-255.
 - `compositeOver(src, ground)` paints `src` over an opaque `ground` and
-  rounds each channel to 8 bits.
+  rounds each channel to 8 bits. A `src` alpha outside 0-1 is clamped. A `src`
+  with alpha exactly 1 is returned as is.
 - `relativeLuminance(color)` is the WCAG 2 relative luminance, 0-1.
 - `contrastRatio(a, b)` is the WCAG 2 contrast ratio, 1-21. Each side is an
   `Rgba` or a CSS string.

package/dist/index.d.ts

@@ -14,8 +14,8 @@
  *
  * The fields are read-only, so a frozen object or an `as const` literal can be
  * passed in. Every function returns a new plain object, except that
- * {@link compositeOver} returns an opaque `src` as is; none changes its
- * arguments.
+ * {@link compositeOver} returns `src` itself when its alpha is exactly 1.
+ * None changes its arguments.
  */
 export interface Rgba {
     readonly r: number;
@@ -84,7 +84,9 @@ export declare function fromPixel(px: ArrayLike<number>): Rgba;
  * paints its own channels. Each mixed channel is rounded to 8 bits, as a
  * browser paints it. A Chromium 2D canvas gives the same pixel to within one
  * step per channel, because it also rounds the alpha to 8 bits and blends in
- * integers. An opaque `src` is returned as is.
+ * integers. A `src` whose alpha is exactly 1 is returned as is. A finite alpha
+ * outside 0-1 is clamped first, as {@link withAlpha} clamps it, so 2 gives a
+ * new object with `a: 1` and -1 gives the ground's channels.
  *
  * @throws RangeError when `ground.a` is below 1 or `NaN`. A translucent ground
  * shows what is under it, which this function does not know. Composite the

package/dist/index.js

@@ -204,7 +204,9 @@ export function fromPixel(px) {
  * paints its own channels. Each mixed channel is rounded to 8 bits, as a
  * browser paints it. A Chromium 2D canvas gives the same pixel to within one
  * step per channel, because it also rounds the alpha to 8 bits and blends in
- * integers. An opaque `src` is returned as is.
+ * integers. A `src` whose alpha is exactly 1 is returned as is. A finite alpha
+ * outside 0-1 is clamped first, as {@link withAlpha} clamps it, so 2 gives a
+ * new object with `a: 1` and -1 gives the ground's channels.
  *
  * @throws RangeError when `ground.a` is below 1 or `NaN`. A translucent ground
  * shows what is under it, which this function does not know. Composite the
@@ -218,9 +220,12 @@ export function compositeOver(src, ground) {
     if (!Number.isFinite(src.a)) {
         throw new RangeError(`color: compositeOver needs a finite source alpha, got ${src.a}`);
     }
-    if (src.a >= 1)
+    if (src.a === 1)
         return src;
-    const mix = (s, g) => Math.round(s * src.a + g * (1 - src.a));
+    const a = clamp(src.a, 1);
+    if (a === 1)
+        return { r: src.r, g: src.g, b: src.b, a: 1 };
+    const mix = (s, g) => Math.round(s * a + g * (1 - a));
     return { r: mix(src.r, ground.r), g: mix(src.g, ground.g), b: mix(src.b, ground.b), a: 1 };
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osdlc/color",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "sRGB colour arithmetic: parse the CSS colour syntaxes a browser reports, mix and composite in gamma-encoded sRGB, and measure WCAG 2 relative luminance and contrast. No dependencies.",
   "license": "MIT OR Apache-2.0",
   "author": "sksizer",