image-in-browser/lib/image/pixel.d.ts

Package for encoding / decoding images, transforming images, applying filters, drawing primitives on images on the client side (no need for server Node.js)

/** @format */
import { Color } from '../color/color.js';
import { MemoryImageData } from './image-data.js';
import { PixelUndefined } from './pixel-undefined.js';
/**
 * Interface representing a Pixel, extending Color and Iterator<Pixel>.
 */
export interface Pixel extends Color, Iterator<Pixel> {
    /**
     * The MemoryImageData this pixel refers to.
     */
    get image(): MemoryImageData;
    /**
     * True if this points to a valid pixel, otherwise false.
     */
    get isValid(): boolean;
    /**
     * The width in pixels of the image data this pixel refers to.
     */
    get width(): number;
    /**
     * The height in pixels of the image data this pixel refers to.
     */
    get height(): number;
    /**
     * The x coordinate of the pixel.
     */
    get x(): number;
    /**
     * The y coordinate of the pixel.
     */
    get y(): number;
    /**
     * The normalized x coordinate of the pixel, in the range [0, 1].
     */
    get xNormalized(): number;
    /**
     * The normalized y coordinate of the pixel, in the range [0, 1].
     */
    get yNormalized(): number;
    /**
     * Set the coordinates of the pixel.
     * @param {number} x - The x coordinate of the pixel.
     * @param {number} y - The y coordinate of the pixel.
     */
    setPosition(x: number, y: number): void;
    /**
     * Set the normalized coordinates of the pixel, in the range [0, 1].
     * @param {number} x - The normalized x coordinate of the pixel.
     * @param {number} y - The normalized y coordinate of the pixel.
     */
    setPositionNormalized(x: number, y: number): void;
    /**
     * Tests if this pixel has the same values as the given pixel or color.
     * @param {Pixel | number[]} other - The other pixel or color to compare against.
     * @returns {boolean} True if the pixels or colors are equal, otherwise false.
     */
    equals(other: Pixel | number[]): boolean;
}
/**
 * UndefinedPixel is used to represent an invalid pixel.
 */
export declare const UndefinedPixel: PixelUndefined;