pixel-data-js 0.5.2 → 0.5.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "pixel-data-js",
   "type": "module",
-  "version": "0.5.2",
+  "version": "0.5.3",
   "packageManager": "pnpm@10.30.0",
   "description": "JS Pixel and ImageData operations",
   "author": {

package/src/Algorithm/floodFillSelection.ts

@@ -1,7 +1,7 @@
 import { type Color32, type ImageDataLike, MaskType, type Rect, type SelectionRect } from '../_types'
 import { colorDistance } from '../color'
 import { extractImageDataPixels } from '../ImageData/extractImageDataPixels'
-import type { PixelData } from '../PixelData'
+import type { PixelData } from '../PixelData/PixelData'
 import { trimRectBounds } from '../Rect/trimRectBounds'
 
 export type FloodFillImageDataOptions = {

package/src/IndexedImage/indexedImageToAverageColor.ts

@@ -0,0 +1,65 @@
+import type { Color32 } from '../_types'
+import { packColor } from '../color'
+import type { IndexedImage } from './IndexedImage'
+
+/**
+ * Calculates the area-weighted average color of an IndexedImage.
+ * This accounts for how often each palette index appears in the pixel data.
+ * @param indexedImage - The IndexedImage containing pixel indices and the palette.
+ * @param includeTransparent - Whether to include the transparent pixels in the average.
+ * @returns The average RGBA color of the image.
+ */
+export function indexedImageToAverageColor(
+  indexedImage: IndexedImage,
+  includeTransparent: boolean = false,
+): Color32 {
+  const { data, palette, transparentPalletIndex } = indexedImage
+  const counts = new Uint32Array(palette.length / 4)
+
+  // Tally occurrences of each index
+  for (let i = 0; i < data.length; i++) {
+    const id = data[i]!
+    counts[id]!++
+  }
+
+  let rSum = 0
+  let gSum = 0
+  let bSum = 0
+  let aSum = 0
+  let totalWeight = 0
+
+  for (let id = 0; id < counts.length; id++) {
+    const weight = counts[id]!
+
+    if (weight === 0) {
+      continue
+    }
+
+    if (!includeTransparent && id === transparentPalletIndex) {
+      continue
+    }
+
+    const pIdx = id * 4
+    const r = palette[pIdx]!
+    const g = palette[pIdx + 1]!
+    const b = palette[pIdx + 2]!
+    const a = palette[pIdx + 3]!
+
+    rSum += r * weight
+    gSum += g * weight
+    bSum += b * weight
+    aSum += a * weight
+    totalWeight += weight
+  }
+
+  if (totalWeight === 0) {
+    return packColor(0, 0, 0, 0)
+  }
+
+  const r = (rSum / totalWeight) | 0
+  const g = (gSum / totalWeight) | 0
+  const b = (bSum / totalWeight) | 0
+  const a = (aSum / totalWeight) | 0
+
+  return packColor(r, g, b, a)
+}

package/src/{PixelData.ts → PixelData/PixelData.ts}

@@ -1,4 +1,4 @@
-import type { ImageDataLike } from './_types'
+import type { ImageDataLike } from '../_types'
 
 export class PixelData {
   public readonly data32: Uint32Array

package/src/PixelData/applyMaskToPixelData.ts

@@ -1,5 +1,5 @@
 import { type AnyMask, type ApplyMaskOptions, MaskType } from '../_types'
-import type { PixelData } from '../PixelData'
+import type { PixelData } from './PixelData'
 
 /**
  * Directly applies a mask to a region of PixelData,

package/src/PixelData/blendColorPixelData.ts

@@ -1,6 +1,6 @@
 import { type Color32, type ColorBlendOptions, MaskType } from '../_types'
 import { sourceOverColor32 } from '../blend-modes'
-import type { PixelData } from '../PixelData'
+import type { PixelData } from './PixelData'
 
 /**
  * Fills a rectangle in the destination PixelData with a single color,

package/src/PixelData/blendPixelData.ts

@@ -1,6 +1,6 @@
 import { type Color32, MaskType, type PixelBlendOptions } from '../_types'
 import { sourceOverColor32 } from '../blend-modes'
-import type { PixelData } from '../PixelData'
+import type { PixelData } from './PixelData'
 
 /**
  * Blits source PixelData into a destination PixelData using 32-bit integer bitwise blending.

package/src/PixelData/clearPixelData.ts

@@ -1,5 +1,5 @@
 import type { Color32, Rect } from '../_types'
-import type { PixelData } from '../PixelData'
+import type { PixelData } from './PixelData'
 import { fillPixelData } from './fillPixelData'
 
 /**

package/src/PixelData/fillPixelData.ts

@@ -1,5 +1,5 @@
 import type { Color32, Rect } from '../_types'
-import type { PixelData } from '../PixelData'
+import type { PixelData } from './PixelData'
 
 /**
  * Fills a region or the {@link PixelData} buffer with a solid color.

package/src/PixelData/invertPixelData.ts

@@ -1,4 +1,4 @@
-import type { PixelData } from '../PixelData'
+import type { PixelData } from './PixelData'
 
 export function invertPixelData(
   pixelData: PixelData,

package/src/PixelData/pixelDataToAlphaMask.ts

@@ -1,5 +1,5 @@
 import type { AlphaMask } from '../_types'
-import type { PixelData } from '../PixelData'
+import type { PixelData } from './PixelData'
 
 /**
  * Extracts the alpha channel from PixelData into a single-channel mask.

package/src/index.ts

@@ -23,6 +23,7 @@ export * from './ImageData/serialization'
 export * from './ImageData/writeImageDataPixels'
 
 export * from './IndexedImage/IndexedImage'
+export * from './IndexedImage/indexedImageToAverageColor'
 
 export * from './Input/fileInputChangeToImageData'
 export * from './Input/fileToImageData'
@@ -33,7 +34,7 @@ export * from './Mask/extractMask'
 export * from './Mask/invertMask'
 export * from './Mask/mergeMasks'
 
-export * from './PixelData'
+export * from './PixelData/PixelData'
 export * from './PixelData/applyMaskToPixelData'
 export * from './PixelData/blendColorPixelData'
 export * from './PixelData/blendPixelData'