@opentui/core/buffer.d.ts

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

import { RGBA } from "./lib/index.js";
import { type OptimizedBufferHandle, type RenderLib } from "./zig.js";
import { type Pointer, type PointerInput } from "./platform/ffi.js";
import type { NativeImage } from "./image.js";
import type { ImageRenderProtocol } from "./types.js";
import { type BorderStyle, type BorderSides } from "./lib/index.js";
import { TargetChannel, type WidthMethod, type CapturedLine } from "./types.js";
import type { TextBufferView } from "./text-buffer-view.js";
import type { EditorView } from "./editor-view.js";
export declare class OptimizedBuffer {
    private static fbIdCounter;
    id: string;
    lib: RenderLib;
    private bufferPtr;
    private _width;
    private _height;
    private _widthMethod;
    respectAlpha: boolean;
    private _rawBuffers;
    private _destroyed;
    get ptr(): OptimizedBufferHandle;
    private guard;
    private ensureRawBufferViews;
    get buffers(): {
        char: Uint32Array;
        fg: Uint16Array;
        bg: Uint16Array;
        attributes: Uint32Array;
    };
    constructor(lib: RenderLib, ptr: OptimizedBufferHandle, width: number, height: number, options: {
        respectAlpha?: boolean;
        id?: string;
        widthMethod?: WidthMethod;
    });
    static create(width: number, height: number, widthMethod: WidthMethod, options?: {
        respectAlpha?: boolean;
        id?: string;
    }): OptimizedBuffer;
    get widthMethod(): WidthMethod;
    get width(): number;
    get height(): number;
    setRespectAlpha(respectAlpha: boolean): void;
    getNativeId(): string;
    getRealCharBytes(addLineBreaks?: boolean): Uint8Array;
    getSpanLines(): CapturedLine[];
    clear(bg?: RGBA): void;
    setCell(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void;
    setCellWithAlphaBlending(x: number, y: number, char: string, fg: RGBA, bg: RGBA, attributes?: number): void;
    drawText(text: string, x: number, y: number, fg: RGBA, bg?: RGBA, attributes?: number, selection?: {
        start: number;
        end: number;
        bgColor?: RGBA;
        fgColor?: RGBA;
    } | null): void;
    fillRect(x: number, y: number, width: number, height: number, bg: RGBA): void;
    colorMatrix(matrix: Float32Array, cellMask: Float32Array, strength?: number, target?: TargetChannel): void;
    colorMatrixUniform(matrix: Float32Array, strength?: number, target?: TargetChannel): void;
    drawFrameBuffer(destX: number, destY: number, frameBuffer: OptimizedBuffer, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number): void;
    destroy(): void;
    drawTextBuffer(textBufferView: TextBufferView, x: number, y: number): void;
    drawEditorView(editorView: EditorView, x: number, y: number): void;
    drawSuperSampleBuffer(x: number, y: number, pixelData: PointerInput | Uint8Array, pixelDataLength: number, format: "bgra8unorm" | "rgba8unorm", alignedBytesPerRow: number): void;
    drawImage(image: NativeImage, x: number, y: number, width: number, height: number, pixelWidth?: number, pixelHeight?: number, sourceX?: number, sourceY?: number, sourceWidth?: number, sourceHeight?: number, protocol?: ImageRenderProtocol): boolean;
    drawPackedBuffer(data: PointerInput | Uint8Array, dataLen: number, posX: number, posY: number, terminalWidthCells: number, terminalHeightCells: number): void;
    drawGrayscaleBuffer(posX: number, posY: number, intensities: Float32Array, srcWidth: number, srcHeight: number, fg?: RGBA | null, bg?: RGBA | null): void;
    drawGrayscaleBufferSupersampled(posX: number, posY: number, intensities: Float32Array, srcWidth: number, srcHeight: number, fg?: RGBA | null, bg?: RGBA | null): void;
    resize(width: number, height: number): void;
    drawBox(options: {
        x: number;
        y: number;
        width: number;
        height: number;
        borderStyle?: BorderStyle;
        customBorderChars?: Uint32Array;
        border: boolean | BorderSides[];
        borderColor: RGBA;
        backgroundColor: RGBA;
        shouldFill?: boolean;
        title?: string;
        titleColor?: RGBA;
        titleAlignment?: "left" | "center" | "right";
        bottomTitle?: string;
        bottomTitleAlignment?: "left" | "center" | "right";
    }): void;
    pushScissorRect(x: number, y: number, width: number, height: number): void;
    popScissorRect(): void;
    clearScissorRects(): void;
    pushOpacity(opacity: number): void;
    popOpacity(): void;
    getCurrentOpacity(): number;
    clearOpacity(): void;
    encodeUnicode(text: string): {
        ptr: Pointer;
        data: Array<{
            width: number;
            char: number;
        }>;
    } | null;
    freeUnicode(encoded: {
        ptr: Pointer;
        data: Array<{
            width: number;
            char: number;
        }>;
    }): void;
    drawGrid(options: {
        borderChars: Uint32Array;
        borderFg: RGBA;
        borderBg: RGBA;
        columnOffsets: Int32Array;
        rowOffsets: Int32Array;
        drawInner: boolean;
        drawOuter: boolean;
    }): void;
    drawChar(char: number, x: number, y: number, fg: RGBA, bg: RGBA, attributes?: number): void;
}