pixel-data-js 0.24.0 → 0.25.2

package/src/PixelData/extractPixelData.ts

@@ -1,4 +1,4 @@
-import type { IPixelData, Rect } from '../_types'
+import type { IPixelData32, Rect } from '../_types'
 import { extractPixelDataBuffer } from './extractPixelDataBuffer'
 import { PixelData } from './PixelData'
 
@@ -6,10 +6,10 @@ import { PixelData } from './PixelData'
  * High-level extraction that returns a new PixelData instance.
  * Leverages extractPixelDataBuffer for optimized 32-bit memory moves.
  */
-export function extractPixelData(source: IPixelData, rect: Rect): PixelData
-export function extractPixelData(source: IPixelData, x: number, y: number, w: number, h: number): PixelData
+export function extractPixelData(source: IPixelData32, rect: Rect): PixelData
+export function extractPixelData(source: IPixelData32, x: number, y: number, w: number, h: number): PixelData
 export function extractPixelData(
-  source: IPixelData,
+  source: IPixelData32,
   _x: Rect | number,
   _y?: number,
   _w?: number,

package/src/PixelData/extractPixelDataBuffer.ts

@@ -1,4 +1,4 @@
-import type { IPixelData, Rect } from '../_types'
+import type { IPixelData32, Rect } from '../_types'
 import { makeClippedBlit, resolveBlitClipping } from '../Internal/resolveClipping'
 
 const SCRATCH_BLIT = makeClippedBlit()
@@ -7,10 +7,10 @@ const SCRATCH_BLIT = makeClippedBlit()
  * Extracts a rectangular region of pixels from PixelData.
  * Returns a new Uint32Array containing the extracted pixels.
  */
-export function extractPixelDataBuffer(source: IPixelData, rect: Rect): Uint32Array
-export function extractPixelDataBuffer(source: IPixelData, x: number, y: number, w: number, h: number): Uint32Array
+export function extractPixelDataBuffer(source: IPixelData32, rect: Rect): Uint32Array
+export function extractPixelDataBuffer(source: IPixelData32, x: number, y: number, w: number, h: number): Uint32Array
 export function extractPixelDataBuffer(
-  source: IPixelData,
+  source: IPixelData32,
   _x: Rect | number,
   _y?: number,
   _w?: number,

package/src/PixelData/fillPixelData.ts

@@ -1,10 +1,10 @@
-import type { Color32, IPixelData, Rect } from '../_types'
+import type { Color32, IPixelData32, 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.
+ * Fills a region or the {@link IPixelData32} buffer with a solid color.
  *
  * @param dst - The target to modify.
  * @param color - The color to apply.
@@ -12,7 +12,7 @@ const SCRATCH_RECT = makeClippedRect()
  * @returns true if any pixels were actually modified.
  */
 export function fillPixelData(
-  dst: IPixelData,
+  dst: IPixelData32,
   color: Color32,
   rect?: Partial<Rect>,
 ): boolean
@@ -25,7 +25,7 @@ export function fillPixelData(
  * @param h - Height of the fill area.
  */
 export function fillPixelData(
-  dst: IPixelData,
+  dst: IPixelData32,
   color: Color32,
   x: number,
   y: number,
@@ -33,7 +33,7 @@ export function fillPixelData(
   h: number,
 ): boolean
 export function fillPixelData(
-  dst: IPixelData,
+  dst: IPixelData32,
   color: Color32,
   _x?: Partial<Rect> | number,
   _y?: number,

package/src/PixelData/fillPixelDataBinaryMask.ts

@@ -1,10 +1,10 @@
-import type { BinaryMask, Color32, IPixelData } from '../_types'
+import type { BinaryMask, Color32, IPixelData32 } from '../_types'
 import { makeClippedRect, resolveRectClipping } from '../Internal/resolveClipping'
 
 const SCRATCH_RECT = makeClippedRect()
 
 /**
- * Fills a region of the {@link IPixelData} buffer with a solid color using a mask.
+ * Fills a region of the {@link IPixelData32} buffer with a solid color using a mask.
  * @param dst - The target to modify.
  * @param color - The color to apply.
  * @param mask - The mask defining the area to fill.
@@ -13,7 +13,7 @@ const SCRATCH_RECT = makeClippedRect()
  * @param y - Starting vertical coordinate for the mask placement.
  */
 export function fillPixelDataBinaryMask(
-  dst: IPixelData,
+  dst: IPixelData32,
   color: Color32,
   mask: BinaryMask,
   alpha = 255,

package/src/PixelData/fillPixelDataFast.ts

@@ -1,10 +1,10 @@
-import type { Color32, IPixelData, Rect } from '../_types'
+import type { Color32, IPixelData32, 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.
+ * Fills a region or the {@link IPixelData32} buffer with a solid color.
  * This function is faster than {@link fillPixelData} but does not
  * return a boolean value indicating changes were made.
  *
@@ -14,7 +14,7 @@ const SCRATCH_RECT = makeClippedRect()
  * buffer is filled.
  */
 export function fillPixelDataFast(
-  dst: IPixelData,
+  dst: IPixelData32,
   color: Color32,
   rect?: Partial<Rect>,
 ): void
@@ -27,7 +27,7 @@ export function fillPixelDataFast(
  * @param h - Height of the fill area.
  */
 export function fillPixelDataFast(
-  dst: IPixelData,
+  dst: IPixelData32,
   color: Color32,
   x: number,
   y: number,
@@ -35,7 +35,7 @@ export function fillPixelDataFast(
   h: number,
 ): void
 export function fillPixelDataFast(
-  dst: IPixelData,
+  dst: IPixelData32,
   color: Color32,
   _x?: Partial<Rect> | number,
   _y?: number,

package/src/PixelData/invertPixelData.ts

@@ -1,10 +1,10 @@
-import { type IPixelData, type PixelMutateOptions } from '../_types'
+import { type IPixelData32, type PixelMutateOptions } from '../_types'
 import { makeClippedRect, resolveRectClipping } from '../Internal/resolveClipping'
 
 const SCRATCH_RECT = makeClippedRect()
 
 export function invertPixelData(
-  pixelData: IPixelData,
+  pixelData: IPixelData32,
   opts: PixelMutateOptions = {},
 ): boolean {
   const dst = pixelData

package/src/PixelData/pixelDataToAlphaMask.ts

@@ -1,4 +1,4 @@
-import type { AlphaMask, IPixelData } from '../_types'
+import type { AlphaMask, IPixelData32 } from '../_types'
 import { makeAlphaMask } from '../Mask/AlphaMask'
 
 /**
@@ -6,7 +6,7 @@ import { makeAlphaMask } from '../Mask/AlphaMask'
  * Returns a Uint8Array branded as AlphaMask.
  */
 export function pixelDataToAlphaMask(
-  pixelData: IPixelData,
+  pixelData: IPixelData32,
 ): AlphaMask {
   const {
     data32,

package/src/PixelData/reflectPixelData.ts

@@ -1,6 +1,6 @@
-import type { IPixelData } from '../_types'
+import type { IPixelData32 } from '../_types'
 
-export function reflectPixelDataHorizontal(pixelData: IPixelData): void {
+export function reflectPixelDataHorizontal(pixelData: IPixelData32): void {
   const width = pixelData.width
   const height = pixelData.height
   const data = pixelData.data32
@@ -20,7 +20,7 @@ export function reflectPixelDataHorizontal(pixelData: IPixelData): void {
   }
 }
 
-export function reflectPixelDataVertical(pixelData: IPixelData): void {
+export function reflectPixelDataVertical(pixelData: IPixelData32): void {
   const width = pixelData.width
   const height = pixelData.height
   const data = pixelData.data32

package/src/PixelData/resamplePixelData.ts

@@ -1,4 +1,4 @@
-import { type IPixelData, PixelData } from '../index'
+import { type IPixelData32, PixelData } from '../index'
 import { resample32 } from '../Internal/resample32'
 
 /**
@@ -6,7 +6,7 @@ import { resample32 } from '../Internal/resample32'
  * Factor > 1 upscales, Factor < 1 downscales.
  */
 export function resamplePixelData(
-  pixelData: IPixelData,
+  pixelData: IPixelData32,
   factor: number,
 ): PixelData {
   const { data, width, height } = resample32(pixelData.data32, pixelData.width, pixelData.height, factor)

package/src/PixelData/writePaintBufferToPixelData.ts

@@ -0,0 +1,26 @@
+import type { IPixelData } from '../_types'
+import type { PaintBuffer } from '../Paint/PaintBuffer'
+import { writePixelDataBuffer } from './writePixelDataBuffer'
+
+/**
+ * @param writePixelDataBufferFn - @hidden
+ */
+export function writePaintBufferToPixelData(
+  target: IPixelData,
+  paintBuffer: PaintBuffer,
+  writePixelDataBufferFn = writePixelDataBuffer,
+) {
+  const tileShift = paintBuffer.config.tileShift
+  const lookup = paintBuffer.lookup
+
+  for (let i = 0; i < lookup.length; i++) {
+    const tile = lookup[i]
+
+    if (tile) {
+      const dx = tile.tx << tileShift
+      const dy = tile.ty << tileShift
+
+      writePixelDataBufferFn(target, tile.data32, dx, dy, tile.width, tile.height)
+    }
+  }
+}

package/src/PixelData/writePixelDataBuffer.ts

@@ -1,21 +1,21 @@
-import { type IPixelData, type Rect } from '../_types'
+import { type IPixelData32, type Rect } from '../_types'
 import { makeClippedBlit, resolveBlitClipping } from '../Internal/resolveClipping'
 
 const SCRATCH_BLIT = makeClippedBlit()
 
 /**
- * Copies a pixel buffer into a specific region of a {@link IPixelData} object.
+ * Copies a pixel buffer into a specific region of a {@link IPixelData32} object.
  *
  * This function performs a direct memory copy from a {@link Uint32Array}
  * into the target buffer.
  */
 export function writePixelDataBuffer(
-  target: IPixelData,
+  target: IPixelData32,
   data: Uint32Array,
   rect: Rect,
 ): void
 export function writePixelDataBuffer(
-  target: IPixelData,
+  target: IPixelData32,
   data: Uint32Array,
   x: number,
   y: number,
@@ -23,7 +23,7 @@ export function writePixelDataBuffer(
   h: number,
 ): void
 export function writePixelDataBuffer(
-  target: IPixelData,
+  target: IPixelData32,
   data: Uint32Array,
   _x: Rect | number,
   _y?: number,

package/src/Rect/trimMaskRectBounds.ts

@@ -0,0 +1,121 @@
+import type { NullableMaskRect, Rect } from '../_types'
+import { extractMaskBuffer } from '../Mask/extractMaskBuffer'
+
+/**
+ * Intersects a target rectangle with a boundary, trimming dimensions and masks in-place.
+ * This utility calculates the axis-aligned intersection between the `target` and `bounds`.
+ * If the `target` includes a `mask` (as in a {@link NullableMaskRect}), the mask is physically
+ * cropped and re-aligned using `extractMaskBuffer` to match the new dimensions.
+ * @param target - The rectangle or selection object to be trimmed. **Note:** This object is mutated in-place.
+ * @param bounds - The boundary rectangle defining the maximum allowable area (e.g., canvas dimensions).
+ * @example
+ * const selection = { x: -10, y: -10, w: 50, h: 50, mask: new Uint8Array(2500) };
+ * const canvas = { x: 0, y: 0, w: 100, h: 100 };
+ * // Selection will be moved to (0,0) and resized to 40x40.
+ * // The mask is cropped by 10 px on the top and left.
+ * trimRectBounds(selection, canvas);
+ */
+export function trimMaskRectBounds<T extends NullableMaskRect>(
+  target: T,
+  bounds: Rect,
+): void {
+  const originalX = target.x
+  const originalY = target.y
+  const originalW = target.w
+
+  const intersectedX = Math.max(target.x, bounds.x)
+  const intersectedY = Math.max(target.y, bounds.y)
+
+  const intersectedMaxX = Math.min(
+    target.x + target.w,
+    bounds.x + bounds.w,
+  )
+  const intersectedMaxY = Math.min(
+    target.y + target.h,
+    bounds.y + bounds.h,
+  )
+
+  // Intersection check
+  if (intersectedMaxX <= intersectedX || intersectedMaxY <= intersectedY) {
+    target.w = 0
+    target.h = 0
+
+    if ('data' in target && target.data) {
+      target.data = new Uint8Array(0)
+    }
+
+    return
+  }
+
+  const intersectedW = intersectedMaxX - intersectedX
+  const intersectedH = intersectedMaxY - intersectedY
+  const offsetX = intersectedX - originalX
+  const offsetY = intersectedY - originalY
+
+  target.x = intersectedX
+  target.y = intersectedY
+  target.w = intersectedW
+  target.h = intersectedH
+
+  if ('data' in target && target.data) {
+    const currentMaskBuffer = extractMaskBuffer(
+      target.data,
+      originalW,
+      offsetX,
+      offsetY,
+      intersectedW,
+      intersectedH,
+    )
+
+    let minX = intersectedW
+    let maxX = -1
+    let minY = intersectedH
+    let maxY = -1
+
+    // Scan for content
+    for (let y = 0; y < intersectedH; y++) {
+      for (let x = 0; x < intersectedW; x++) {
+        if (currentMaskBuffer[y * intersectedW + x] !== 0) {
+          if (x < minX) minX = x
+          if (x > maxX) maxX = x
+          if (y < minY) minY = y
+          if (y > maxY) maxY = y
+        }
+      }
+    }
+
+    // If no content is found (all zeros)
+    if (maxX === -1) {
+      target.w = 0
+      target.h = 0
+      target.data = new Uint8Array(0)
+
+      return
+    }
+
+    const finalW = maxX - minX + 1
+    const finalH = maxY - minY + 1
+
+    // Only shift and crop if the content is smaller than the intersection
+    if (finalW !== intersectedW || finalH !== intersectedH) {
+      const newMaskBuffer = extractMaskBuffer(
+        currentMaskBuffer,
+        intersectedW,
+        minX,
+        minY,
+        finalW,
+        finalH,
+      )
+
+      target.x += minX
+      target.y += minY
+      target.w = finalW
+      target.h = finalH
+      target.data = newMaskBuffer
+    } else {
+      target.w = finalW
+      target.h = finalH
+      target.data = currentMaskBuffer
+    }
+  }
+}

package/src/Rect/trimRectBounds.ts

@@ -1,121 +1,30 @@
-import type { NullableMaskRect, Rect } from '../_types'
-import { extractMaskBuffer } from '../Mask/extractMaskBuffer'
-
-/**
- * Intersects a target rectangle with a boundary, trimming dimensions and masks in-place.
- * This utility calculates the axis-aligned intersection between the `target` and `bounds`.
- * If the `target` includes a `mask` (as in a {@link NullableMaskRect}), the mask is physically
- * cropped and re-aligned using `extractMaskBuffer` to match the new dimensions.
- * @param target - The rectangle or selection object to be trimmed. **Note:** This object is mutated in-place.
- * @param bounds - The boundary rectangle defining the maximum allowable area (e.g., canvas dimensions).
- * @example
- * const selection = { x: -10, y: -10, w: 50, h: 50, mask: new Uint8Array(2500) };
- * const canvas = { x: 0, y: 0, w: 100, h: 100 };
- * // Selection will be moved to (0,0) and resized to 40x40.
- * // The mask is cropped by 10 px on the top and left.
- * trimRectBounds(selection, canvas);
- */
-export function trimRectBounds<T extends NullableMaskRect>(
-  target: T,
-  bounds: Rect,
-): void {
-  const originalX = target.x
-  const originalY = target.y
-  const originalW = target.w
-
-  const intersectedX = Math.max(target.x, bounds.x)
-  const intersectedY = Math.max(target.y, bounds.y)
-
-  const intersectedMaxX = Math.min(
-    target.x + target.w,
-    bounds.x + bounds.w,
-  )
-  const intersectedMaxY = Math.min(
-    target.y + target.h,
-    bounds.y + bounds.h,
-  )
-
-  // Intersection check
-  if (intersectedMaxX <= intersectedX || intersectedMaxY <= intersectedY) {
-    target.w = 0
-    target.h = 0
-
-    if ('data' in target && target.data) {
-      target.data = new Uint8Array(0)
-    }
-
-    return
+import { type Rect } from '../_types'
+
+export function trimRectBounds(
+  x: number,
+  y: number,
+  w: number,
+  h: number,
+  targetWidth: number,
+  targetHeight: number,
+  out?: Rect,
+): Rect {
+  const res = out ?? {
+    x: 0,
+    y: 0,
+    w: 0,
+    h: 0,
   }
 
-  const intersectedW = intersectedMaxX - intersectedX
-  const intersectedH = intersectedMaxY - intersectedY
-  const offsetX = intersectedX - originalX
-  const offsetY = intersectedY - originalY
-
-  target.x = intersectedX
-  target.y = intersectedY
-  target.w = intersectedW
-  target.h = intersectedH
+  const left = Math.max(0, x)
+  const top = Math.max(0, y)
+  const right = Math.min(targetWidth, x + w)
+  const bottom = Math.min(targetHeight, y + h)
 
-  if ('data' in target && target.data) {
-    const currentMaskBuffer = extractMaskBuffer(
-      target.data,
-      originalW,
-      offsetX,
-      offsetY,
-      intersectedW,
-      intersectedH,
-    )
+  res.x = left
+  res.y = top
+  res.w = Math.max(0, right - left)
+  res.h = Math.max(0, bottom - top)
 
-    let minX = intersectedW
-    let maxX = -1
-    let minY = intersectedH
-    let maxY = -1
-
-    // Scan for content
-    for (let y = 0; y < intersectedH; y++) {
-      for (let x = 0; x < intersectedW; x++) {
-        if (currentMaskBuffer[y * intersectedW + x] !== 0) {
-          if (x < minX) minX = x
-          if (x > maxX) maxX = x
-          if (y < minY) minY = y
-          if (y > maxY) maxY = y
-        }
-      }
-    }
-
-    // If no content is found (all zeros)
-    if (maxX === -1) {
-      target.w = 0
-      target.h = 0
-      target.data = new Uint8Array(0)
-
-      return
-    }
-
-    const finalW = maxX - minX + 1
-    const finalH = maxY - minY + 1
-
-    // Only shift and crop if the content is smaller than the intersection
-    if (finalW !== intersectedW || finalH !== intersectedH) {
-      const newMaskBuffer = extractMaskBuffer(
-        currentMaskBuffer,
-        intersectedW,
-        minX,
-        minY,
-        finalW,
-        finalH,
-      )
-
-      target.x += minX
-      target.y += minY
-      target.w = finalW
-      target.h = finalH
-      target.data = newMaskBuffer
-    } else {
-      target.w = finalW
-      target.h = finalH
-      target.data = currentMaskBuffer
-    }
-  }
+  return res
 }

package/src/_types.ts

@@ -80,19 +80,18 @@ export interface AlphaMask extends Mask {
   readonly type: MaskType.ALPHA
 }
 
-interface BaseCircleMask {
-  readonly size: number
-  readonly radius: number
-  readonly minOffset: number
+interface BasePaintMask {
+  readonly centerOffsetX: number
+  readonly centerOffsetY: number
 }
 
-export interface CircleAlphaMask extends BaseCircleMask, AlphaMask {
+export interface PaintAlphaMask extends BasePaintMask, AlphaMask {
 }
 
-export interface CircleBinaryMask extends BaseCircleMask, BinaryMask {
+export interface PaintBinaryMask extends BasePaintMask, BinaryMask {
 }
 
-export type CircleMask = CircleAlphaMask | CircleBinaryMask
+export type PaintMask = PaintAlphaMask | PaintBinaryMask
 
 /**
  * Configuration for pixel manipulation operations.
@@ -192,7 +191,6 @@ export interface BasePixelBlendOptions {
 }
 
 export interface PixelBlendOptions extends PixelRect, Alpha, BasePixelBlendOptions {
-
 }
 
 export interface PixelBlendMaskOptions extends PixelRect, Alpha, MaskOffset, InvertMask, BasePixelBlendOptions {
@@ -212,15 +210,14 @@ export interface ColorBlendOptions extends PixelRect, Alpha {
 export interface ColorBlendMaskOptions extends ColorBlendOptions, MaskOffset, InvertMask {
 }
 
-export type BinaryMaskRect = Rect & {
-  type: MaskType.BINARY
+export type MaskRect<T extends MaskType> = Rect & {
+  type: T
   data: Uint8Array
 }
 
-export type AlphaMaskRect = Rect & {
-  type: MaskType.ALPHA
-  data: Uint8Array
-}
+export type BinaryMaskRect = MaskRect<MaskType.BINARY>
+
+export type AlphaMaskRect = MaskRect<MaskType.ALPHA>
 
 export type NullableBinaryMaskRect = Rect & ({
   type: MaskType.BINARY
@@ -240,8 +237,12 @@ export type NullableMaskRect = Rect & ({
 
 export type HistoryMutator<T extends {}, D extends {}> = (writer: PixelWriter<any>, deps?: Partial<D>) => T
 
-export interface IPixelData {
+export interface IPixelData32 {
   readonly data32: Uint32Array
   readonly width: number
   readonly height: number
 }
+
+export interface IPixelData<T extends ImageDataLike = ImageData> extends IPixelData32 {
+  readonly imageData: T
+}