pixel-data-js 0.23.0 → 0.24.0

package/src/PixelData/blendColorPixelDataBinaryMask.ts

@@ -12,13 +12,14 @@ import { sourceOverPerfect } from '../BlendModes/blend-modes-perfect'
  * @param color - The solid color to apply.
  * @param mask - The mask defining the per-pixel opacity of the target area.
  * @param opts - Configuration options including placement coordinates, bounds, global alpha, and mask offsets.
+ * @returns true if any pixels were actually modified.
  */
 export function blendColorPixelDataBinaryMask(
   dst: IPixelData,
   color: Color32,
   mask: BinaryMask,
   opts: ColorBlendMaskOptions = {},
-) {
+): boolean {
   const targetX = opts.x ?? 0
   const targetY = opts.y ?? 0
   let w = opts.w ?? mask.w
@@ -29,12 +30,12 @@ export function blendColorPixelDataBinaryMask(
   const my = opts.my ?? 0
   const invertMask = opts.invertMask ?? false
 
-  if (globalAlpha === 0) return
+  if (globalAlpha === 0) return false
 
   const baseSrcAlpha = (color >>> 24)
   const isOverwrite = (blendFn as any).isOverwrite || false
 
-  if (baseSrcAlpha === 0 && !isOverwrite) return
+  if (baseSrcAlpha === 0 && !isOverwrite) return false
 
   let x = targetX
   let y = targetY
@@ -52,19 +53,18 @@ export function blendColorPixelDataBinaryMask(
   const actualW = Math.min(w, dst.width - x)
   const actualH = Math.min(h, dst.height - y)
 
-  if (actualW <= 0 || actualH <= 0) return
+  if (actualW <= 0 || actualH <= 0) return false
 
   let baseColorWithGlobalAlpha = color
 
   if (globalAlpha < 255) {
     const a = (baseSrcAlpha * globalAlpha + 128) >> 8
-    if (a === 0 && !isOverwrite) return
+    if (a === 0 && !isOverwrite) return false
     baseColorWithGlobalAlpha = ((color & 0x00ffffff) | (a << 24)) >>> 0 as Color32
   }
 
   const dx = (x - targetX) | 0
   const dy = (y - targetY) | 0
-
   const dst32 = dst.data32
   const dw = dst.width
   const mPitch = mask.w
@@ -75,6 +75,7 @@ export function blendColorPixelDataBinaryMask(
   const dStride = (dw - actualW) | 0
   const mStride = (mPitch - actualW) | 0
   const skipVal = invertMask ? 1 : 0
+  let didChange = false
 
   for (let iy = 0; iy < actualH; iy++) {
     for (let ix = 0; ix < actualW; ix++) {
@@ -84,7 +85,13 @@ export function blendColorPixelDataBinaryMask(
         continue
       }
 
-      dst32[dIdx] = blendFn(baseColorWithGlobalAlpha, dst32[dIdx] as Color32)
+      const current = dst32[dIdx] as Color32
+      const next = blendFn(baseColorWithGlobalAlpha, current)
+
+      if (current !== next) {
+        dst32[dIdx] = next
+        didChange = true
+      }
 
       dIdx++
       mIdx++
@@ -93,4 +100,6 @@ export function blendColorPixelDataBinaryMask(
     dIdx += dStride
     mIdx += mStride
   }
+
+  return didChange
 }

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

@@ -1,6 +1,6 @@
 import {
   type BlendColor32,
-  type CircleBrushMask,
+  type CircleMask,
   type Color32,
   type ColorBlendMaskOptions,
   type IPixelData,
@@ -13,7 +13,7 @@ import { blendColorPixelDataAlphaMask } from './blendColorPixelDataAlphaMask'
 import { blendColorPixelDataBinaryMask } from './blendColorPixelDataBinaryMask'
 
 /**
- * Applies a circular brush to pixel data using a pre-calculated alpha mask.
+ * Applies a circular mask to pixel data using a pre-calculated alpha mask.
  *
  * @param target The PixelData to modify.
  * @param color The brush color.
@@ -25,17 +25,17 @@ import { blendColorPixelDataBinaryMask } from './blendColorPixelDataBinaryMask'
  * @param scratchOptions
  * @param bounds precalculated result from {@link getCircleBrushOrPencilBounds}
  */
-export function applyCircleBrushToPixelData(
+export function blendColorPixelDataCircleMask(
   target: IPixelData,
   color: Color32,
   centerX: number,
   centerY: number,
-  brush: CircleBrushMask,
+  brush: CircleMask,
   alpha = 255,
   blendFn: BlendColor32 = sourceOverPerfect,
   scratchOptions: ColorBlendMaskOptions = {},
   bounds?: Rect,
-): void {
+): boolean {
   const b = bounds ?? getCircleBrushOrPencilBounds(
     centerX,
     centerY,
@@ -44,7 +44,7 @@ export function applyCircleBrushToPixelData(
     target.height,
   )
 
-  if (b.w <= 0 || b.h <= 0) return
+  if (b.w <= 0 || b.h <= 0) return false
 
   const unclippedStartX = Math.floor(centerX + brush.minOffset)
   const unclippedStartY = Math.floor(centerY + brush.minOffset)
@@ -59,9 +59,8 @@ export function applyCircleBrushToPixelData(
   const ih = ib - iy
 
   // If the mask falls entirely outside the bounds, exit
-  if (iw <= 0 || ih <= 0) return
+  if (iw <= 0 || ih <= 0) return false
 
-  // Apply the intersected coordinates and internal mask offsets
   scratchOptions.x = ix
   scratchOptions.y = iy
   scratchOptions.w = iw
@@ -72,7 +71,7 @@ export function applyCircleBrushToPixelData(
   scratchOptions.blendFn = blendFn
 
   if (brush.type === MaskType.ALPHA) {
-    blendColorPixelDataAlphaMask(
+    return blendColorPixelDataAlphaMask(
       target,
       color,
       brush,
@@ -81,11 +80,13 @@ export function applyCircleBrushToPixelData(
   }
 
   if (brush.type === MaskType.BINARY) {
-    blendColorPixelDataBinaryMask(
+    return blendColorPixelDataBinaryMask(
       target,
       color,
       brush,
       scratchOptions,
     )
   }
+
+  return false
 }

package/src/PixelData/blendPixel.ts

@@ -0,0 +1,47 @@
+import type { BlendColor32, Color32, IPixelData } from '../_types'
+import { sourceOverPerfect } from '../BlendModes/blend-modes-perfect'
+
+export function blendPixel(
+  target: IPixelData,
+  x: number,
+  y: number,
+  color: Color32,
+  alpha: number = 255,
+  blendFn: BlendColor32 = sourceOverPerfect,
+): boolean {
+  if (alpha === 0) return false
+
+  let width = target.width
+  let height = target.height
+
+  if (x < 0 || x >= width || y < 0 || y >= height) return false
+
+  let srcAlpha = color >>> 24
+  let isOverwrite = blendFn.isOverwrite
+
+  // Early exit for transparent source unless we are in an overwrite mode
+  if (srcAlpha === 0 && !isOverwrite) return false
+
+  let dst32 = target.data32
+  let index = y * width + x
+  let finalColor = color
+
+  if (alpha !== 255) {
+    let finalAlpha = (srcAlpha * alpha + 128) >> 8
+
+    if (finalAlpha === 0 && !isOverwrite) return false
+
+    finalColor = (((color & 0x00ffffff) | (finalAlpha << 24)) >>> 0) as Color32
+  }
+
+  let current = dst32[index] as Color32
+  let next = blendFn(finalColor, current)
+
+  if (current !== next) {
+    dst32[index] = next
+
+    return true
+  }
+
+  return false
+}

package/src/PixelData/blendPixelData.ts

@@ -19,7 +19,7 @@ export function blendPixelData(
   dst: IPixelData,
   src: IPixelData,
   opts: PixelBlendOptions = {},
-) {
+): boolean {
   const {
     x: targetX = 0,
     y: targetY = 0,
@@ -31,7 +31,7 @@ export function blendPixelData(
     blendFn = sourceOverPerfect,
   } = opts
 
-  if (globalAlpha === 0) return
+  if (globalAlpha === 0) return false
 
   let x = targetX
   let y = targetY
@@ -65,7 +65,7 @@ export function blendPixelData(
 
   const actualW = Math.min(w, dst.width - x)
   const actualH = Math.min(h, dst.height - y)
-  if (actualW <= 0 || actualH <= 0) return
+  if (actualW <= 0 || actualH <= 0) return false
 
   const dst32 = dst.data32
   const src32 = src.data32
@@ -79,6 +79,7 @@ export function blendPixelData(
   const sStride = (sw - actualW) | 0
   const isOpaque = globalAlpha === 255
   const isOverwrite = blendFn.isOverwrite
+  let didChange = false
 
   for (let iy = 0; iy < actualH; iy++) {
     for (let ix = 0; ix < actualW; ix++) {
@@ -102,11 +103,20 @@ export function blendPixelData(
         finalCol = ((srcCol & 0x00ffffff) | (a << 24)) >>> 0 as Color32
       }
 
-      dst32[dIdx] = blendFn(finalCol, dst32[dIdx] as Color32)
+      const current = dst32[dIdx] as Color32
+      const next = blendFn(finalCol, dst32[dIdx] as Color32)
+
+      if (current !== next) {
+        dst32[dIdx] = next
+        didChange = true
+      }
+
       dIdx++
       sIdx++
     }
     dIdx += dStride
     sIdx += sStride
   }
+
+  return didChange
 }

package/src/PixelData/blendPixelDataAlphaMask.ts

@@ -6,7 +6,7 @@ export function blendPixelDataAlphaMask(
   src: IPixelData,
   alphaMask: AlphaMask,
   opts: PixelBlendMaskOptions = {},
-) {
+): boolean {
   const {
     x: targetX = 0,
     y: targetY = 0,
@@ -21,7 +21,7 @@ export function blendPixelDataAlphaMask(
     invertMask = false,
   } = opts
 
-  if (globalAlpha === 0) return
+  if (globalAlpha === 0) return false
 
   let x = targetX
   let y = targetY
@@ -56,7 +56,7 @@ export function blendPixelDataAlphaMask(
 
   const actualW = Math.min(w, dst.width - x)
   const actualH = Math.min(h, dst.height - y)
-  if (actualW <= 0 || actualH <= 0) return
+  if (actualW <= 0 || actualH <= 0) return false
 
   // 2. Index Setup
   const dw = dst.width
@@ -82,6 +82,7 @@ export function blendPixelDataAlphaMask(
 
   const isOpaque = globalAlpha === 255
   const isOverwrite = blendFn.isOverwrite || false
+  let didChange = false
 
   for (let iy = 0; iy < actualH; iy++) {
     for (let ix = 0; ix < actualW; ix++) {
@@ -135,8 +136,13 @@ export function blendPixelDataAlphaMask(
         }
         finalCol = ((srcCol & 0x00ffffff) | (a << 24)) >>> 0 as Color32
       }
+      const current = dst32[dIdx] as Color32
+      const next = blendFn(finalCol, dst32[dIdx] as Color32)
 
-      dst32[dIdx] = blendFn(finalCol, dst32[dIdx] as Color32)
+      if (current !== next) {
+        dst32[dIdx] = next
+        didChange = true
+      }
 
       dIdx++
       sIdx++
@@ -146,4 +152,6 @@ export function blendPixelDataAlphaMask(
     sIdx += sStride
     mIdx += mStride
   }
+
+  return didChange
 }

package/src/PixelData/blendPixelDataBinaryMask.ts

@@ -6,7 +6,7 @@ export function blendPixelDataBinaryMask(
   src: IPixelData,
   binaryMask: BinaryMask,
   opts: PixelBlendMaskOptions = {},
-) {
+): boolean {
   const {
     x: targetX = 0,
     y: targetY = 0,
@@ -21,7 +21,7 @@ export function blendPixelDataBinaryMask(
     invertMask = false,
   } = opts
 
-  if (globalAlpha === 0) return
+  if (globalAlpha === 0) return false
 
   let x = targetX
   let y = targetY
@@ -59,7 +59,7 @@ export function blendPixelDataBinaryMask(
   const actualW = Math.min(w, dst.width - x)
   const actualH = Math.min(h, dst.height - y)
 
-  if (actualW <= 0 || actualH <= 0) return
+  if (actualW <= 0 || actualH <= 0) return false
 
   // 3. Coordinate Displacement for Mask Sync
   // dx/dy represents how far the clipped start is from the requested start.
@@ -85,6 +85,7 @@ export function blendPixelDataBinaryMask(
   const skipVal = invertMask ? 1 : 0
   const isOpaque = globalAlpha === 255
   const isOverwrite = blendFn.isOverwrite || false
+  let didChange = false
 
   for (let iy = 0; iy < actualH; iy++) {
     for (let ix = 0; ix < actualW; ix++) {
@@ -120,7 +121,13 @@ export function blendPixelDataBinaryMask(
         finalCol = ((srcCol & 0x00ffffff) | (a << 24)) >>> 0 as Color32
       }
 
-      dst32[dIdx] = blendFn(finalCol, dst32[dIdx] as Color32)
+      const current = dst32[dIdx] as Color32
+      const next = blendFn(finalCol, dst32[dIdx] as Color32)
+
+      if (current !== next) {
+        dst32[dIdx] = next
+        didChange = true
+      }
 
       dIdx++
       sIdx++
@@ -130,4 +137,6 @@ export function blendPixelDataBinaryMask(
     sIdx += sStride
     mIdx += mStride
   }
+
+  return didChange
 }

package/src/PixelData/blendPixelDataPaintBuffer.ts

@@ -0,0 +1,37 @@
+import type { BlendColor32, IPixelData } from '../_types'
+import { blendPixelData } from './blendPixelData'
+import type { PaintBuffer } from '../PixelTile/PaintBuffer'
+
+const SCRATCH_OPTS = {
+  x: 0,
+  y: 0,
+  alpha: 255,
+  blendFn: undefined as BlendColor32 | undefined,
+}
+
+export function blendPixelDataPaintBuffer(
+  paintBuffer: PaintBuffer,
+  target: IPixelData,
+  alpha = 255,
+  blendFn?: BlendColor32,
+  blendPixelDataFn = blendPixelData,
+): void {
+  const tileShift = paintBuffer.config.tileShift
+  const lookup = paintBuffer.lookup
+  for (let i = 0; i < lookup.length; i++) {
+    const tile = lookup[i]
+
+    if (tile) {
+      const x = tile.tx << tileShift
+      const y = tile.ty << tileShift
+
+      SCRATCH_OPTS.x = x
+      SCRATCH_OPTS.y = y
+      SCRATCH_OPTS.alpha = alpha
+      SCRATCH_OPTS.blendFn = blendFn
+
+      blendPixelDataFn(target, tile, SCRATCH_OPTS)
+    }
+  }
+}
+

package/src/PixelData/clearPixelData.ts

@@ -1,5 +1,5 @@
 import type { BinaryMaskRect, Color32, IPixelData } from '../_types'
-import { fillPixelData } from './fillPixelData'
+import { fillPixelDataFast } from './fillPixelDataFast'
 
 /**
  * Clears a region of the PixelData to transparent (0x00000000).
@@ -9,5 +9,5 @@ export function clearPixelData(
   dst: IPixelData,
   rect?: Partial<BinaryMaskRect>,
 ): void {
-  fillPixelData(dst, 0 as Color32, rect)
+  fillPixelDataFast(dst, 0 as Color32, rect)
 }

package/src/PixelData/fillPixelData.ts

@@ -9,13 +9,13 @@ const SCRATCH_RECT = makeClippedRect()
  * @param dst - The target to modify.
  * @param color - The color to apply.
  * @param rect - Defines the area to fill. If omitted, the entire
- * buffer is filled.
+ * @returns true if any pixels were actually modified.
  */
 export function fillPixelData(
   dst: IPixelData,
   color: Color32,
   rect?: Partial<Rect>,
-): void
+): boolean
 /**
  * @param dst - The target to modify.
  * @param color - The color to apply.
@@ -31,7 +31,7 @@ export function fillPixelData(
   y: number,
   w: number,
   h: number,
-): void
+): boolean
 export function fillPixelData(
   dst: IPixelData,
   color: Color32,
@@ -39,7 +39,7 @@ export function fillPixelData(
   _y?: number,
   _w?: number,
   _h?: number,
-): void {
+): boolean {
   let x: number
   let y: number
   let w: number
@@ -62,11 +62,18 @@ export function fillPixelData(
     h = dst.height
   }
 
-  const clip = resolveRectClipping(x, y, w, h, dst.width, dst.height, SCRATCH_RECT)
+  const clip = resolveRectClipping(
+    x,
+    y,
+    w,
+    h,
+    dst.width,
+    dst.height,
+    SCRATCH_RECT,
+  )
 
-  if (!clip.inBounds) return
+  if (!clip.inBounds) return false
 
-  // Use the clipped values
   const {
     x: finalX,
     y: finalY,
@@ -76,17 +83,20 @@ export function fillPixelData(
 
   const dst32 = dst.data32
   const dw = dst.width
+  let hasChanged = false
 
-  // Optimization: If filling the entire buffer, use the native .fill()
-  if (actualW === dw && actualH === dst.height && finalX === 0 && finalY === 0) {
-    dst32.fill(color)
-    return
-  }
-
-  // Row-by-row fill for partial rectangles
   for (let iy = 0; iy < actualH; iy++) {
-    const start = (finalY + iy) * dw + finalX
+    const rowOffset = (finalY + iy) * dw
+    const start = rowOffset + finalX
     const end = start + actualW
-    dst32.fill(color, start, end)
+
+    for (let i = start; i < end; i++) {
+      if (dst32[i] !== color) {
+        dst32[i] = color
+        hasChanged = true
+      }
+    }
   }
+
+  return hasChanged
 }

package/src/PixelData/fillPixelDataBinaryMask.ts

@@ -19,8 +19,8 @@ export function fillPixelDataBinaryMask(
   alpha = 255,
   x = 0,
   y = 0,
-): void {
-  if (alpha === 0) return
+): boolean {
+  if (alpha === 0) return false
 
   const maskW = mask.w
   const maskH = mask.h
@@ -35,7 +35,7 @@ export function fillPixelDataBinaryMask(
     SCRATCH_RECT,
   )
 
-  if (!clip.inBounds) return
+  if (!clip.inBounds) return false
 
   const {
     x: finalX,
@@ -59,6 +59,8 @@ export function fillPixelDataBinaryMask(
     finalCol = ((colorRGB | (a << 24)) >>> 0) as Color32
   }
 
+  let hasChanged = false
+
   for (let iy = 0; iy < actualH; iy++) {
     const currentY = finalY + iy
     const maskY = currentY - y
@@ -72,8 +74,14 @@ export function fillPixelDataBinaryMask(
       const maskIndex = maskOffset + maskX
 
       if (maskData[maskIndex]) {
-        dst32[dstRowOffset + currentX] = finalCol
+        const current = dst32[dstRowOffset + currentX]
+        if (current !== finalCol) {
+          dst32[dstRowOffset + currentX] = finalCol
+          hasChanged = true
+        }
       }
     }
   }
+
+  return hasChanged
 }

package/src/PixelData/fillPixelDataFast.ts

@@ -0,0 +1,94 @@
+import type { Color32, IPixelData, Rect } from '../_types'
+import { makeClippedRect, resolveRectClipping } from '../Internal/resolveClipping'
+
+const SCRATCH_RECT = makeClippedRect()
+
+/**
+ * Fills a region or the {@link IPixelData} buffer with a solid color.
+ * This function is faster than {@link fillPixelData} but does not
+ * return a boolean value indicating changes were made.
+ *
+ * @param dst - The target to modify.
+ * @param color - The color to apply.
+ * @param rect - Defines the area to fill. If omitted, the entire
+ * buffer is filled.
+ */
+export function fillPixelDataFast(
+  dst: IPixelData,
+  color: Color32,
+  rect?: Partial<Rect>,
+): void
+/**
+ * @param dst - The target to modify.
+ * @param color - The color to apply.
+ * @param x - Starting horizontal coordinate.
+ * @param y - Starting vertical coordinate.
+ * @param w - Width of the fill area.
+ * @param h - Height of the fill area.
+ */
+export function fillPixelDataFast(
+  dst: IPixelData,
+  color: Color32,
+  x: number,
+  y: number,
+  w: number,
+  h: number,
+): void
+export function fillPixelDataFast(
+  dst: IPixelData,
+  color: Color32,
+  _x?: Partial<Rect> | number,
+  _y?: number,
+  _w?: number,
+  _h?: number,
+): void {
+  let x: number
+  let y: number
+  let w: number
+  let h: number
+
+  if (typeof _x === 'object') {
+    x = _x.x ?? 0
+    y = _x.y ?? 0
+    w = _x.w ?? dst.width
+    h = _x.h ?? dst.height
+  } else if (typeof _x === 'number') {
+    x = _x
+    y = _y!
+    w = _w!
+    h = _h!
+  } else {
+    x = 0
+    y = 0
+    w = dst.width
+    h = dst.height
+  }
+
+  const clip = resolveRectClipping(x, y, w, h, dst.width, dst.height, SCRATCH_RECT)
+
+  if (!clip.inBounds) return
+
+  // Use the clipped values
+  const {
+    x: finalX,
+    y: finalY,
+    w: actualW,
+    h: actualH,
+  } = clip
+
+  const dst32 = dst.data32
+  const dw = dst.width
+
+  // Optimization: If filling the entire buffer, use the native .fill()
+  if (actualW === dw && actualH === dst.height && finalX === 0 && finalY === 0) {
+    dst32.fill(color)
+    return
+  }
+
+  // Row-by-row fill for partial rectangles
+  for (let iy = 0; iy < actualH; iy++) {
+    const start = (finalY + iy) * dw + finalX
+    const end = start + actualW
+    dst32.fill(color, start, end)
+  }
+}

package/src/PixelData/invertPixelData.ts

@@ -6,7 +6,7 @@ const SCRATCH_RECT = makeClippedRect()
 export function invertPixelData(
   pixelData: IPixelData,
   opts: PixelMutateOptions = {},
-): void {
+): boolean {
   const dst = pixelData
   const {
     x: targetX = 0,
@@ -21,7 +21,7 @@ export function invertPixelData(
 
   const clip = resolveRectClipping(targetX, targetY, width, height, dst.width, dst.height, SCRATCH_RECT)
 
-  if (!clip.inBounds) return
+  if (!clip.inBounds) return false
 
   const {
     x,
@@ -72,4 +72,6 @@ export function invertPixelData(
       dIdx += dStride
     }
   }
+
+  return true
 }