textmode.js/dist/types/textmode/layers/LayerManager.d.ts

textmode.js is a lightweight creative coding library for creating real-time ASCII art on the web.

import type { GLFramebuffer } from '../../rendering';
import type { Textmodifier } from '../Textmodifier';
import { TextmodeLayer } from './TextmodeLayer';
import type { TextmodeLayerOptions } from './types';
import type { ILayerManager } from './interfaces/ILayerManager';
import type { TextmodeOptions } from '../types';
import type { TextmodeGrid } from '../Grid';
/**
 * Manages all user-defined layers within a Textmodifier in addition to the base layer.
 *
 * This manager is responsible for:
 * - Managing the collection of user layers (add, remove, move, swap)
 * - Coordinating layer rendering and compositing
 *
 * The instance of this class can be accessed via {@link Textmodifier.layers}.
 *
 * The {@link base} layer is not part of the public layer stack, but is instead managed internally.
 */
export declare class LayerManager implements ILayerManager {
    private readonly _textmodifier;
    private readonly _renderer;
    private readonly _conversionShader;
    private readonly _compositor2D;
    private _pendingLayers;
    private _layers;
    private readonly _baseLayer;
    private _isReady;
    private readonly _gridDimensionChangeCallbacks;
    /**
     * Create a new LayerManager.
     * @param textmodifier The Textmodifier instance this manager belongs to.
     * @ignore
     */
    constructor(textmodifier: Textmodifier, opts: TextmodeOptions);
    /**
     * Initialize all pending layers and the compositor.
     * @ignore
     */
    $initialize(): Promise<void>;
    add(options?: TextmodeLayerOptions): TextmodeLayer;
    remove(layer: TextmodeLayer): void;
    move(layer: TextmodeLayer, newIndex: number): void;
    swap(layerA: TextmodeLayer, layerB: TextmodeLayer): void;
    clear(): void;
    /**
     * Render all layers (base and user) and composite them to the target framebuffer.
     * @param targetFramebuffer The framebuffer to render the final composited result to.
     * @param backgroundColor The background color as RGBA values (0-1 range).
     * @ignore
     */
    $renderAndComposite(targetFramebuffer: GLFramebuffer, fallbackBaseDraw: () => void): void;
    /**
     * Render all user layers to their respective framebuffers.
     */
    private _renderUserLayers;
    /**
     * Composite all layers onto the target framebuffer.
     */
    private _compositeLayers;
    /**
     * Resize all layers and the compositor to match the current grid dimensions.
     * @ignore
     */
    $resize(): void;
    /**
     * Dispose of the layer manager, all layers, and the compositor.
     * @ignore
     */
    $dispose(): void;
    get all(): readonly TextmodeLayer[];
    get base(): TextmodeLayer;
    /**
     * Get the grid of the topmost visible layer.
     * Returns the topmost user layer's grid if any are visible, otherwise returns the base layer's grid.
     * This is useful for input managers that need to map coordinates to the layer the user sees on top.
     * @ignore
     */
    $getTopmostGrid(): TextmodeGrid | undefined;
    /**
     * Register a callback to be invoked whenever ANY layer's grid dimensions change.
     * This includes the base layer and all user layers.
     * @param callback The callback to invoke on dimension changes.
     * @ignore
     */
    $onAnyGridDimensionChange(callback: () => void): void;
    /**
     * Notify all registered callbacks that a grid's dimensions have changed.
     */
    private _notifyGridDimensionChange;
    /**
     * Initialize a single layer with required dependencies.
     */
    private _initializeLayer;
    /**
     * Remove a layer from a collection and dispose it.
     */
    private _removeFromCollection;
    /**
     * Move a layer to a new index within a collection.
     */
    private _moveInCollection;
    /**
     * Swap two layers within a collection.
     */
    private _swapInCollection;
}