@opentui/core/renderables/Image.d.ts

OpenTUI is a TypeScript library on a native Zig core for building terminal user interfaces (TUIs)

import { Renderable, type RenderableOptions } from "../Renderable.js";
import { NativeImage, type ImageSource } from "../image.js";
import type { OptimizedBuffer } from "../buffer.js";
import type { ImageRenderProtocol, RenderContext, TerminalCapabilities } from "../types.js";
export type ImageFit = "fit" | "cover" | "fill";
export type ImageRenderableSource = ImageSource | NativeImage;
export interface ImageRenderableOptions extends RenderableOptions<ImageRenderable> {
    source?: ImageRenderableSource;
    fit?: ImageFit;
    protocol?: ImageRenderProtocol;
    onLoad?: (image: NativeImage) => void;
    onError?: (error: unknown) => void;
}
export declare function resolveImageRenderProtocol(requested: ImageRenderProtocol, capabilities: TerminalCapabilities | null, hasResolution: boolean): Exclude<ImageRenderProtocol, "auto">;
export declare class ImageRenderable extends Renderable {
    private _source;
    private _image;
    private _pendingImage;
    private _loadError;
    private _loadController;
    onLoad?: (image: NativeImage) => void;
    onError?: (error: unknown) => void;
    private _fit;
    private _protocol;
    loadPromise: Promise<void> | null;
    constructor(ctx: RenderContext, options: ImageRenderableOptions);
    get source(): ImageRenderableSource | undefined;
    set source(source: ImageRenderableSource | undefined);
    get image(): NativeImage | null;
    get fit(): ImageFit;
    set fit(value: ImageFit | null | undefined);
    get protocol(): ImageRenderProtocol;
    set protocol(value: ImageRenderProtocol | null | undefined);
    get effectiveProtocol(): Exclude<ImageRenderProtocol, "auto">;
    get cellAspectRatio(): number;
    getFittedSize(targetWidth: number, targetHeight: number, cellAspectRatio?: number, sourceWidth?: number, sourceHeight?: number): {
        width: number;
        height: number;
    };
    get loading(): boolean;
    get loadError(): unknown;
    render(buffer: OptimizedBuffer, deltaTime: number): void;
    protected renderSelf(buffer: OptimizedBuffer): void;
    private load;
    protected destroySelf(): void;
}