pixel-data-js 0.18.0 → 0.19.0

package/src/_types.ts

@@ -1,4 +1,4 @@
-import { sourceOverFast } from './BlendModes/blend-modes-fast'
+import { PixelWriter, sourceOverPerfect } from './index'
 
 /** ALL values are 0-255 (including alpha which in CSS is 0-1) */
 export type RGBA = { r: number, g: number, b: number, a: number }
@@ -23,6 +23,14 @@ export type ImageDataLike = {
   data: Uint8ClampedArray<ArrayBufferLike>
 }
 
+export type ImageDataLikeConstructor<T extends ImageDataLike = ImageDataLike> = {
+  new(
+    data: Uint8ClampedArray,
+    width: number,
+    height: number,
+  ): T
+}
+
 export type SerializedImageData = {
   width: number
   height: number
@@ -66,7 +74,7 @@ export type AnyMask = BinaryMask | AlphaMask
  * Configuration for pixel manipulation operations.
  * Designed to be used by spreading a Rect object ({x, y, w, h}) directly.
  */
-export interface PixelRectOptions {
+export interface PixelRect {
   /**
    * The starting X coordinate in the destination buffer.
    * @default 0
@@ -80,26 +88,19 @@ export interface PixelRectOptions {
   y?: number
 
   /**
-   * The width of the region to process.
+   * The width of the region in the destination buffer.
    * @default Source width.
    */
   w?: number
 
   /**
-   * The height of the region to process.
+   * The height of the region in the destination buffer.
    * @default Source height.
    */
   h?: number
 }
 
-export interface PixelMaskRectOptions {
-
-  /**
-   * Mask width.
-   * @default value of `w`
-   */
-  mw?: number
-
+export interface MaskOffset {
   /**
    * X offset into the mask buffer.
    * @default 0
@@ -113,7 +114,15 @@ export interface PixelMaskRectOptions {
   my?: number
 }
 
-export interface PixelMaskInvertOptions {
+export interface MaskOffsetWidth {
+  /**
+   * Mask width.
+   * @default value of `w`
+   */
+  mw?: number
+}
+
+export interface InvertMask {
 
   /**
    * If true the inverse of the mask will be applied
@@ -122,27 +131,22 @@ export interface PixelMaskInvertOptions {
   invertMask?: boolean
 }
 
-/**
- * Configuration for pixel manipulation operations.
- * Designed to be used by spreading a Rect object ({x, y, w, h}) directly.
- */
-export interface PixelOptions extends PixelRectOptions, PixelMaskRectOptions, PixelMaskInvertOptions {
+export interface Alpha {
   /**
    * Overall layer opacity 0-255.
    * @default 255
    */
   alpha?: number
+}
+
+export interface ApplyMaskToPixelDataOptions extends PixelRect, Alpha, MaskOffsetWidth, MaskOffset, InvertMask {
+}
 
-  /** An optional mask to restrict where pixels are written. */
-  mask?: AnyMask | null
+export interface MergeAlphaMasksOptions extends PixelRect, Alpha, MaskOffset, InvertMask {
 
-  /** The interpretation logic for the provided mask.
-   * @default {@link MaskType.ALPHA}
-   */
-  maskType?: MaskType
 }
 
-export interface PixelMutateOptions extends PixelRectOptions, PixelMaskRectOptions, PixelMaskInvertOptions {
+export interface PixelMutateOptions extends PixelRect, MaskOffset, MaskOffsetWidth, InvertMask {
   /** An optional mask to restrict where pixels are mutated. */
   mask?: BinaryMask | null
 }
@@ -150,7 +154,8 @@ export interface PixelMutateOptions extends PixelRectOptions, PixelMaskRectOptio
 /**
  * Configuration for blitting (copying/blending) one image into another.
  */
-export interface PixelBlendOptions extends PixelOptions {
+
+export interface BasePixelBlendOptions {
   /**
    * The source rectangle x-coordinate
    * @default 0
@@ -165,23 +170,31 @@ export interface PixelBlendOptions extends PixelOptions {
 
   /**
    * The blending algorithm to use for blending pixels.
-   * @default {@link sourceOverFast}
+   * @default {@link sourceOverPerfect}
    */
   blendFn?: BlendColor32
 }
 
+export interface PixelBlendOptions extends PixelRect, Alpha, BasePixelBlendOptions {
+
+}
+
+export interface PixelBlendMaskOptions extends PixelRect, Alpha, MaskOffsetWidth, MaskOffset, InvertMask, BasePixelBlendOptions {
+}
+
 /**
  * Configuration for operations that require color blending.
  */
-export interface ColorBlendOptions extends PixelOptions {
+export interface ColorBlendOptions extends PixelRect, Alpha {
   /**
    * The blending algorithm to use for blending pixels.
-   * @default {@link sourceOverFast}
+   * @default {@link sourceOverPerfect}
    */
   blendFn?: BlendColor32
 }
 
-export type ApplyMaskOptions = Omit<PixelOptions, 'mask'>
+export interface ColorBlendMaskOptions extends ColorBlendOptions, MaskOffset, MaskOffsetWidth, InvertMask {
+}
 
 export type SelectionRect = Rect & ({
   mask: Uint8Array,
@@ -191,7 +204,10 @@ export type SelectionRect = Rect & ({
   maskType?: null,
 })
 
-export type Point = {
-  x: number,
-  y: number,
+export type HistoryMutator<T extends {}, D extends {}> = (writer: PixelWriter<any>, deps?: Partial<D>) => T
+
+export interface IPixelData {
+  readonly data32: Uint32Array
+  readonly width: number
+  readonly height: number
 }

package/src/index.ts

@@ -1,13 +1,16 @@
+// @sort-all
 export * from './_types'
 export * from './color'
 
 export * from './Algorithm/floodFillSelection'
 
-export * from './BlendModes/BlendModeRegistry'
-export * from './BlendModes/blend-modes'
 export * from './BlendModes/blend-modes-fast'
 export * from './BlendModes/blend-modes-perfect'
+export * from './BlendModes/blend-modes'
+export * from './BlendModes/BlendModeRegistry'
+export * from './BlendModes/toBlendModeIndexAndName'
 
+export * from './Canvas/_constants'
 export * from './Canvas/PixelCanvas'
 export * from './Canvas/ReusableCanvas'
 
@@ -15,23 +18,38 @@ export * from './Clipboard/getImageDataFromClipboard'
 export * from './Clipboard/writeImageDataToClipboard'
 export * from './Clipboard/writeImgBlobToClipboard'
 
-export * from './History/PixelAccumulator'
 export * from './History/HistoryManager'
+export * from './History/PixelAccumulator'
 export * from './History/PixelEngineConfig'
 export * from './History/PixelMutator'
 export * from './History/PixelPatchTiles'
 export * from './History/PixelWriter'
 
-export * from './History/PixelMutator/mutatorApplyMask'
+export * from './History/PixelMutator/mutatorApplyAlphaMask'
+export * from './History/PixelMutator/mutatorApplyBinaryMask'
+
+export * from './History/PixelMutator/mutatorApplyCircleBrush'
+export * from './History/PixelMutator/mutatorApplyCircleBrushStroke'
+
+export * from './History/PixelMutator/mutatorApplyCirclePencil'
+export * from './History/PixelMutator/mutatorApplyCirclePencilStroke'
+
+export * from './History/PixelMutator/mutatorApplyRectPencil'
+export * from './History/PixelMutator/mutatorApplyRectPencilStroke'
+
+export * from './History/PixelMutator/mutatorApplyRectBrush'
+export * from './History/PixelMutator/mutatorApplyRectBrushStroke'
+
 export * from './History/PixelMutator/mutatorBlendColor'
 export * from './History/PixelMutator/mutatorBlendPixel'
 export * from './History/PixelMutator/mutatorBlendPixelData'
-export * from './History/PixelMutator/mutatorFillPixelData'
+export * from './History/PixelMutator/mutatorClear'
+export * from './History/PixelMutator/mutatorFill'
 export * from './History/PixelMutator/mutatorInvert'
 
-export * from './ImageData/ReusableImageData'
 export * from './ImageData/copyImageData'
 export * from './ImageData/extractImageDataBuffer'
+export * from './ImageData/ImageDataLike'
 export * from './ImageData/imageDataToAlphaMask'
 export * from './ImageData/imageDataToDataUrl'
 export * from './ImageData/imageDataToImgBlob'
@@ -40,40 +58,58 @@ export * from './ImageData/imgBlobToImageData'
 export * from './ImageData/invertImageData'
 export * from './ImageData/resampleImageData'
 export * from './ImageData/resizeImageData'
+export * from './ImageData/ReusableImageData'
 export * from './ImageData/serialization'
+export * from './ImageData/uInt32ArrayToImageData'
 export * from './ImageData/writeImageData'
 export * from './ImageData/writeImageDataBuffer'
 
-export * from './IndexedImage/IndexedImage'
 export * from './IndexedImage/getIndexedImageColorCounts'
+export * from './IndexedImage/IndexedImage'
 export * from './IndexedImage/indexedImageToAverageColor'
-export * from './IndexedImage/resampleIndexedImage'
 export * from './IndexedImage/indexedImageToImageData'
+export * from './IndexedImage/resampleIndexedImage'
 
 export * from './Input/fileInputChangeToImageData'
 export * from './Input/fileToImageData'
 export * from './Input/getSupportedRasterFormats'
 
+export * from './Mask/applyBinaryMaskToAlphaMask'
 export * from './Mask/copyMask'
 export * from './Mask/extractMask'
 export * from './Mask/invertMask'
-export * from './Mask/mergeMasks'
+export * from './Mask/mergeAlphaMasks'
+export * from './Mask/mergeBinaryMasks'
 
-export * from './PixelData/PixelData'
+export * from './PixelData/applyAlphaMaskToPixelData'
+export * from './PixelData/applyBinaryMaskToPixelData'
 export * from './PixelData/applyCircleBrushToPixelData'
-export * from './PixelData/applyMaskToPixelData'
+export * from './PixelData/PixelData'
+
 export * from './PixelData/applyRectBrushToPixelData'
 export * from './PixelData/blendColorPixelData'
+export * from './PixelData/blendColorPixelDataAlphaMask'
+export * from './PixelData/blendColorPixelDataBinaryMask'
 export * from './PixelData/blendPixelData'
+export * from './PixelData/blendPixelDataAlphaMask'
+export * from './PixelData/blendPixelDataBinaryMask'
+
 export * from './PixelData/clearPixelData'
 export * from './PixelData/extractPixelData'
 export * from './PixelData/extractPixelDataBuffer'
 export * from './PixelData/fillPixelData'
 export * from './PixelData/invertPixelData'
+export * from './PixelData/PixelBuffer32'
 export * from './PixelData/pixelDataToAlphaMask'
 export * from './PixelData/reflectPixelData'
 export * from './PixelData/resamplePixelData'
 export * from './PixelData/rotatePixelData'
 export * from './PixelData/writePixelDataBuffer'
 
+export * from './Rect/getCircleBrushOrPencilBounds'
+export * from './Rect/getCircleBrushOrPencilStrokeBounds'
+export * from './Rect/getRectBrushOrPencilBounds'
+export * from './Rect/getRectBrushOrPencilStrokeBounds'
 export * from './Rect/trimRectBounds'
+
+export * from './Algorithm/forEachLinePoint'

package/src/History/PixelMutator/mutatorApplyMask.ts

@@ -1,20 +0,0 @@
-import { type AnyMask, type ApplyMaskOptions } from '../../_types'
-import { applyMaskToPixelData } from '../../PixelData/applyMaskToPixelData'
-import { PixelWriter } from '../PixelWriter'
-
-export function mutatorApplyMask(writer: PixelWriter<any>) {
-  return {
-    applyMask: (mask: AnyMask, opts: ApplyMaskOptions = {}) => {
-      let target = writer.target
-      const {
-        x = 0,
-        y = 0,
-        w = writer.target.width,
-        h = writer.target.height,
-      } = opts
-
-      writer.accumulator.storeRegionBeforeState(x, y, w, h)
-      applyMaskToPixelData(target, mask, opts)
-    },
-  }
-}

package/src/Mask/mergeMasks.ts

@@ -1,100 +0,0 @@
-import { type AlphaMask, type AnyMask, type ApplyMaskOptions, MaskType } from '../_types'
-
-/**
- * Merges a source mask into a destination AlphaMask.
- */
-export function mergeMasks(
-  dst: AlphaMask,
-  dstWidth: number,
-  src: AnyMask,
-  opts: ApplyMaskOptions,
-): void {
-  const {
-    x: targetX = 0,
-    y: targetY = 0,
-    w: width = 0,
-    h: height = 0,
-    alpha: globalAlpha = 255,
-    maskType = MaskType.ALPHA,
-    mw,
-    mx = 0,
-    my = 0,
-    invertMask = false,
-  } = opts
-
-  if (width <= 0 || height <= 0 || globalAlpha === 0) {
-    return
-  }
-
-  const sPitch = mw ?? width
-  const isAlpha = maskType === MaskType.ALPHA
-
-  for (let iy = 0; iy < height; iy++) {
-    const dy = targetY + iy
-    const sy = my + iy
-
-    if (dy < 0 || sy < 0) {
-      continue
-    }
-
-    for (let ix = 0; ix < width; ix++) {
-      const dx = targetX + ix
-      const sx = mx + ix
-
-      if (dx < 0 || dx >= dstWidth || sx < 0 || sx >= sPitch) {
-        continue
-      }
-
-      const dIdx = dy * dstWidth + dx
-      const sIdx = sy * sPitch + sx
-      const mVal = src[sIdx]
-      let weight = globalAlpha
-
-      if (isAlpha) {
-        const effectiveM = invertMask
-          ? 255 - mVal
-          : mVal
-
-        if (effectiveM === 0) {
-          dst[dIdx] = 0
-          continue
-        }
-
-        weight = globalAlpha === 255
-          ? effectiveM
-          : (effectiveM * globalAlpha + 128) >> 8
-      } else {
-        // Strict Binary 1/0 Logic
-        const isHit = invertMask
-          ? mVal === 0
-          : mVal === 1
-
-        if (!isHit) {
-          dst[dIdx] = 0
-          continue
-        }
-
-        // If binary hit, weight is just the global alpha
-        weight = globalAlpha
-      }
-
-      if (weight === 0) {
-        dst[dIdx] = 0
-        continue
-      }
-
-      const da = dst[dIdx]
-
-      if (da === 0) {
-        // Already transparent
-      } else if (weight === 255) {
-        // Identity: keep da
-      } else if (da === 255) {
-        // Identity: result is weight
-        dst[dIdx] = weight
-      } else {
-        dst[dIdx] = (da * weight + 128) >> 8
-      }
-    }
-  }
-}

package/src/PixelData/applyMaskToPixelData.ts

@@ -1,129 +0,0 @@
-import { type AnyMask, type ApplyMaskOptions, MaskType } from '../_types'
-import type { PixelData } from './PixelData'
-
-/**
- * Directly applies a mask to a region of PixelData,
- * modifying the destination's alpha channel in-place.
- */
-export function applyMaskToPixelData(
-  dst: PixelData,
-  mask: AnyMask,
-  opts: ApplyMaskOptions = {},
-): void {
-  const {
-    x: targetX = 0,
-    y: targetY = 0,
-    w: width = dst.width,
-    h: height = dst.height,
-    alpha: globalAlpha = 255,
-    maskType = MaskType.ALPHA,
-    mw,
-    mx = 0,
-    my = 0,
-    invertMask = false,
-  } = opts
-
-  let x = targetX
-  let y = targetY
-  let w = width
-  let h = height
-
-  // Clipping Logic
-  if (x < 0) {
-    w += x
-    x = 0
-  }
-
-  if (y < 0) {
-    h += y
-    y = 0
-  }
-
-  const actualW = Math.min(w, dst.width - x)
-  const actualH = Math.min(h, dst.height - y)
-
-  if (actualW <= 0 || actualH <= 0 || globalAlpha === 0) {
-    return
-  }
-
-  const dst32 = dst.data32
-  const dw = dst.width
-  const mPitch = mw ?? width
-  const isAlpha = maskType === MaskType.ALPHA
-  const dx = x - targetX
-  const dy = y - targetY
-
-  let dIdx = y * dw + x
-  let mIdx = (my + dy) * mPitch + (mx + dx)
-
-  const dStride = dw - actualW
-  const mStride = mPitch - actualW
-
-  for (let iy = 0; iy < actualH; iy++) {
-    for (let ix = 0; ix < actualW; ix++) {
-      const mVal = mask[mIdx]
-      let weight = globalAlpha
-
-      if (isAlpha) {
-        const effectiveM = invertMask
-          ? 255 - mVal
-          : mVal
-
-        // Short-circuit: if source is 0, destination alpha becomes 0
-        if (effectiveM === 0) {
-          dst32[dIdx] = (dst32[dIdx] & 0x00ffffff) >>> 0
-          dIdx++
-          mIdx++
-          continue
-        }
-
-        weight = globalAlpha === 255
-          ? effectiveM
-          : (effectiveM * globalAlpha + 128) >> 8
-      } else {
-        // Strict Binary 1/0 Logic
-        const isHit = invertMask
-          ? mVal === 0
-          : mVal === 1
-
-        if (!isHit) {
-          dst32[dIdx] = (dst32[dIdx] & 0x00ffffff) >>> 0
-          dIdx++
-          mIdx++
-          continue
-        }
-
-        weight = globalAlpha
-      }
-
-      // If calculated weight is 0, clear alpha
-      if (weight === 0) {
-        dst32[dIdx] = (dst32[dIdx] & 0x00ffffff) >>> 0
-      } else {
-        const d = dst32[dIdx]
-        const da = (d >>> 24)
-
-        let finalAlpha = da
-
-        if (da === 0) {
-          // Already transparent
-        } else if (weight === 255) {
-          // Identity: keep original da
-        } else if (da === 255) {
-          // Identity: result is just the weight
-          finalAlpha = weight
-        } else {
-          finalAlpha = (da * weight + 128) >> 8
-        }
-
-        dst32[dIdx] = ((d & 0x00ffffff) | (finalAlpha << 24)) >>> 0
-      }
-
-      dIdx++
-      mIdx++
-    }
-
-    dIdx += dStride
-    mIdx += mStride
-  }
-}