pixel-data-js 0.5.2 → 0.5.3

package/dist/index.prod.d.ts

@@ -613,6 +613,15 @@ type IndexedImage = {
  */
 declare function makeIndexedImage(imageData: ImageData): 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.
+ */
+declare function indexedImageToAverageColor(indexedImage: IndexedImage, includeTransparent?: boolean): Color32;
+
 /**
  * A convenience wrapper that extracts the first {@link File} from an
  * {@link HTMLInputElement} change event and converts it into {@link ImageData}.
@@ -819,4 +828,4 @@ declare function pixelDataToAlphaMask(pixelData: PixelData): AlphaMask;
  */
 declare function trimRectBounds<T extends Rect | SelectionRect>(target: T, bounds: Rect): void;
 
-export { type AlphaMask, type AnyMask, type ApplyMaskOptions, type Base64EncodedUInt8Array, type BinaryMask, type BlendColor32, BlendMode, type BlendModeIndex, COLOR_32_BLEND_MODES, COLOR_32_BLEND_TO_INDEX, type Color32, type ColorBlendOptions, type FloodFillImageDataOptions, type FloodFillResult, INDEX_TO_COLOR_32_BLEND, type ImageDataLike, type IndexedImage, MaskType, type PixelBlendOptions, type PixelCanvas, PixelData, type PixelOptions, type RGBA, type Rect, type RegisteredBlender, type ReusableCanvas, type SelectionRect, type SerializedImageData, UnsupportedFormatError, applyMaskToPixelData, base64DecodeArrayBuffer, base64EncodeArrayBuffer, blendColorPixelData, blendPixelData, clearPixelData, color32ToCssRGBA, color32ToHex, colorBurnColor32, colorDistance, colorDodgeColor32, copyImageData, copyImageDataLike, copyMask, darkenColor32, darkerColor32, deserializeImageData, deserializeNullableImageData, deserializeRawImageData, differenceColor32, divideColor32, exclusionColor32, extractImageDataPixels, extractMask, fileInputChangeToImageData, fileToImageData, fillPixelData, floodFillSelection, getImageDataFromClipboard, getSupportedPixelFormats, hardLightColor32, hardMixColor32, imageDataToAlphaMask, imageDataToDataUrl, imageDataToImgBlob, imgBlobToImageData, invertAlphaMask, invertBinaryMask, invertImageData, invertPixelData, lerpColor32, lerpColor32Fast, lightenColor32, lighterColor32, linearBurnColor32, linearDodgeColor32, linearLightColor32, makeIndexedImage, makePixelCanvas, makeReusableCanvas, mergeMasks, multiplyColor32, overlayColor32, overwriteColor32, packColor, packRGBA, pinLightColor32, pixelDataToAlphaMask, resizeImageData, screenColor32, serializeImageData, serializeNullableImageData, softLightColor32, sourceOverColor32, subtractColor32, trimRectBounds, unpackAlpha, unpackBlue, unpackColor, unpackColorTo, unpackGreen, unpackRed, vividLightColor32, writeImageDataPixels, writeImageDataToClipboard, writeImgBlobToClipboard };
+export { type AlphaMask, type AnyMask, type ApplyMaskOptions, type Base64EncodedUInt8Array, type BinaryMask, type BlendColor32, BlendMode, type BlendModeIndex, COLOR_32_BLEND_MODES, COLOR_32_BLEND_TO_INDEX, type Color32, type ColorBlendOptions, type FloodFillImageDataOptions, type FloodFillResult, INDEX_TO_COLOR_32_BLEND, type ImageDataLike, type IndexedImage, MaskType, type PixelBlendOptions, type PixelCanvas, PixelData, type PixelOptions, type RGBA, type Rect, type RegisteredBlender, type ReusableCanvas, type SelectionRect, type SerializedImageData, UnsupportedFormatError, applyMaskToPixelData, base64DecodeArrayBuffer, base64EncodeArrayBuffer, blendColorPixelData, blendPixelData, clearPixelData, color32ToCssRGBA, color32ToHex, colorBurnColor32, colorDistance, colorDodgeColor32, copyImageData, copyImageDataLike, copyMask, darkenColor32, darkerColor32, deserializeImageData, deserializeNullableImageData, deserializeRawImageData, differenceColor32, divideColor32, exclusionColor32, extractImageDataPixels, extractMask, fileInputChangeToImageData, fileToImageData, fillPixelData, floodFillSelection, getImageDataFromClipboard, getSupportedPixelFormats, hardLightColor32, hardMixColor32, imageDataToAlphaMask, imageDataToDataUrl, imageDataToImgBlob, imgBlobToImageData, indexedImageToAverageColor, invertAlphaMask, invertBinaryMask, invertImageData, invertPixelData, lerpColor32, lerpColor32Fast, lightenColor32, lighterColor32, linearBurnColor32, linearDodgeColor32, linearLightColor32, makeIndexedImage, makePixelCanvas, makeReusableCanvas, mergeMasks, multiplyColor32, overlayColor32, overwriteColor32, packColor, packRGBA, pinLightColor32, pixelDataToAlphaMask, resizeImageData, screenColor32, serializeImageData, serializeNullableImageData, softLightColor32, sourceOverColor32, subtractColor32, trimRectBounds, unpackAlpha, unpackBlue, unpackColor, unpackColorTo, unpackGreen, unpackRed, vividLightColor32, writeImageDataPixels, writeImageDataToClipboard, writeImgBlobToClipboard };

package/dist/index.prod.js

@@ -1122,6 +1122,48 @@ function makeIndexedImage(imageData) {
   };
 }
 
+// src/IndexedImage/indexedImageToAverageColor.ts
+function indexedImageToAverageColor(indexedImage, includeTransparent = false) {
+  const { data, palette, transparentPalletIndex } = indexedImage;
+  const counts = new Uint32Array(palette.length / 4);
+  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 r2 = palette[pIdx];
+    const g2 = palette[pIdx + 1];
+    const b2 = palette[pIdx + 2];
+    const a2 = palette[pIdx + 3];
+    rSum += r2 * weight;
+    gSum += g2 * weight;
+    bSum += b2 * weight;
+    aSum += a2 * 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);
+}
+
 // src/Input/fileInputChangeToImageData.ts
 async function fileInputChangeToImageData(event) {
   const target = event.target;
@@ -1291,7 +1333,7 @@ function mergeMasks(dst, dstWidth, src, opts) {
   }
 }
 
-// src/PixelData.ts
+// src/PixelData/PixelData.ts
 var PixelData = class {
   constructor(imageData) {
     this.imageData = imageData;
@@ -1744,6 +1786,7 @@ export {
   imageDataToDataUrl,
   imageDataToImgBlob,
   imgBlobToImageData,
+  indexedImageToAverageColor,
   invertAlphaMask,
   invertBinaryMask,
   invertImageData,