pixel-data-js 0.12.0 → 0.13.0

package/dist/index.prod.d.ts

@@ -15,7 +15,10 @@ type Color32 = number & {
  * @param dst - The existing color in the buffer (destination).
  * @returns The resulting 32-bit color to be written to the buffer.
  */
-type BlendColor32 = (src: Color32, dst: Color32) => Color32;
+type BlendColor32 = {
+    (src: Color32, dst: Color32): Color32;
+    isOverwrite?: true;
+};
 type ImageDataLike = {
     width: number;
     height: number;
@@ -108,7 +111,7 @@ interface PixelOptions {
     /** An optional mask to restrict where pixels are written. */
     mask?: AnyMask | null;
     /** The interpretation logic for the provided mask.
-     * @default {@link MaskType.BINARY}
+     * @default {@link MaskType.ALPHA}
      */
     maskType?: MaskType;
     /**
@@ -481,6 +484,15 @@ declare function writeImageDataToClipboard(imageData: ImageData): Promise<void>;
  */
 declare function writeImgBlobToClipboard(blob: Blob): Promise<void>;
 
+type ReusableImageData = ReturnType<typeof makeReusableImageData>;
+/**
+ * Creates a factory function that manages a single, reusable ImageData instance.
+ * This is used to minimize garbage collection overhead by recycling the
+ * underlying pixel buffer across multiple operations.
+ * @returns A function that takes width and height and returns a pooled ImageData instance.
+ */
+declare function makeReusableImageData(): (width: number, height: number) => ImageData;
+
 declare function copyImageData({ data, width, height }: ImageDataLike): ImageData;
 declare function copyImageDataLike({ data, width, height }: ImageDataLike): ImageDataLike;
 
@@ -630,6 +642,22 @@ declare function deserializeRawImageData<T extends SerializedImageData>(serializ
 declare function deserializeImageData<T extends SerializedImageData>(serialized: T): ImageData;
 declare function deserializeNullableImageData<T extends SerializedImageData | null>(serialized: T): T extends null ? null : ImageData;
 
+/**
+ * Writes image data from a source to a target with support for clipping and alpha masking.
+ *
+ * @param target - The destination ImageData to write to.
+ * @param source - The source ImageData to read from.
+ * @param x - The x-coordinate in the target where drawing starts.
+ * @param y - The y-coordinate in the target where drawing starts.
+ * @param sx - The x-coordinate in the source to start copying from.
+ * @param sy - The y-coordinate in the source to start copying from.
+ * @param sw - The width of the rectangle to copy.
+ * @param sh - The height of the rectangle to copy.
+ * @param mask - An optional Uint8Array mask (0-255). 0 is transparent, 255 is opaque.
+ * @param maskType - type of mask
+ */
+declare function writeImageData(target: ImageData, source: ImageData, x: number, y: number, sx?: number, sy?: number, sw?: number, sh?: number, mask?: Uint8Array | null, maskType?: MaskType): void;
+
 /**
  * Copies a pixel buffer into a specific region of an {@link ImageData} object.
  *
@@ -652,22 +680,6 @@ declare function writeImageDataPixels(imageData: ImageData, data: Uint8ClampedAr
  */
 declare function writeImageDataPixels(imageData: ImageData, data: Uint8ClampedArray, x: number, y: number, w: number, h: number): void;
 
-/**
- * Writes image data from a source to a target with support for clipping and alpha masking.
- *
- * @param target - The destination ImageData to write to.
- * @param source - The source ImageData to read from.
- * @param x - The x-coordinate in the target where drawing starts.
- * @param y - The y-coordinate in the target where drawing starts.
- * @param sx - The x-coordinate in the source to start copying from.
- * @param sy - The y-coordinate in the source to start copying from.
- * @param sw - The width of the rectangle to copy.
- * @param sh - The height of the rectangle to copy.
- * @param mask - An optional Uint8Array mask (0-255). 0 is transparent, 255 is opaque.
- * @param maskType - type of mask
- */
-declare function writeImageData(target: ImageData, source: ImageData, x: number, y: number, sx?: number, sy?: number, sw?: number, sh?: number, mask?: Uint8Array | null, maskType?: MaskType): void;
-
 /**
  * Represents an image using a palette-based indexing system.
  * Instead of storing 4 bytes (RGBA) per pixel, this class stores a single index
@@ -889,7 +901,7 @@ declare function applyMaskToPixelData(dst: PixelData, mask: AnyMask, opts: Apply
  * Fills a rectangle in the destination PixelData with a single color,
  * supporting blend modes, global alpha, and masking.
  */
-declare function blendColorPixelData(dst: PixelData, color: Color32, opts: ColorBlendOptions): void;
+declare function blendColorPixelData(dst: PixelData, color: Color32, opts?: ColorBlendOptions): void;
 
 /**
  * Blits source PixelData into a destination PixelData using 32-bit integer bitwise blending.
@@ -977,4 +989,4 @@ declare function rotatePixelData(pixelData: PixelData): void;
  */
 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, type BlendToIndexGetter, type Color32, type ColorBlendOptions, FAST_BLENDER_REGISTRY, FAST_BLEND_MODES, FAST_BLEND_MODE_BY_NAME, FAST_BLEND_TO_INDEX, type FastBlendModes, type FloodFillImageDataOptions, type FloodFillResult, INDEX_TO_FAST_BLEND, INDEX_TO_PERFECT_BLEND, type ImageDataLike, type IndexToBlendGetter, IndexedImage, MaskType, PERFECT_BLENDER_REGISTRY, PERFECT_BLEND_MODES, PERFECT_BLEND_MODE_BY_NAME, PERFECT_BLEND_TO_INDEX, type PerfectBlendModes, type PixelBlendOptions, type PixelCanvas, PixelData, type PixelOptions, type Point, type RGBA, type Rect, type RegisteredFastBlender, type RegisteredPerfectBlender, type ReusableCanvas, type SelectionRect, type SerializedImageData, UnsupportedFormatError, applyMaskToPixelData, base64DecodeArrayBuffer, base64EncodeArrayBuffer, blendColorPixelData, blendPixelData, clearPixelData, color32ToCssRGBA, color32ToHex, colorBurnFast, colorBurnPerfect, colorDistance, colorDodgeFast, colorDodgePerfect, copyImageData, copyImageDataLike, copyMask, darkenFast, darkenPerfect, darkerFast, darkerPerfect, deserializeImageData, deserializeNullableImageData, deserializeRawImageData, differenceFast, differencePerfect, divideFast, dividePerfect, exclusionFast, exclusionPerfect, extractImageDataPixels, extractMask, fileInputChangeToImageData, fileToImageData, fillPixelData, floodFillSelection, getImageDataFromClipboard, getIndexedImageColorCounts, getSupportedPixelFormats, hardLightFast, hardLightPerfect, hardMixFast, hardMixPerfect, imageDataToAlphaMask, imageDataToDataUrl, imageDataToImgBlob, imgBlobToImageData, indexedImageToAverageColor, indexedImageToImageData, invertAlphaMask, invertBinaryMask, invertImageData, invertPixelData, lerpColor32, lerpColor32Fast, lightenFast, lightenPerfect, lighterFast, lighterPerfect, linearBurnFast, linearBurnPerfect, linearDodgeFast, linearDodgePerfect, linearLightFast, linearLightPerfect, makePixelCanvas, makeReusableCanvas, mergeMasks, multiplyFast, multiplyPerfect, overlayFast, overlayPerfect, overwriteFast, overwritePerfect, packColor, packRGBA, pinLightFast, pinLightPerfect, pixelDataToAlphaMask, reflectPixelDataHorizontal, reflectPixelDataVertical, resampleImageData, resampleIndexedImage, resamplePixelData, resizeImageData, rotatePixelData, screenFast, screenPerfect, serializeImageData, serializeNullableImageData, softLightFast, softLightPerfect, sourceOverFast, sourceOverPerfect, subtractFast, subtractPerfect, trimRectBounds, unpackAlpha, unpackBlue, unpackColor, unpackColorTo, unpackGreen, unpackRed, vividLightFast, vividLightPerfect, writeImageData, writeImageDataPixels, writeImageDataToClipboard, writeImgBlobToClipboard };
+export { type AlphaMask, type AnyMask, type ApplyMaskOptions, type Base64EncodedUInt8Array, type BinaryMask, type BlendColor32, BlendMode, type BlendModeIndex, type BlendToIndexGetter, type Color32, type ColorBlendOptions, FAST_BLENDER_REGISTRY, FAST_BLEND_MODES, FAST_BLEND_MODE_BY_NAME, FAST_BLEND_TO_INDEX, type FastBlendModes, type FloodFillImageDataOptions, type FloodFillResult, INDEX_TO_FAST_BLEND, INDEX_TO_PERFECT_BLEND, type ImageDataLike, type IndexToBlendGetter, IndexedImage, MaskType, PERFECT_BLENDER_REGISTRY, PERFECT_BLEND_MODES, PERFECT_BLEND_MODE_BY_NAME, PERFECT_BLEND_TO_INDEX, type PerfectBlendModes, type PixelBlendOptions, type PixelCanvas, PixelData, type PixelOptions, type Point, type RGBA, type Rect, type RegisteredFastBlender, type RegisteredPerfectBlender, type ReusableCanvas, type ReusableImageData, type SelectionRect, type SerializedImageData, UnsupportedFormatError, applyMaskToPixelData, base64DecodeArrayBuffer, base64EncodeArrayBuffer, blendColorPixelData, blendPixelData, clearPixelData, color32ToCssRGBA, color32ToHex, colorBurnFast, colorBurnPerfect, colorDistance, colorDodgeFast, colorDodgePerfect, copyImageData, copyImageDataLike, copyMask, darkenFast, darkenPerfect, darkerFast, darkerPerfect, deserializeImageData, deserializeNullableImageData, deserializeRawImageData, differenceFast, differencePerfect, divideFast, dividePerfect, exclusionFast, exclusionPerfect, extractImageDataPixels, extractMask, fileInputChangeToImageData, fileToImageData, fillPixelData, floodFillSelection, getImageDataFromClipboard, getIndexedImageColorCounts, getSupportedPixelFormats, hardLightFast, hardLightPerfect, hardMixFast, hardMixPerfect, imageDataToAlphaMask, imageDataToDataUrl, imageDataToImgBlob, imgBlobToImageData, indexedImageToAverageColor, indexedImageToImageData, invertAlphaMask, invertBinaryMask, invertImageData, invertPixelData, lerpColor32, lerpColor32Fast, lightenFast, lightenPerfect, lighterFast, lighterPerfect, linearBurnFast, linearBurnPerfect, linearDodgeFast, linearDodgePerfect, linearLightFast, linearLightPerfect, makePixelCanvas, makeReusableCanvas, makeReusableImageData, mergeMasks, multiplyFast, multiplyPerfect, overlayFast, overlayPerfect, overwriteFast, overwritePerfect, packColor, packRGBA, pinLightFast, pinLightPerfect, pixelDataToAlphaMask, reflectPixelDataHorizontal, reflectPixelDataVertical, resampleImageData, resampleIndexedImage, resamplePixelData, resizeImageData, rotatePixelData, screenFast, screenPerfect, serializeImageData, serializeNullableImageData, softLightFast, softLightPerfect, sourceOverFast, sourceOverPerfect, subtractFast, subtractPerfect, trimRectBounds, unpackAlpha, unpackBlue, unpackColor, unpackColorTo, unpackGreen, unpackRed, vividLightFast, vividLightPerfect, writeImageData, writeImageDataPixels, writeImageDataToClipboard, writeImgBlobToClipboard };

package/dist/index.prod.js

@@ -25,9 +25,11 @@ var BlendMode = /* @__PURE__ */ ((BlendMode2) => {
   BlendMode2[BlendMode2["divide"] = 22] = "divide";
   return BlendMode2;
 })(BlendMode || {});
+var overwriteBase = (src, _dst) => src;
+overwriteBase.isOverwrite = true;
 
 // src/BlendModes/blend-modes-fast.ts
-var overwriteFast = (src, _dst) => src;
+var overwriteFast = overwriteBase;
 var sourceOverFast = (src, dst) => {
   const sa = src >>> 24 & 255;
   if (sa === 255) return src;
@@ -842,7 +844,7 @@ function floodFillSelection(img, startX, startY, {
 }
 
 // src/BlendModes/blend-modes-perfect.ts
-var overwritePerfect = (src, _dst) => src;
+var overwritePerfect = overwriteBase;
 var sourceOverPerfect = (src, dst) => {
   const sa = src >>> 24 & 255;
   if (sa === 255) return src;
@@ -1425,6 +1427,22 @@ async function writeImageDataToClipboard(imageData) {
   return writeImgBlobToClipboard(blob);
 }
 
+// src/ImageData/ReusableImageData.ts
+function makeReusableImageData() {
+  let imageData = null;
+  let buffer = null;
+  return function getReusableImageData(width, height) {
+    const hasInstance = !!imageData;
+    const widthMatches = hasInstance && imageData.width === width;
+    const heightMatches = hasInstance && imageData.height === height;
+    if (!widthMatches || !heightMatches) {
+      const buffer2 = new Uint8ClampedArray(width * height * 4);
+      imageData = new ImageData(buffer2, width, height);
+    }
+    return imageData;
+  };
+}
+
 // src/ImageData/copyImageData.ts
 function copyImageData({ data, width, height }) {
   return new ImageData(data.slice(), width, height);
@@ -1604,27 +1622,6 @@ function deserializeNullableImageData(serialized) {
   return deserializeImageData(serialized);
 }
 
-// src/ImageData/writeImageDataPixels.ts
-function writeImageDataPixels(imageData, data, _x, _y, _w, _h) {
-  const { x, y, w, h } = typeof _x === "object" ? _x : { x: _x, y: _y, w: _w, h: _h };
-  const { width: dstW, height: dstH, data: dst } = imageData;
-  const x0 = Math.max(0, x);
-  const y0 = Math.max(0, y);
-  const x1 = Math.min(dstW, x + w);
-  const y1 = Math.min(dstH, y + h);
-  if (x1 <= x0 || y1 <= y0) return;
-  const rowLen = (x1 - x0) * 4;
-  const srcCol = x0 - x;
-  const srcYOffset = y0 - y;
-  const actualH = y1 - y0;
-  for (let row = 0; row < actualH; row++) {
-    const dstStart = ((y0 + row) * dstW + x0) * 4;
-    const srcRow = srcYOffset + row;
-    const o = (srcRow * w + srcCol) * 4;
-    dst.set(data.subarray(o, o + rowLen), dstStart);
-  }
-}
-
 // src/ImageData/writeImageData.ts
 function writeImageData(target, source, x, y, sx = 0, sy = 0, sw = source.width, sh = source.height, mask = null, maskType = 1 /* BINARY */) {
   const dstW = target.width;
@@ -1679,6 +1676,27 @@ function writeImageData(target, source, x, y, sx = 0, sy = 0, sw = source.width,
   }
 }
 
+// src/ImageData/writeImageDataPixels.ts
+function writeImageDataPixels(imageData, data, _x, _y, _w, _h) {
+  const { x, y, w, h } = typeof _x === "object" ? _x : { x: _x, y: _y, w: _w, h: _h };
+  const { width: dstW, height: dstH, data: dst } = imageData;
+  const x0 = Math.max(0, x);
+  const y0 = Math.max(0, y);
+  const x1 = Math.min(dstW, x + w);
+  const y1 = Math.min(dstH, y + h);
+  if (x1 <= x0 || y1 <= y0) return;
+  const rowLen = (x1 - x0) * 4;
+  const srcCol = x0 - x;
+  const srcYOffset = y0 - y;
+  const actualH = y1 - y0;
+  for (let row = 0; row < actualH; row++) {
+    const dstStart = ((y0 + row) * dstW + x0) * 4;
+    const srcRow = srcYOffset + row;
+    const o = (srcRow * w + srcCol) * 4;
+    dst.set(data.subarray(o, o + rowLen), dstStart);
+  }
+}
+
 // src/IndexedImage/IndexedImage.ts
 var IndexedImage = class _IndexedImage {
   /** The width of the image in pixels. */
@@ -2131,14 +2149,14 @@ function applyMaskToPixelData(dst, mask, opts) {
 }
 
 // src/PixelData/blendColorPixelData.ts
-function blendColorPixelData(dst, color, opts) {
+function blendColorPixelData(dst, color, opts = {}) {
   const {
     x: targetX = 0,
     y: targetY = 0,
     w: width = dst.width,
     h: height = dst.height,
     alpha: globalAlpha = 255,
-    blendFn = FAST_BLEND_MODES[1 /* sourceOver */],
+    blendFn = sourceOverFast,
     mask,
     maskType = 0 /* ALPHA */,
     mw,
@@ -2147,6 +2165,9 @@ function blendColorPixelData(dst, color, opts) {
     invertMask = false
   } = opts;
   if (globalAlpha === 0) return;
+  const baseSrcAlpha = color >>> 24;
+  const isOverwrite = blendFn.isOverwrite;
+  if (baseSrcAlpha === 0 && !isOverwrite) return;
   let x = targetX;
   let y = targetY;
   let w = width;
@@ -2172,15 +2193,8 @@ function blendColorPixelData(dst, color, opts) {
   let mIdx = (my + dy) * mPitch + (mx + dx);
   const dStride = dw - actualW;
   const mStride = mPitch - actualW;
-  const baseSrcColor = color;
-  const baseSrcAlpha = baseSrcColor >>> 24;
   for (let iy = 0; iy < actualH; iy++) {
     for (let ix = 0; ix < actualW; ix++) {
-      if (baseSrcAlpha === 0) {
-        dIdx++;
-        mIdx++;
-        continue;
-      }
       let weight = globalAlpha;
       if (mask) {
         const mVal = mask[mIdx];
@@ -2213,20 +2227,20 @@ function blendColorPixelData(dst, color, opts) {
           continue;
         }
       }
-      let currentSrcAlpha = baseSrcAlpha;
-      let currentSrcColor = baseSrcColor;
+      let currentSrcColor = color;
       if (weight < 255) {
+        let currentSrcAlpha = baseSrcAlpha;
         if (baseSrcAlpha === 255) {
           currentSrcAlpha = weight;
         } else {
           currentSrcAlpha = baseSrcAlpha * weight + 128 >> 8;
         }
-        if (currentSrcAlpha === 0) {
+        if (!isOverwrite && currentSrcAlpha === 0) {
           dIdx++;
           mIdx++;
           continue;
         }
-        currentSrcColor = (baseSrcColor & 16777215 | currentSrcAlpha << 24) >>> 0;
+        currentSrcColor = (color & 16777215 | currentSrcAlpha << 24) >>> 0;
       }
       dst32[dIdx] = blendFn(currentSrcColor, dst32[dIdx]);
       dIdx++;
@@ -2301,11 +2315,12 @@ function blendPixelData(dst, src, opts) {
   const dStride = dw - actualW;
   const sStride = sw - actualW;
   const mStride = mPitch - actualW;
+  const isOverwrite = blendFn.isOverwrite;
   for (let iy = 0; iy < actualH; iy++) {
     for (let ix = 0; ix < actualW; ix++) {
       const baseSrcColor = src32[sIdx];
       const baseSrcAlpha = baseSrcColor >>> 24;
-      if (baseSrcAlpha === 0) {
+      if (baseSrcAlpha === 0 && !isOverwrite) {
         dIdx++;
         sIdx++;
         mIdx++;
@@ -2346,15 +2361,15 @@ function blendPixelData(dst, src, opts) {
           continue;
         }
       }
-      let currentSrcAlpha = baseSrcAlpha;
       let currentSrcColor = baseSrcColor;
       if (weight < 255) {
+        let currentSrcAlpha = baseSrcAlpha;
         if (baseSrcAlpha === 255) {
           currentSrcAlpha = weight;
         } else {
           currentSrcAlpha = baseSrcAlpha * weight + 128 >> 8;
         }
-        if (currentSrcAlpha === 0) {
+        if (!isOverwrite && currentSrcAlpha === 0) {
           dIdx++;
           sIdx++;
           mIdx++;
@@ -2605,6 +2620,7 @@ export {
   linearLightPerfect,
   makePixelCanvas,
   makeReusableCanvas,
+  makeReusableImageData,
   mergeMasks,
   multiplyFast,
   multiplyPerfect,