pixel-data-js 0.25.2 → 0.26.0

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "pixel-data-js",
   "type": "module",
-  "version": "0.25.2",
-  "packageManager": "pnpm@10.30.0",
+  "version": "0.26.0",
+  "packageManager": "pnpm@10.33.0",
   "description": "JS Pixel and ImageData operations",
   "author": {
     "name": "Carl Olsen",
@@ -27,10 +27,6 @@
     ".": {
       "types": "./dist/index.prod.d.ts",
       "source": "./src/index.ts",
-      "development": {
-        "require": "./dist/index.dev.cjs",
-        "import": "./dist/index.dev.js"
-      },
       "production": {
         "require": "./dist/index.prod.cjs",
         "import": "./dist/index.prod.js"
@@ -49,6 +45,8 @@
   "scripts": {
     "build": "tsup",
     "test": "vitest --coverage --project unit",
+    "re-index": "tsx _scripts/re-index.ts",
+    "check": "npm run check-circ && npm run re-index && npm run sort && npm run typecheck",
     "test:build": "pnpm build && vitest run --project dist",
     "check-circ": "tsx _scripts/check-circular.ts",
     "test:mutation": "stryker run",
@@ -63,7 +61,7 @@
   "devDependencies": {
     "@clack/prompts": "^1.1.0",
     "@mitata/counters": "^0.0.8",
-    "@napi-rs/canvas": "^0.1.93",
+    "@napi-rs/canvas": "^0.1.97",
     "@stryker-mutator/core": "^9.5.1",
     "@stryker-mutator/typescript-checker": "^9.5.1",
     "@stryker-mutator/vitest-runner": "^9.5.1",
@@ -83,13 +81,14 @@
     "sanitize-filename": "^1.6.3",
     "sharp": "^0.34.5",
     "simple-git": "^3.33.0",
+    "source-map": "^0.7.6",
     "tsup": "^8.5.1",
     "tsx": "^4.21.0",
-    "typedoc": "^0.28.17",
+    "typedoc": "^0.28.18",
     "typedoc-plugin-mdn-links": "^5.1.1",
     "typedoc-rhineai-theme": "^1.2.0",
     "typescript": "^5.9.3",
-    "unplugin-inline": "^1.9.0",
+    "unplugin-inline": "^1.14.0",
     "vite-tsconfig-paths": "^6.1.1",
     "vitest": "3.2.4"
   },

package/src/Algorithm/floodFillSelection.ts

@@ -1,19 +1,12 @@
-import { type BinaryMaskRect, type Color32, type ImageDataLike, MaskType, type Rect } from '../_types'
+import { type BinaryMaskRect, type Color32, MaskType, type Rect } from '../_types'
 import { colorDistance } from '../color'
 import { extractImageDataBuffer } from '../ImageData/extractImageDataBuffer'
 import type { PixelData } from '../PixelData/PixelData'
 import { trimMaskRectBounds } from '../Rect/trimMaskRectBounds'
 
-export type FloodFillImageDataOptions = {
-  contiguous?: boolean
-  tolerance?: number
-  bounds?: Rect
-}
-
-export type FloodFillResult = {
+export type FloodFillResult = BinaryMaskRect & {
   startX: number
   startY: number
-  selectionRect: BinaryMaskRect
   pixels: Uint8ClampedArray
 }
 
@@ -23,16 +16,15 @@ export type FloodFillResult = {
  * color tolerance. It can operate in "contiguous" mode (classic bucket fill) or
  * "non-contiguous" mode (selects all matching pixels in the buffer).
  *
- * @param img - The source image data to process.
+ * @param target - The source image data to process.
  * @param startX - The starting horizontal coordinate.
  * @param startY - The starting vertical coordinate.
- * @param options - Configuration for the fill operation.
- * @param options.contiguous - If true, only connected pixels are
+ * @param contiguous - If true, only connected pixels are
  * selected. If false, all pixels within tolerance are selected regardless of position.
- * @param options.tolerance - The maximum allowed difference in color
+ * @param tolerance - The maximum allowed difference in color
  * distance (0-255) for a pixel to be included.
- * @param options.bounds - Optional bounding box to restrict the search area.
- *
+ * @param bounds - Optional bounding box to restrict the search area.
+ * @param out output object
  * @returns A {@link FloodFillResult} containing the mask and bounds of the selection,
  * or `null` if the starting coordinates are out of bounds.
  *
@@ -50,49 +42,33 @@ export type FloodFillResult = {
  * ```
  */
 export function floodFillSelection(
-  img: ImageDataLike | PixelData,
+  target: PixelData,
   startX: number,
   startY: number,
-  {
-    contiguous = true,
-    tolerance = 0,
-    bounds,
-  }: FloodFillImageDataOptions = {},
+  contiguous = true,
+  tolerance = 0,
+  bounds?: Rect,
+  out?: FloodFillResult,
 ): FloodFillResult | null {
 
-  let imageData: ImageDataLike
-  let data32: Uint32Array
-  if ('data32' in img) {
-    data32 = img.data32
-    imageData = img.imageData
-  } else {
-    data32 = new Uint32Array(
-      img.data.buffer,
-      img.data.byteOffset,
-      img.data.byteLength >> 2,
-    )
-    imageData = img
-  }
-  const {
-    width,
-    height,
-  } = img
-
-  const limit = bounds || {
-    x: 0,
-    y: 0,
-    w: width,
-    h: height,
-  }
+  const data32 = target.data32
+  const width = target.width
+  const height = target.height
+
+  const lx = bounds?.x ?? 0
+  const ly = bounds?.y ?? 0
+  const lw = bounds?.w ?? width
+  const lh = bounds?.h ?? height
 
-  const xMin = Math.max(0, limit.x)
-  const xMax = Math.min(width - 1, limit.x + limit.w - 1)
-  const yMin = Math.max(0, limit.y)
-  const yMax = Math.min(height - 1, limit.y + limit.h - 1)
+  const xMin = Math.max(0, lx)
+  const xMax = Math.min(width - 1, lx + lw - 1)
+  const yMin = Math.max(0, ly)
+  const yMax = Math.min(height - 1, ly + lh - 1)
 
   if (startX < xMin || startX > xMax || startY < yMin || startY > yMax) {
     return null
   }
+  out = out ?? {} as FloodFillResult
 
   const baseColor = data32[startY * width + startX] as Color32
 
@@ -178,50 +154,43 @@ export function floodFillSelection(
     }
   }
 
-  if (matchCount === 0) {
-    return null
-  }
+  if (matchCount === 0) return null
+
   const w = maxX - minX + 1
   const h = maxY - minY + 1
-  const selectionRect: BinaryMaskRect = {
-    x: minX,
-    y: minY,
-    w,
-    h,
-    data: new Uint8Array(w * h),
-    type: MaskType.BINARY,
-  }
 
-  const sw = selectionRect.w
-  const sh = selectionRect.h
-  const finalMask = selectionRect.data
+  out.startX = startX
+  out.startY = startY
+  out.x = minX
+  out.y = minY
+  out.w = w
+  out.h = h
+  out.data = new Uint8Array(w * h)
+  out.type = MaskType.BINARY
+
+  const finalMask = out.data
 
   for (let i = 0; i < matchCount; i++) {
-    const mx = matchX[i] - selectionRect.x
-    const my = matchY[i] - selectionRect.y
+    const mx = matchX[i] - minX
+    const my = matchY[i] - minY
 
-    if (mx >= 0 && mx < sw && my >= 0 && my < sh) {
-      finalMask[my * sw + mx] = 1
+    if (mx >= 0 && mx < w && my >= 0 && my < h) {
+      finalMask[my * w + mx] = 1
     }
   }
 
   trimMaskRectBounds(
-    selectionRect,
+    out,
     { x: 0, y: 0, w: width, h: height },
   )
 
-  const extracted = extractImageDataBuffer(
-    imageData,
-    selectionRect.x,
-    selectionRect.y,
-    selectionRect.w,
-    selectionRect.h,
+  out.pixels = extractImageDataBuffer(
+    target.imageData,
+    out.x,
+    out.y,
+    out.w,
+    out.h,
   )
 
-  return {
-    startX,
-    startY,
-    selectionRect,
-    pixels: extracted,
-  }
+  return out
 }

package/src/Canvas/PixelCanvas.ts

@@ -1,4 +1,4 @@
-import { CANVAS_CTX_FAILED } from './_constants'
+import { CANVAS_CTX_FAILED } from '../../support/error-strings'
 
 export type PixelCanvas = {
   readonly canvas: HTMLCanvasElement,

package/src/Canvas/ReusableCanvas.ts

@@ -1,4 +1,4 @@
-import { CANVAS_CTX_FAILED } from './_constants'
+import { CANVAS_CTX_FAILED } from '../../support/error-strings'
 
 export type CanvasContext<T> = T extends HTMLCanvasElement
   ? CanvasRenderingContext2D

package/src/History/HistoryAction.ts

@@ -1,5 +1,6 @@
+import type { PixelAccumulator } from './PixelAccumulator'
+import type { PixelEngineConfig } from './PixelEngineConfig'
 import { applyPatchTiles, type PixelPatchTiles } from './PixelPatchTiles'
-import type { PixelWriter } from './PixelWriter'
 
 export interface HistoryAction {
   undo: () => void
@@ -10,7 +11,8 @@ export interface HistoryAction {
 export type HistoryActionFactory = typeof makeHistoryAction
 
 export function makeHistoryAction(
-  writer: PixelWriter<any>,
+  config: PixelEngineConfig,
+  accumulator: PixelAccumulator,
   patch: PixelPatchTiles,
   after?: () => void,
   afterUndo?: () => void,
@@ -18,9 +20,8 @@ export function makeHistoryAction(
   applyPatchTilesFn = applyPatchTiles,
 ): HistoryAction {
 
-  const target = writer.config.target
-  const tileSize = writer.config.tileSize
-  const accumulator = writer.accumulator
+  const target = config.target
+  const tileSize = config.tileSize
 
   return {
     undo: () => {

package/src/History/PixelMutator/mutatorApplyAlphaMask.ts

@@ -1,6 +1,6 @@
-import { type AlphaMask, type ApplyMaskToPixelDataOptions, type HistoryMutator } from '../../_types'
+import { type AlphaMask, type ApplyMaskToPixelDataOptions } from '../../_types'
 import { applyAlphaMaskToPixelData } from '../../PixelData/applyAlphaMaskToPixelData'
-import { PixelWriter } from '../PixelWriter'
+import { type HistoryMutator, PixelWriter } from '../PixelWriter'
 
 const defaults = {
   applyAlphaMaskToPixelData,
@@ -17,14 +17,12 @@ export const mutatorApplyAlphaMask = ((writer: PixelWriter<any>, deps: Deps = de
   } = deps
 
   return {
-    applyAlphaMask(mask: AlphaMask, opts: ApplyMaskToPixelDataOptions = {}): boolean {
-      let target = writer.config.target
-      const {
-        x = 0,
-        y = 0,
-        w = target.width,
-        h = target.height,
-      } = opts
+    applyAlphaMask(mask: AlphaMask, opts?: ApplyMaskToPixelDataOptions): boolean {
+      const target = writer.config.target
+      const x = opts?.x ?? 0
+      const y = opts?.y ?? 0
+      const w = opts?.w ?? target.width
+      const h = opts?.h ?? target.height
 
       const didChange = writer.accumulator.storeRegionBeforeState(x, y, w, h)
       return didChange(applyAlphaMaskToPixelData(target, mask, opts))

package/src/History/PixelMutator/mutatorApplyBinaryMask.ts

@@ -1,6 +1,6 @@
-import { type ApplyMaskToPixelDataOptions, type BinaryMask, type HistoryMutator } from '../../_types'
+import { type ApplyMaskToPixelDataOptions, type BinaryMask } from '../../_types'
 import { applyBinaryMaskToPixelData } from '../../PixelData/applyBinaryMaskToPixelData'
-import { PixelWriter } from '../PixelWriter'
+import { type HistoryMutator, PixelWriter } from '../PixelWriter'
 
 const defaults = {
   applyBinaryMaskToPixelData,
@@ -17,14 +17,12 @@ export const mutatorApplyBinaryMask = ((writer: PixelWriter<any>, deps: Deps = d
   } = deps
 
   return {
-    applyBinaryMask(mask: BinaryMask, opts: ApplyMaskToPixelDataOptions = {}): boolean {
-      let target = writer.config.target
-      const {
-        x = 0,
-        y = 0,
-        w = target.width,
-        h = target.height,
-      } = opts
+    applyBinaryMask(mask: BinaryMask, opts?: ApplyMaskToPixelDataOptions): boolean {
+      const target = writer.config.target
+      const x = opts?.x ?? 0
+      const y = opts?.y ?? 0
+      const w = opts?.w ?? target.width
+      const h = opts?.h ?? target.height
 
       const didChange = writer.accumulator.storeRegionBeforeState(x, y, w, h)
       return didChange(applyBinaryMaskToPixelData(target, mask, opts))

package/src/History/PixelMutator/mutatorApplyMask.ts

@@ -0,0 +1,39 @@
+import { type ApplyMaskToPixelDataOptions, type Mask, MaskType } from '../../_types'
+import { applyAlphaMaskToPixelData } from '../../PixelData/applyAlphaMaskToPixelData'
+import { applyBinaryMaskToPixelData } from '../../PixelData/applyBinaryMaskToPixelData'
+import { type HistoryMutator, PixelWriter } from '../PixelWriter'
+
+const defaults = {
+  applyBinaryMaskToPixelData,
+  applyAlphaMaskToPixelData,
+}
+
+type Deps = Partial<typeof defaults>
+
+/**
+ * @param deps - @hidden
+ */
+export const mutatorApplyMask = ((writer: PixelWriter<any>, deps: Deps = defaults) => {
+  const {
+    applyBinaryMaskToPixelData = defaults.applyBinaryMaskToPixelData,
+    applyAlphaMaskToPixelData = defaults.applyAlphaMaskToPixelData,
+  } = deps
+
+  return {
+    applyMask(mask: Mask, opts?: ApplyMaskToPixelDataOptions): boolean {
+      const target = writer.config.target
+      const x = opts?.x ?? 0
+      const y = opts?.y ?? 0
+      const w = opts?.w ?? target.width
+      const h = opts?.h ?? target.height
+
+      const didChange = writer.accumulator.storeRegionBeforeState(x, y, w, h)
+
+      if (mask.type === MaskType.BINARY) {
+        return didChange(applyBinaryMaskToPixelData(target, mask, opts))
+      } else {
+        return didChange(applyAlphaMaskToPixelData(target, mask, opts))
+      }
+    },
+  }
+}) satisfies HistoryMutator<any, Deps>

package/src/History/PixelMutator/{mutatorBlendPixelDataAlphaMask.ts → mutatorBlendAlphaMask.ts}

@@ -1,6 +1,6 @@
-import type { AlphaMask, HistoryMutator, IPixelData32, PixelBlendMaskOptions } from '../../_types'
+import type { AlphaMask, IPixelData32, PixelBlendMaskOptions } from '../../_types'
 import { blendPixelDataAlphaMask } from '../../PixelData/blendPixelDataAlphaMask'
-import { PixelWriter } from '../PixelWriter'
+import { type HistoryMutator, PixelWriter } from '../PixelWriter'
 
 const defaults = { blendPixelDataAlphaMask }
 type Deps = Partial<typeof defaults>
@@ -8,21 +8,21 @@ type Deps = Partial<typeof defaults>
 /**
  * @param deps - @hidden
  */
-export const mutatorBlendPixelDataAlphaMask = ((writer: PixelWriter<any>, deps: Partial<Deps> = defaults) => {
+export const mutatorBlendAlphaMask = ((writer: PixelWriter<any>, deps: Partial<Deps> = defaults) => {
   const {
     blendPixelDataAlphaMask = defaults.blendPixelDataAlphaMask,
   } = deps
 
   return {
-    blendPixelDataAlphaMask(
+    blendAlphaMask(
       src: IPixelData32,
       mask: AlphaMask,
-      opts: PixelBlendMaskOptions = {},
+      opts?: PixelBlendMaskOptions,
     ): boolean {
-      const x = opts.x ?? 0
-      const y = opts.y ?? 0
-      const w = opts.w ?? src.width
-      const h = opts.h ?? src.height
+      const x = opts?.x ?? 0
+      const y = opts?.y ?? 0
+      const w = opts?.w ?? src.width
+      const h = opts?.h ?? src.height
 
       const didChange = writer.accumulator.storeRegionBeforeState(x, y, w, h)
 

package/src/History/PixelMutator/{mutatorBlendPixelDataBinaryMask.ts → mutatorBlendBinaryMask.ts}

@@ -1,6 +1,6 @@
-import type { BinaryMask, HistoryMutator, IPixelData32, PixelBlendMaskOptions } from '../../_types'
+import type { BinaryMask, IPixelData32, PixelBlendMaskOptions } from '../../_types'
 import { blendPixelDataBinaryMask } from '../../PixelData/blendPixelDataBinaryMask'
-import { PixelWriter } from '../PixelWriter'
+import { type HistoryMutator, PixelWriter } from '../PixelWriter'
 
 const defaults = { blendPixelDataBinaryMask }
 type Deps = Partial<typeof defaults>
@@ -8,21 +8,21 @@ type Deps = Partial<typeof defaults>
 /**
  * @param deps - @hidden
  */
-export const mutatorBlendPixelDataBinaryMask = ((writer: PixelWriter<any>, deps: Partial<Deps> = defaults) => {
+export const mutatorBlendBinaryMask = ((writer: PixelWriter<any>, deps: Partial<Deps> = defaults) => {
   const {
     blendPixelDataBinaryMask = defaults.blendPixelDataBinaryMask,
   } = deps
 
   return {
-    blendPixelDataBinaryMask(
+    blendBinaryMask(
       src: IPixelData32,
       mask: BinaryMask,
-      opts: PixelBlendMaskOptions = {},
+      opts?: PixelBlendMaskOptions,
     ): boolean {
-      const x = opts.x ?? 0
-      const y = opts.y ?? 0
-      const w = opts.w ?? src.width
-      const h = opts.h ?? src.height
+      const x = opts?.x ?? 0
+      const y = opts?.y ?? 0
+      const w = opts?.w ?? src.width
+      const h = opts?.h ?? src.height
 
       const didChange = writer.accumulator.storeRegionBeforeState(x, y, w, h)
 

package/src/History/PixelMutator/mutatorBlendColor.ts

@@ -1,6 +1,6 @@
-import type { Color32, ColorBlendOptions, HistoryMutator } from '../../_types'
+import type { Color32, ColorBlendOptions } from '../../_types'
 import { blendColorPixelData } from '../../PixelData/blendColorPixelData'
-import { PixelWriter } from '../PixelWriter'
+import { type HistoryMutator, PixelWriter } from '../PixelWriter'
 
 const defaults = { blendColorPixelData }
 type Deps = Partial<typeof defaults>
@@ -16,15 +16,14 @@ export const mutatorBlendColor = ((writer: PixelWriter<any>, deps: Deps = defaul
   return {
     blendColor(
       color: Color32,
-      opts: ColorBlendOptions = {},
+      opts?: ColorBlendOptions,
     ): boolean {
       const target = writer.config.target
-      const {
-        x = 0,
-        y = 0,
-        w = target.width,
-        h = target.height,
-      } = opts
+      const x = opts?.x ?? 0
+      const y = opts?.y ?? 0
+      const w = opts?.w ?? target.width
+      const h = opts?.h ?? target.height
+
       const didChange = writer.accumulator.storeRegionBeforeState(x, y, w, h)
       return didChange(
         blendColorPixelData(target, color, opts),

package/src/History/PixelMutator/mutatorBlendColorPaintAlphaMask.ts

@@ -0,0 +1,51 @@
+import { type Color32, type PaintAlphaMask } from '../../_types'
+import { sourceOverPerfect } from '../../BlendModes/blend-modes-perfect'
+import { blendColorPixelDataAlphaMask } from '../../PixelData/blendColorPixelDataAlphaMask'
+import { type HistoryMutator, PixelWriter } from '../PixelWriter'
+
+const defaults = {
+  blendColorPixelDataAlphaMask,
+}
+type Deps = Partial<typeof defaults>
+
+/**
+ * @param deps - @hidden
+ */
+export const mutatorBlendColorPaintAlphaMask = ((writer: PixelWriter<any>, deps: Partial<Deps> = defaults) => {
+  const {
+    blendColorPixelDataAlphaMask = defaults.blendColorPixelDataAlphaMask,
+  } = deps
+
+  const OPTS = {
+    x: 0,
+    y: 0,
+    blendFn: sourceOverPerfect,
+    alpha: 255,
+  }
+
+  return {
+    blendColorPaintAlphaMask(
+      color: Color32,
+      mask: PaintAlphaMask,
+      x: number,
+      y: number,
+      alpha = 255,
+      blendFn = sourceOverPerfect,
+    ): boolean {
+      const tx = x + mask.centerOffsetX
+      const ty = y + mask.centerOffsetY
+
+      const didChange = writer.accumulator.storeRegionBeforeState(tx, ty, mask.w, mask.h)
+
+      OPTS.x = tx
+      OPTS.y = ty
+      OPTS.alpha = alpha
+      OPTS.blendFn = blendFn
+
+      return didChange(
+        blendColorPixelDataAlphaMask(writer.config.target, color, mask, OPTS),
+      )
+    },
+  }
+}) satisfies HistoryMutator<any, Deps>
+

package/src/History/PixelMutator/mutatorBlendColorPaintBinaryMask.ts

@@ -0,0 +1,51 @@
+import { type Color32, type PaintBinaryMask } from '../../_types'
+import { sourceOverPerfect } from '../../BlendModes/blend-modes-perfect'
+import { blendColorPixelDataBinaryMask } from '../../PixelData/blendColorPixelDataBinaryMask'
+import { type HistoryMutator, PixelWriter } from '../PixelWriter'
+
+const defaults = {
+  blendColorPixelDataBinaryMask,
+}
+type Deps = Partial<typeof defaults>
+
+/**
+ * @param deps - @hidden
+ */
+export const mutatorBlendColorPaintBinaryMask = ((writer: PixelWriter<any>, deps: Partial<Deps> = defaults) => {
+  const {
+    blendColorPixelDataBinaryMask = defaults.blendColorPixelDataBinaryMask,
+  } = deps
+
+  const OPTS = {
+    x: 0,
+    y: 0,
+    blendFn: sourceOverPerfect,
+    alpha: 255,
+  }
+
+  return {
+    blendColorPaintBinaryMask(
+      color: Color32,
+      mask: PaintBinaryMask,
+      x: number,
+      y: number,
+      alpha = 255,
+      blendFn = sourceOverPerfect,
+    ): boolean {
+      const tx = x + mask.centerOffsetX
+      const ty = y + mask.centerOffsetY
+
+      const didChange = writer.accumulator.storeRegionBeforeState(tx, ty, mask.w, mask.h)
+
+      OPTS.x = tx
+      OPTS.y = ty
+      OPTS.alpha = alpha
+      OPTS.blendFn = blendFn
+
+      return didChange(
+        blendColorPixelDataBinaryMask(writer.config.target, color, mask, OPTS),
+      )
+    },
+  }
+}) satisfies HistoryMutator<any, Deps>
+

package/src/History/PixelMutator/{mutatorBlendPaintMask.ts → mutatorBlendColorPaintMask.ts}

@@ -1,8 +1,8 @@
-import { type Color32, type HistoryMutator, MaskType, type PaintMask } from '../../_types'
+import { type Color32, MaskType, type PaintMask } from '../../_types'
 import { sourceOverPerfect } from '../../BlendModes/blend-modes-perfect'
 import { blendColorPixelDataAlphaMask } from '../../PixelData/blendColorPixelDataAlphaMask'
 import { blendColorPixelDataBinaryMask } from '../../PixelData/blendColorPixelDataBinaryMask'
-import { PixelWriter } from '../PixelWriter'
+import { type HistoryMutator, PixelWriter } from '../PixelWriter'
 
 const defaults = {
   blendColorPixelDataAlphaMask,
@@ -13,7 +13,7 @@ type Deps = Partial<typeof defaults>
 /**
  * @param deps - @hidden
  */
-export const mutatorBlendPaintMask = ((writer: PixelWriter<any>, deps: Partial<Deps> = defaults) => {
+export const mutatorBlendColorPaintMask = ((writer: PixelWriter<any>, deps: Partial<Deps> = defaults) => {
   const {
     blendColorPixelDataBinaryMask = defaults.blendColorPixelDataBinaryMask,
     blendColorPixelDataAlphaMask = defaults.blendColorPixelDataAlphaMask,

package/src/History/PixelMutator/mutatorBlendMask.ts

@@ -0,0 +1,43 @@
+import { type IPixelData32, type Mask, MaskType, type PixelBlendMaskOptions } from '../../_types'
+import { blendPixelDataAlphaMask } from '../../PixelData/blendPixelDataAlphaMask'
+import { blendPixelDataBinaryMask } from '../../PixelData/blendPixelDataBinaryMask'
+import { type HistoryMutator, PixelWriter } from '../PixelWriter'
+
+const defaults = { blendPixelDataAlphaMask, blendPixelDataBinaryMask }
+type Deps = Partial<typeof defaults>
+
+/**
+ * @param deps - @hidden
+ */
+export const mutatorBlendMask = ((writer: PixelWriter<any>, deps: Partial<Deps> = defaults) => {
+  const {
+    blendPixelDataAlphaMask = defaults.blendPixelDataAlphaMask,
+    blendPixelDataBinaryMask = defaults.blendPixelDataBinaryMask,
+  } = deps
+
+  return {
+    blendMask(
+      src: IPixelData32,
+      mask: Mask,
+      opts?: PixelBlendMaskOptions,
+    ): boolean {
+      const x = opts?.x ?? 0
+      const y = opts?.y ?? 0
+      const w = opts?.w ?? src.width
+      const h = opts?.h ?? src.height
+
+      const didChange = writer.accumulator.storeRegionBeforeState(x, y, w, h)
+
+      if (mask.type === MaskType.BINARY) {
+        return didChange(
+          blendPixelDataBinaryMask(writer.config.target, src, mask, opts),
+        )
+      } else {
+        return didChange(
+          blendPixelDataAlphaMask(writer.config.target, src, mask, opts),
+        )
+      }
+    },
+  }
+}) satisfies HistoryMutator<any, Deps>
+