image-in-browser
Version:
Package for encoding / decoding images, transforming images, applying filters, drawing primitives on images on the client side (no need for server Node.js)
72 lines (71 loc) • 2.64 kB
TypeScript
/** @format */
import { Color } from '../../color/color.js';
import { DecodeInfo } from '../decode-info.js';
import { GifColorMap } from './gif-color-map.js';
import { GifImageDesc } from './gif-image-desc.js';
/**
* Interface for initializing GifInfo options.
*/
export interface GifInfoInitOptions {
/** Width of the GIF. */
width?: number;
/** Height of the GIF. */
height?: number;
/** Background color of the GIF. */
backgroundColor?: Color;
/** Array of frames in the GIF. */
frames?: Array<GifImageDesc>;
/** Color resolution of the GIF. */
colorResolution?: number;
/** Global color map of the GIF. */
globalColorMap?: GifColorMap;
/** Indicates if the GIF is version 89a. */
isGif89?: boolean;
}
/**
* Class representing GIF information.
*/
export declare class GifInfo implements DecodeInfo {
/** Width of the GIF. */
private _width;
/** Gets the width of the GIF. */
get width(): number;
/** Height of the GIF. */
private _height;
/** Gets the height of the GIF. */
get height(): number;
/** Background color of the GIF. */
private _backgroundColor;
/** Gets the background color of the GIF. */
get backgroundColor(): Color | undefined;
/** Array of frames in the GIF. */
private _frames;
/** Gets the array of frames in the GIF. */
get frames(): Array<GifImageDesc>;
/** Color resolution of the GIF. */
private _colorResolution;
/** Gets the color resolution of the GIF. */
get colorResolution(): number;
/** Global color map of the GIF. */
private _globalColorMap?;
/** Gets the global color map of the GIF. */
get globalColorMap(): GifColorMap | undefined;
/** Indicates if the GIF is version 89a. */
private _isGif89;
/** Gets the indication if the GIF is version 89a. */
get isGif89(): boolean;
/** Gets the number of frames in the GIF. */
get numFrames(): number;
/**
* Initializes a new instance of the GifInfo class.
* @param {GifInfoInitOptions} [opt] - Initialization options for the GIF.
* @param {number} [opt.width] - Width of the GIF.
* @param {number} [opt.height] - Height of the GIF.
* @param {string} [opt.backgroundColor] - Background color of the GIF.
* @param {GifImageDesc[]} [opt.frames] - Array of frames in the GIF.
* @param {number} [opt.colorResolution] - Color resolution of the GIF.
* @param {any} [opt.globalColorMap] - Global color map of the GIF.
* @param {boolean} [opt.isGif89] - Indicates if the GIF is version 89a.
*/
constructor(opt?: GifInfoInitOptions);
}