image-in-browser/lib/formats/png/png-frame.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 { PngBlendMode } from './png-blend-mode.js';
import { PngDisposeMode } from './png-dispose-mode.js';
/**
 * Interface for initializing options of a PNG frame.
 */
export interface PngFrameInitOptions {
    /** Sequence number of the frame. */
    sequenceNumber?: number;
    /** Width of the frame. */
    width?: number;
    /** Height of the frame. */
    height?: number;
    /** X offset of the frame. */
    xOffset?: number;
    /** Y offset of the frame. */
    yOffset?: number;
    /** Delay numerator for the frame. */
    delayNum?: number;
    /** Delay denominator for the frame. */
    delayDen?: number;
    /** Dispose mode of the frame. */
    dispose?: number;
    /** Blend mode of the frame. */
    blend?: number;
}
/**
 * Class representing a frame in a PNG animation.
 */
export declare class PngFrame {
    /** Frame data array. */
    private readonly _fdat;
    /** Gets the frame data array. */
    get fdat(): number[];
    /** Sequence number of the frame. */
    private _sequenceNumber;
    /** Gets the sequence number of the frame. */
    get sequenceNumber(): number;
    /** Width of the frame. */
    private _width;
    /** Gets the width of the frame. */
    get width(): number;
    /** Height of the frame. */
    private _height;
    /** Gets the height of the frame. */
    get height(): number;
    /** X offset of the frame. */
    private _xOffset;
    /** Gets the X offset of the frame. */
    get xOffset(): number;
    /** Y offset of the frame. */
    private _yOffset;
    /** Gets the Y offset of the frame. */
    get yOffset(): number;
    /** Delay numerator for the frame. */
    private _delayNum;
    /** Gets the delay numerator for the frame. */
    get delayNum(): number;
    /** Delay denominator for the frame. */
    private _delayDen;
    /** Gets the delay denominator for the frame. */
    get delayDen(): number;
    /** Dispose mode of the frame. */
    private _dispose;
    /** Gets the dispose mode of the frame. */
    get dispose(): PngDisposeMode;
    /** Blend mode of the frame. */
    private _blend;
    /** Gets the blend mode of the frame. */
    get blend(): PngBlendMode;
    /**
     * Gets the delay of the frame.
     * @returns {number} The delay of the frame.
     */
    get delay(): number;
    /**
     * Initializes a new instance of the PngFrame class.
     * @param {PngFrameInitOptions} opt - Initialization options for the frame.
     * @param {number} opt.sequenceNumber - The sequence number of the frame.
     * @param {number} opt.width - The width of the frame.
     * @param {number} opt.height - The height of the frame.
     * @param {number} opt.xOffset - The x-offset of the frame.
     * @param {number} opt.yOffset - The y-offset of the frame.
     * @param {number} opt.delayNum - The numerator of the delay fraction.
     * @param {number} opt.delayDen - The denominator of the delay fraction.
     * @param {PngDisposeMode} opt.dispose - The disposal method for the frame.
     * @param {PngBlendMode} opt.blend - The blend mode for the frame.
     */
    constructor(opt: PngFrameInitOptions);
}