pixel-data-js 0.5.2 → 0.8.0

package/dist/index.prod.d.ts

@@ -133,7 +133,7 @@ interface PixelBlendOptions extends PixelOptions {
     sy?: number;
     /**
      * The blending algorithm to use for blending pixels.
-     * @default {@link sourceOverColor32}
+     * @default {@link sourceOverFast}
      */
     blendFn?: BlendColor32;
 }
@@ -143,7 +143,7 @@ interface PixelBlendOptions extends PixelOptions {
 interface ColorBlendOptions extends PixelOptions {
     /**
      * The blending algorithm to use for blending pixels.
-     * @default {@link sourceOverColor32}
+     * @default {@link sourceOverFast}
      */
     blendFn?: BlendColor32;
 }
@@ -156,91 +156,6 @@ type SelectionRect = Rect & ({
     maskType?: null;
 });
 
-declare const overwriteColor32: BlendColor32;
-declare const sourceOverColor32: BlendColor32;
-/** Math.min(src, dst) */
-declare const darkenColor32: BlendColor32;
-/** (src * dst) / 255 */
-declare const multiplyColor32: BlendColor32;
-/** 255 - (255-src)/dst */
-declare const colorBurnColor32: BlendColor32;
-/** src + dst - 255 */
-declare const linearBurnColor32: BlendColor32;
-declare const darkerColor32: BlendColor32;
-/** Math.max(src, dst) */
-declare const lightenColor32: BlendColor32;
-/**
- * 255 - ((255 - src) * (255 - dst))
- */
-declare const screenColor32: BlendColor32;
-/** src === 255 ? 255 : Math.min(255, (dst << 8) / (255 - src)) */
-declare const colorDodgeColor32: BlendColor32;
-/** src + dst */
-declare const linearDodgeColor32: BlendColor32;
-declare const lighterColor32: BlendColor32;
-/** src < 128 ? (2 * src * dst) : (255 - 2 * (255 - src) * (255 - dst)) */
-declare const overlayColor32: BlendColor32;
-/**  ((255 - dst) * ((src * dst) >> 8) + dst * (255 - (((255 - src) * (255 - dst)) >> 8))) >> 8 */
-declare const softLightColor32: BlendColor32;
-/** If src < 128 (50% gray), Multiply; otherwise, Screen */
-declare const hardLightColor32: BlendColor32;
-/**
- * If src < 128: Burn(dst, 2 * src)
- * If src >= 128: Dodge(dst, 2 * (src - 128))
- */
-declare const vividLightColor32: BlendColor32;
-/** dst + 2 * src - 255 (Clamped to 0-255) */
-declare const linearLightColor32: BlendColor32;
-/** src < 128 ? min(dst, 2 * src) : max(dst, 2 * (src - 128)) */
-declare const pinLightColor32: BlendColor32;
-/** (Vivid Light logic forced to 0 or 255) */
-declare const hardMixColor32: BlendColor32;
-/** Math.abs(src - dst) */
-declare const differenceColor32: BlendColor32;
-/** dst + src - ((dst * src) >> 7) */
-declare const exclusionColor32: BlendColor32;
-/** Math.max(0, dst - src) */
-declare const subtractColor32: BlendColor32;
-/** sr === 0 ? 255 : Math.min(255, (dr << 8) / sr) */
-declare const divideColor32: BlendColor32;
-declare enum BlendMode {
-    overwrite = 0,
-    sourceOver = 1,
-    darken = 2,
-    multiply = 3,
-    colorBurn = 4,
-    linearBurn = 5,
-    darkerColor = 6,
-    lighten = 7,
-    screen = 8,
-    colorDodge = 9,
-    linearDodge = 10,
-    lighterColor = 11,
-    overlay = 12,
-    softLight = 13,
-    hardLight = 14,
-    vividLight = 15,
-    linearLight = 16,
-    pinLight = 17,
-    hardMix = 18,
-    difference = 19,
-    exclusion = 20,
-    subtract = 21,
-    divide = 22
-}
-declare const BLENDER_REGISTRY: readonly [readonly [BlendMode.overwrite, BlendColor32], readonly [BlendMode.sourceOver, BlendColor32], readonly [BlendMode.darken, BlendColor32], readonly [BlendMode.multiply, BlendColor32], readonly [BlendMode.colorBurn, BlendColor32], readonly [BlendMode.linearBurn, BlendColor32], readonly [BlendMode.darkerColor, BlendColor32], readonly [BlendMode.lighten, BlendColor32], readonly [BlendMode.screen, BlendColor32], readonly [BlendMode.colorDodge, BlendColor32], readonly [BlendMode.linearDodge, BlendColor32], readonly [BlendMode.lighterColor, BlendColor32], readonly [BlendMode.overlay, BlendColor32], readonly [BlendMode.softLight, BlendColor32], readonly [BlendMode.hardLight, BlendColor32], readonly [BlendMode.vividLight, BlendColor32], readonly [BlendMode.linearLight, BlendColor32], readonly [BlendMode.pinLight, BlendColor32], readonly [BlendMode.hardMix, BlendColor32], readonly [BlendMode.difference, BlendColor32], readonly [BlendMode.exclusion, BlendColor32], readonly [BlendMode.subtract, BlendColor32], readonly [BlendMode.divide, BlendColor32]];
-type RegisteredBlender = typeof BLENDER_REGISTRY[number][1];
-type BlendModeIndex = number & {
-    readonly __brandBlendModeIndex: unique symbol;
-};
-declare const COLOR_32_BLEND_MODES: BlendColor32[];
-declare const COLOR_32_BLEND_TO_INDEX: {
-    get: (blend: RegisteredBlender) => BlendModeIndex;
-};
-declare const INDEX_TO_COLOR_32_BLEND: {
-    get: (index: BlendModeIndex) => RegisteredBlender;
-};
-
 /**
  * Packs RGBA into a 32-bit integer compatible with
  * Little-Endian Uint32Array views on ImageData.
@@ -284,10 +199,11 @@ declare function color32ToCssRGBA(color: Color32): string;
 
 declare class PixelData {
     readonly imageData: ImageDataLike;
-    readonly data32: Uint32Array;
-    readonly width: number;
-    readonly height: number;
+    data32: Uint32Array;
+    width: number;
+    height: number;
     constructor(imageData: ImageDataLike);
+    copy(): PixelData;
 }
 
 type FloodFillImageDataOptions = {
@@ -335,6 +251,158 @@ type FloodFillResult = {
  */
 declare function floodFillSelection(img: ImageDataLike | PixelData, startX: number, startY: number, { contiguous, tolerance, bounds, }?: FloodFillImageDataOptions): FloodFillResult | null;
 
+declare enum BlendMode {
+    overwrite = 0,
+    sourceOver = 1,
+    darken = 2,
+    multiply = 3,
+    colorBurn = 4,
+    linearBurn = 5,
+    darkerColor = 6,
+    lighten = 7,
+    screen = 8,
+    colorDodge = 9,
+    linearDodge = 10,
+    lighterColor = 11,
+    overlay = 12,
+    softLight = 13,
+    hardLight = 14,
+    vividLight = 15,
+    linearLight = 16,
+    pinLight = 17,
+    hardMix = 18,
+    difference = 19,
+    exclusion = 20,
+    subtract = 21,
+    divide = 22
+}
+
+declare const overwriteFast: BlendColor32;
+declare const sourceOverFast: BlendColor32;
+declare const darkenFast: BlendColor32;
+/** (src * dst) / 255 */
+declare const multiplyFast: BlendColor32;
+/** 255 - (255-src)/dst */
+declare const colorBurnFast: BlendColor32;
+/** src + dst - 255 */
+declare const linearBurnFast: BlendColor32;
+declare const darkerFast: BlendColor32;
+/** Math.max(src, dst) */
+declare const lightenFast: BlendColor32;
+/**
+ * 255 - ((255 - src) * (255 - dst))
+ */
+declare const screenFast: BlendColor32;
+/** src === 255 ? 255 : Math.min(255, (dst << 8) / (255 - src)) */
+declare const colorDodgeFast: BlendColor32;
+/** src + dst */
+declare const linearDodgeFast: BlendColor32;
+declare const lighterFast: BlendColor32;
+/** src < 128 ? (2 * src * dst) : (255 - 2 * (255 - src) * (255 - dst)) */
+declare const overlayFast: BlendColor32;
+/** ((255 - dst) * ((src * dst) >> 8) + dst * (255 - (((255 - src) * (255 - dst)) >> 8))) >> 8 */
+declare const softLightFast: BlendColor32;
+/** If src < 128 (50% gray), Multiply; otherwise, Screen */
+declare const hardLightFast: BlendColor32;
+/**
+ * If src < 128: Burn(dst, 2 * src)
+ * If src >= 128: Dodge(dst, 2 * (src - 128))
+ */
+declare const vividLightFast: BlendColor32;
+/** dst + 2 * src - 255 (Clamped to 0-255) */
+declare const linearLightFast: BlendColor32;
+/** src < 128 ? min(dst, 2 * src) : max(dst, 2 * (src - 128)) */
+declare const pinLightFast: BlendColor32;
+/** (Vivid Light logic forced to 0 or 255) */
+declare const hardMixFast: BlendColor32;
+/** Math.abs(src - dst) */
+declare const differenceFast: BlendColor32;
+/** dst + src - ((dst * src) >> 7) */
+declare const exclusionFast: BlendColor32;
+/** Math.max(0, dst - src) */
+declare const subtractFast: BlendColor32;
+/** sr === 0 ? 255 : Math.min(255, (dr << 8) / sr) */
+declare const divideFast: BlendColor32;
+declare const FAST_BLENDER_REGISTRY: readonly [readonly [BlendMode.overwrite, BlendColor32], readonly [BlendMode.sourceOver, BlendColor32], readonly [BlendMode.darken, BlendColor32], readonly [BlendMode.multiply, BlendColor32], readonly [BlendMode.colorBurn, BlendColor32], readonly [BlendMode.linearBurn, BlendColor32], readonly [BlendMode.darkerColor, BlendColor32], readonly [BlendMode.lighten, BlendColor32], readonly [BlendMode.screen, BlendColor32], readonly [BlendMode.colorDodge, BlendColor32], readonly [BlendMode.linearDodge, BlendColor32], readonly [BlendMode.lighterColor, BlendColor32], readonly [BlendMode.overlay, BlendColor32], readonly [BlendMode.softLight, BlendColor32], readonly [BlendMode.hardLight, BlendColor32], readonly [BlendMode.vividLight, BlendColor32], readonly [BlendMode.linearLight, BlendColor32], readonly [BlendMode.pinLight, BlendColor32], readonly [BlendMode.hardMix, BlendColor32], readonly [BlendMode.difference, BlendColor32], readonly [BlendMode.exclusion, BlendColor32], readonly [BlendMode.subtract, BlendColor32], readonly [BlendMode.divide, BlendColor32]];
+type RegisteredFastBlender = typeof FAST_BLENDER_REGISTRY[number][1];
+type FastBlendModeIndex = number & {
+    readonly __brandBlendModeIndex: unique symbol;
+};
+declare const FAST_BLEND_MODES: BlendColor32[];
+declare const FAST_BLEND_TO_INDEX: {
+    get: (blend: RegisteredFastBlender) => FastBlendModeIndex;
+};
+declare const INDEX_TO_FAST_BLEND: {
+    get: (index: FastBlendModeIndex) => RegisteredFastBlender;
+};
+type FastBlendModes = {
+    [K in keyof typeof BlendMode]: RegisteredFastBlender;
+};
+declare const FAST_BLEND_MODE_BY_NAME: FastBlendModes;
+
+declare const overwritePerfect: BlendColor32;
+declare const sourceOverPerfect: BlendColor32;
+declare const darkenPerfect: BlendColor32;
+/** (src * dst) / 255 */
+declare const multiplyPerfect: BlendColor32;
+/** 255 - (255-src)/dst */
+declare const colorBurnPerfect: BlendColor32;
+/** src + dst - 255 */
+declare const linearBurnPerfect: BlendColor32;
+declare const darkerPerfect: BlendColor32;
+/** Math.max(src, dst) */
+declare const lightenPerfect: BlendColor32;
+/**
+ * 255 - ((255 - src) * (255 - dst))
+ */
+declare const screenPerfect: BlendColor32;
+/** src === 255 ? 255 : Math.min(255, (dst << 8) / (255 - src)) */
+declare const colorDodgePerfect: BlendColor32;
+/** src + dst */
+declare const linearDodgePerfect: BlendColor32;
+declare const lighterPerfect: BlendColor32;
+/** src < 128 ? (2 * src * dst) : (255 - 2 * (255 - src) * (255 - dst)) */
+declare const overlayPerfect: BlendColor32;
+/** ((255 - dst) * ((src * dst) >> 8) + dst * (255 - (((255 - src) * (255 - dst)) >> 8))) >> 8 */
+declare const softLightPerfect: BlendColor32;
+/** If src < 128 (50% gray), Multiply; otherwise, Screen */
+declare const hardLightPerfect: BlendColor32;
+/**
+ * If src < 128: Burn(dst, 2 * src)
+ * If src >= 128: Dodge(dst, 2 * (src - 128))
+ */
+declare const vividLightPerfect: BlendColor32;
+/** dst + 2 * src - 255 (Clamped to 0-255) */
+declare const linearLightPerfect: BlendColor32;
+/** src < 128 ? min(dst, 2 * src) : max(dst, 2 * (src - 128)) */
+declare const pinLightPerfect: BlendColor32;
+/** (Vivid Light logic forced to 0 or 255) */
+declare const hardMixPerfect: BlendColor32;
+/** Math.abs(src - dst) */
+declare const differencePerfect: BlendColor32;
+/** dst + src - ((dst * src) >> 7) */
+declare const exclusionPerfect: BlendColor32;
+/** Math.max(0, dst - src) */
+declare const subtractPerfect: BlendColor32;
+/** sr === 0 ? 255 : Math.min(255, (dr << 8) / sr) */
+declare const dividePerfect: BlendColor32;
+declare const PERFECT_BLENDER_REGISTRY: readonly [readonly [BlendMode.overwrite, BlendColor32], readonly [BlendMode.sourceOver, BlendColor32], readonly [BlendMode.darken, BlendColor32], readonly [BlendMode.multiply, BlendColor32], readonly [BlendMode.colorBurn, BlendColor32], readonly [BlendMode.linearBurn, BlendColor32], readonly [BlendMode.darkerColor, BlendColor32], readonly [BlendMode.lighten, BlendColor32], readonly [BlendMode.screen, BlendColor32], readonly [BlendMode.colorDodge, BlendColor32], readonly [BlendMode.linearDodge, BlendColor32], readonly [BlendMode.lighterColor, BlendColor32], readonly [BlendMode.overlay, BlendColor32], readonly [BlendMode.softLight, BlendColor32], readonly [BlendMode.hardLight, BlendColor32], readonly [BlendMode.vividLight, BlendColor32], readonly [BlendMode.linearLight, BlendColor32], readonly [BlendMode.pinLight, BlendColor32], readonly [BlendMode.hardMix, BlendColor32], readonly [BlendMode.difference, BlendColor32], readonly [BlendMode.exclusion, BlendColor32], readonly [BlendMode.subtract, BlendColor32], readonly [BlendMode.divide, BlendColor32]];
+type RegisteredPerfectBlender = typeof PERFECT_BLENDER_REGISTRY[number][1];
+type PerfectBlendModeIndex = number & {
+    readonly __brandBlendModeIndex: unique symbol;
+};
+declare const PERFECT_BLEND_MODES: BlendColor32[];
+declare const PERFECT_BLEND_TO_INDEX: {
+    get: (blend: RegisteredPerfectBlender) => PerfectBlendModeIndex;
+};
+declare const INDEX_TO_PERFECT_BLEND: {
+    get: (index: PerfectBlendModeIndex) => RegisteredPerfectBlender;
+};
+type PerfectBlendModes = {
+    [K in keyof typeof BlendMode]: RegisteredPerfectBlender;
+};
+declare const PERFECT_BLEND_MODE_BY_NAME: PerfectBlendModes;
+
 type PixelCanvas = {
     readonly canvas: HTMLCanvasElement;
     readonly ctx: CanvasRenderingContext2D;
@@ -589,30 +657,33 @@ type IndexedImage = {
     /** The height of the image in pixels. */
     height: number;
     /**
-     *  A flat array of indices where each value points to a color in the palette.
+     * A flat array of indices where each value points to a color in the palette.
      * Accessible via the formula: `index = x + (y * width)`.
      */
     data: Int32Array;
     /**
-     * A flattened Uint8Array of RGBA values.
-     * Every 4 bytes represent one color: `[r, g, b, a]`.
+     * A palette of packed 32-bit colors (ABGR).
      */
-    palette: Uint8Array;
+    palette: Int32Array;
     /**
      * The specific index in the palette that represents a fully transparent pixel.
-     * All pixels with an alpha value of 0 are normalized to this index.
      */
     transparentPalletIndex: number;
 };
 /**
  * Converts standard ImageData into an IndexedImage format.
- * This process normalizes all transparent pixels into a single palette entry
- * and maps all unique RGBA colors to sequential integer IDs.
- * @param imageData - The raw ImageData from a canvas or image source.
- * @returns An IndexedImage object containing the index grid and color palette.
  */
 declare function makeIndexedImage(imageData: ImageData): IndexedImage;
 
+/**
+ * Calculates the area-weighted average color of an IndexedImage.
+ * This accounts for how often each palette index appears in the pixel data.
+ * @param indexedImage - The IndexedImage containing pixel indices and the palette.
+ * @param includeTransparent - Whether to include the transparent pixels in the average.
+ * @returns The average RGBA color of the image.
+ */
+declare function indexedImageToAverageColor(indexedImage: IndexedImage, includeTransparent?: boolean): Color32;
+
 /**
  * A convenience wrapper that extracts the first {@link File} from an
  * {@link HTMLInputElement} change event and converts it into {@link ImageData}.
@@ -819,4 +890,4 @@ declare function pixelDataToAlphaMask(pixelData: PixelData): AlphaMask;
  */
 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, COLOR_32_BLEND_MODES, COLOR_32_BLEND_TO_INDEX, type Color32, type ColorBlendOptions, type FloodFillImageDataOptions, type FloodFillResult, INDEX_TO_COLOR_32_BLEND, type ImageDataLike, type IndexedImage, MaskType, type PixelBlendOptions, type PixelCanvas, PixelData, type PixelOptions, type RGBA, type Rect, type RegisteredBlender, type ReusableCanvas, type SelectionRect, type SerializedImageData, UnsupportedFormatError, applyMaskToPixelData, base64DecodeArrayBuffer, base64EncodeArrayBuffer, blendColorPixelData, blendPixelData, clearPixelData, color32ToCssRGBA, color32ToHex, colorBurnColor32, colorDistance, colorDodgeColor32, copyImageData, copyImageDataLike, copyMask, darkenColor32, darkerColor32, deserializeImageData, deserializeNullableImageData, deserializeRawImageData, differenceColor32, divideColor32, exclusionColor32, extractImageDataPixels, extractMask, fileInputChangeToImageData, fileToImageData, fillPixelData, floodFillSelection, getImageDataFromClipboard, getSupportedPixelFormats, hardLightColor32, hardMixColor32, imageDataToAlphaMask, imageDataToDataUrl, imageDataToImgBlob, imgBlobToImageData, invertAlphaMask, invertBinaryMask, invertImageData, invertPixelData, lerpColor32, lerpColor32Fast, lightenColor32, lighterColor32, linearBurnColor32, linearDodgeColor32, linearLightColor32, makeIndexedImage, makePixelCanvas, makeReusableCanvas, mergeMasks, multiplyColor32, overlayColor32, overwriteColor32, packColor, packRGBA, pinLightColor32, pixelDataToAlphaMask, resizeImageData, screenColor32, serializeImageData, serializeNullableImageData, softLightColor32, sourceOverColor32, subtractColor32, trimRectBounds, unpackAlpha, unpackBlue, unpackColor, unpackColorTo, unpackGreen, unpackRed, vividLightColor32, writeImageDataPixels, writeImageDataToClipboard, writeImgBlobToClipboard };
+export { type AlphaMask, type AnyMask, type ApplyMaskOptions, type Base64EncodedUInt8Array, type BinaryMask, type BlendColor32, BlendMode, type Color32, type ColorBlendOptions, FAST_BLENDER_REGISTRY, FAST_BLEND_MODES, FAST_BLEND_MODE_BY_NAME, FAST_BLEND_TO_INDEX, type FastBlendModeIndex, type FastBlendModes, type FloodFillImageDataOptions, type FloodFillResult, INDEX_TO_FAST_BLEND, INDEX_TO_PERFECT_BLEND, type ImageDataLike, type IndexedImage, MaskType, PERFECT_BLENDER_REGISTRY, PERFECT_BLEND_MODES, PERFECT_BLEND_MODE_BY_NAME, PERFECT_BLEND_TO_INDEX, type PerfectBlendModeIndex, type PerfectBlendModes, type PixelBlendOptions, type PixelCanvas, PixelData, type PixelOptions, 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, getSupportedPixelFormats, hardLightFast, hardLightPerfect, hardMixFast, hardMixPerfect, imageDataToAlphaMask, imageDataToDataUrl, imageDataToImgBlob, imgBlobToImageData, indexedImageToAverageColor, invertAlphaMask, invertBinaryMask, invertImageData, invertPixelData, lerpColor32, lerpColor32Fast, lightenFast, lightenPerfect, lighterFast, lighterPerfect, linearBurnFast, linearBurnPerfect, linearDodgeFast, linearDodgePerfect, linearLightFast, linearLightPerfect, makeIndexedImage, makePixelCanvas, makeReusableCanvas, mergeMasks, multiplyFast, multiplyPerfect, overlayFast, overlayPerfect, overwriteFast, overwritePerfect, packColor, packRGBA, pinLightFast, pinLightPerfect, pixelDataToAlphaMask, resizeImageData, screenFast, screenPerfect, serializeImageData, serializeNullableImageData, softLightFast, softLightPerfect, sourceOverFast, sourceOverPerfect, subtractFast, subtractPerfect, trimRectBounds, unpackAlpha, unpackBlue, unpackColor, unpackColorTo, unpackGreen, unpackRed, vividLightFast, vividLightPerfect, writeImageDataPixels, writeImageDataToClipboard, writeImgBlobToClipboard };