textmode.js 0.1.6-beta.5 → 0.1.6-beta.7

package/dist/types/rendering/webgl/Renderer.d.ts

@@ -4,24 +4,24 @@ import { Shader } from "./Shader";
  * Core WebGL renderer that manages the WebGL context and provides high-level rendering operations
  */
 export declare class GLRenderer {
-    private gl;
-    private imageShader;
-    private solidColorShader;
-    private currentShader;
-    private rectangleGeometry;
-    private lineGeometry;
-    private currentFillColor;
-    private fillMode;
-    private currentStrokeColor;
-    private currentStrokeWeight;
-    private strokeMode;
-    private currentRotation;
-    private stateStack;
+    private _gl;
+    private _imageShader;
+    private _solidColorShader;
+    private _currentShader;
+    private _rectangleGeometry;
+    private _lineGeometry;
+    private _currentFillColor;
+    private _fillMode;
+    private _currentStrokeColor;
+    private _currentStrokeWeight;
+    private _strokeMode;
+    private _currentRotation;
+    private _stateStack;
     constructor(gl: WebGLRenderingContext | WebGL2RenderingContext);
     /**
      * Set the current shader
      */
-    shader(shader: Shader): void;
+    $shader(shader: Shader): void;
     /**
      * Sets the fill color for subsequent rendering operations
      * @param r Red component *(0-255)*
@@ -29,7 +29,7 @@ export declare class GLRenderer {
      * @param b Blue component *(0-255, optional)*
      * @param a Alpha component *(0-255, optional)*
      */
-    fill(r: number, g?: number, b?: number, a?: number): void;
+    $fill(r: number, g?: number, b?: number, a?: number): void;
     /**
      * Sets the stroke color for subsequent rendering operations
      * @param r Red component *(0-255)*
@@ -37,49 +37,49 @@ export declare class GLRenderer {
      * @param b Blue component *(0-255, optional)*
      * @param a Alpha component *(0-255, optional)*
      */
-    stroke(r: number, g?: number, b?: number, a?: number): void;
+    $stroke(r: number, g?: number, b?: number, a?: number): void;
     /**
      * Sets the stroke weight (thickness) for subsequent stroke operations
      * @param weight The stroke thickness in pixels
      */
-    strokeWeight(weight: number): void;
+    $strokeWeight(weight: number): void;
     /**
      * Disables stroke rendering for subsequent operations
      */
-    noStroke(): void;
+    $noStroke(): void;
     /**
      * Disables fill rendering for subsequent operations
      */
-    noFill(): void;
+    $noFill(): void;
     /**
      * Sets the rotation angle for subsequent rendering operations
      * @param degrees The rotation angle in degrees
      */
-    rotate(degrees: number): void;
+    $rotate(degrees: number): void;
     /**
      * Save the current rendering state (fill, stroke, etc.) to the state stack
      */
-    push(): void;
+    $push(): void;
     /**
      * Restore the most recently saved rendering state from the state stack
      */
-    pop(): void;
+    $pop(): void;
     /**
      * Reset frame-specific state - called automatically after each frame.
      * Note: This does not reset fill/stroke state as that should persist
      * across frames and be managed by push/pop or explicit calls.
      */
-    reset(): void;
-    createShader(vertexSource: string, fragmentSource: string): Shader;
-    createFilterShader(fragmentSource: string): Shader;
+    $reset(): void;
+    $createShader(vertexSource: string, fragmentSource: string): Shader;
+    $createFilterShader(fragmentSource: string): Shader;
     /**
      * Set a uniform value for the current shader
      */
-    setUniform(name: string, value: any): void;
+    $setUniform(name: string, value: any): void;
     /**
      * Draw a rectangle with the current fill and/or stroke settings
      */
-    rect(x: number, y: number, width: number, height: number): void;
+    $rect(x: number, y: number, width: number, height: number): void;
     /**
      * Draw a line from (x1, y1) to (x2, y2) with the current stroke settings.
      * Lines only support stroke rendering - fill properties are ignored.
@@ -88,27 +88,27 @@ export declare class GLRenderer {
      * @param x2 X-coordinate of the line end point
      * @param y2 Y-coordinate of the line end point
      */
-    line(x1: number, y1: number, x2: number, y2: number): void;
+    $line(x1: number, y1: number, x2: number, y2: number): void;
     /**
      * Calculate rotation parameters for built-in shaders (NDC coordinates)
      */
-    private calculateRotationParams;
+    private _calculateRotationParams;
     /**
      * Create a new framebuffer
      */
-    createFramebuffer(width: number, height: number, options?: FramebufferOptions): Framebuffer;
+    $createFramebuffer(width: number, height: number, options?: FramebufferOptions): Framebuffer;
     /**
      * Fill the current framebuffer with a solid color
      */
-    background(r: number, g?: number, b?: number, a?: number): void;
+    $background(r: number, g?: number, b?: number, a?: number): void;
     /**
      * Clear the current framebuffer
      */
-    clear(r?: number, g?: number, b?: number, a?: number): void;
+    $clear(r?: number, g?: number, b?: number, a?: number): void;
     /**
      * Ensure viewport matches canvas dimensions
      */
-    resetViewport(): void;
+    $resetViewport(): void;
     /**
      * Get the WebGL context
      */
@@ -117,9 +117,9 @@ export declare class GLRenderer {
      * Dispose of all WebGL resources managed by this renderer.
      * This method is idempotent and safe to call multiple times.
      */
-    dispose(): void;
+    $dispose(): void;
     /**
      * Render a framebuffer at a specific position with optional scaling
      */
-    image(source: Framebuffer, posX: number, posY: number, width?: number, height?: number): void;
+    $image(source: Framebuffer, posX: number, posY: number, width?: number, height?: number): void;
 }

package/dist/types/rendering/webgl/Shader.d.ts

@@ -2,29 +2,29 @@
  * Shader program wrapper with simplified uniform management
  */
 export declare class Shader {
-    private gl;
-    private program;
-    private uniformLocations;
-    private uniformTypes;
-    private textureUnitCounter;
-    private maxTextureUnits;
+    private _gl;
+    private _program;
+    private _uniformLocations;
+    private _uniformTypes;
+    private _textureUnitCounter;
+    private _maxTextureUnits;
     constructor(gl: WebGLRenderingContext, vertexSource: string, fragmentSource: string);
-    private cacheLocations;
-    private createProgram;
-    private createShader;
+    private _cacheLocations;
+    private _createProgram;
+    private _createShader;
     /**
      * Use this shader program
      */
-    use(): void;
+    $use(): void;
     /**
      * Set a single uniform value with automatic texture unit management
      */
     setUniform(name: string, value: any): void;
-    private getNextTextureUnit;
+    private _getNextTextureUnit;
     /**
      * Check if a uniform is an integer type
      */
-    private isUniformInteger;
+    private _isUniformInteger;
     /**
      * Get the WebGL program
      */
@@ -33,9 +33,9 @@ export declare class Shader {
      * Dispose of WebGL resources used by this shader.
      * This method is idempotent and safe to call multiple times.
      */
-    dispose(): void;
+    $dispose(): void;
     /**
      * Reset texture unit counter (useful when starting a new frame)
      */
-    resetTextureUnits(): void;
+    private _resetTextureUnits;
 }

package/dist/types/rendering/webgl/geometries/BaseGeometry.d.ts

@@ -2,39 +2,39 @@
  * Base class for WebGL geometry rendering with shared vertex buffer management
  */
 export declare abstract class BaseGeometry {
-    protected gl: WebGLRenderingContext;
-    protected unitBuffer: WebGLBuffer | null;
-    protected bytesPerVertex: number;
-    private attribCache;
+    protected _gl: WebGLRenderingContext;
+    protected _unitBuffer: WebGLBuffer | null;
+    protected _bytesPerVertex: number;
+    private _attribCache;
     constructor(gl: WebGLRenderingContext);
     /**
      * Ensure the unit buffer is created and bound
      */
-    protected ensureUnitBuffer(): void;
+    protected _ensureUnitBuffer(): void;
     /**
      * Enable vertex attributes and return their locations
      */
-    protected enableAttribs(): {
+    protected _enableAttribs(): {
         positionLoc: number;
         texLoc: number;
     };
     /**
      * Disable vertex attributes
      */
-    protected disableAttribs(positionLoc: number, texLoc: number): void;
+    protected _disableAttribs(positionLoc: number, texLoc: number): void;
     /**
      * Convert screen coordinates to NDC (Normalized Device Coordinates)
      */
-    protected toNDC(x: number, y: number): {
+    protected _toNDC(x: number, y: number): {
         nx: number;
         ny: number;
     };
     /**
      * Upload quad vertices to the buffer in NDC coordinates
      */
-    protected uploadQuadNDC(x1: number, y1: number, x2: number, y2: number): void;
+    protected _uploadQuadNDC(x1: number, y1: number, x2: number, y2: number): void;
     /**
      * Dispose of WebGL resources used by this geometry
      */
-    dispose(): void;
+    $dispose(): void;
 }

package/dist/types/rendering/webgl/geometries/Line.d.ts

@@ -7,5 +7,5 @@ export declare class Line extends BaseGeometry {
     /**
      * Draw a line from (x1, y1) to (x2, y2) with specified weight
      */
-    draw(x1: number, y1: number, x2: number, y2: number, weight: number): void;
+    $draw(x1: number, y1: number, x2: number, y2: number, weight: number): void;
 }

package/dist/types/rendering/webgl/geometries/Rectangle.d.ts

@@ -7,9 +7,9 @@ export declare class Rectangle extends BaseGeometry {
     /**
      * Draw a filled rectangle
      */
-    drawFill(x: number, y: number, width: number, height: number): void;
+    $drawFill(x: number, y: number, width: number, height: number): void;
     /**
      * Draw a rectangle stroke (outline)
      */
-    drawStroke(x: number, y: number, width: number, height: number, weight: number): void;
+    $drawStroke(x: number, y: number, width: number, height: number, weight: number): void;
 }

package/dist/types/textmode/Canvas.d.ts

@@ -11,38 +11,29 @@ export type CaptureSource = HTMLCanvasElement | HTMLVideoElement;
  */
 export declare class TextmodeCanvas {
     private _canvas;
-    private captureSource;
+    private _captureSource;
     private _isStandalone;
-    private resizeObserver?;
+    private _resizeObserver?;
     onTransformChange?: () => void;
     constructor(captureSource: CaptureSource, isStandalone?: boolean, opts?: TextmodeOptions);
-    private createCanvas;
-    private positionOverlayCanvas;
-    resize(width?: number, height?: number): void;
+    private _createCanvas;
+    private _positionOverlayCanvas;
+    $resize(width?: number, height?: number): void;
     /**
      * Get the WebGL context for the overlay canvas
      */
-    getWebGLContext(): WebGL2RenderingContext | WebGLRenderingContext;
-    /**
-     * Get the effective rendering dimensions accounting for CSS transforms
-     */
-    getEffectiveRenderingDimensions(): {
-        width: number;
-        height: number;
-    };
-    /**
-     * Check if the canvas is affected by CSS transforms
-     */
-    isTransformed(): boolean;
+    $getWebGLContext(): WebGL2RenderingContext | WebGLRenderingContext;
     /**
      * Set up ResizeObserver to monitor for CSS transform changes
+     *
+     * note: might be redundant and can be deleted?
      */
     private setupTransformObserver;
     /**
      * Dispose of this TextmodeCanvas and clean up all resources.
      * This method is idempotent and safe to call multiple times.
      */
-    dispose(): void;
+    $dispose(): void;
     get canvas(): HTMLCanvasElement;
     get width(): number;
     get height(): number;

package/dist/types/textmode/ConversionPipeline.d.ts

@@ -1,6 +1,6 @@
 import type { Framebuffer } from "../rendering/webgl/Framebuffer";
 import type { GLRenderer } from "../rendering/webgl/Renderer";
-import { TextmodeConverter } from "./converters";
+import { TextmodeBrightnessConverter, TextmodeConverter } from "./converters";
 import type { TextmodeFont } from "./font";
 import type { TextmodeGrid } from "./Grid";
 /**
@@ -11,10 +11,12 @@ import type { TextmodeGrid } from "./Grid";
  * color adjustments, transformations, and more.
  */
 export declare class TextmodeConversionPipeline {
-    private renderer;
-    private font;
-    private grid;
-    private converters;
+    private _renderer;
+    private _font;
+    private _grid;
+    private _converters;
+    private _brightness;
+    private _custom;
     private _resultFramebuffer;
     private _asciiShader;
     private _characterFramebuffer;
@@ -35,34 +37,29 @@ export declare class TextmodeConversionPipeline {
      * @param sourceFramebuffer The source framebuffer to convert.
      * @ignore
      */
-    render(sourceFramebuffer: Framebuffer): void;
+    $render(sourceFramebuffer: Framebuffer): void;
     /**
-     * Get a specific converter by name.
-     * @param name The name of the converter to retrieve.
-     * @returns The requested `TextmodeConverter` instance.
+     * Adds a new converter to the pipeline.
+     * @param converter The converter instance to add.
+     * @returns The added {@link TextmodeConverter} instance.
      */
-    get(name: string): TextmodeConverter | void;
     /**
      * Adds a new converter to the pipeline.
      * @param name A unique name for the converter.
      * @param type The type of converter to add. Can be either "brightness" or "custom".
      * @returns The newly created {@link TextmodeConverter} instance or `void` if the addition failed.
      */
-    add(name: string, type: "brightness" | "custom"): TextmodeConverter | void;
+    add(type: "brightness" | "custom"): TextmodeConverter | void;
     /**
-     * Removes a converter from the pipeline by name or instance.
-     * @param nameOrInstance The unique name of the converter or the converter instance to remove.
+     * Removes a converter from the pipeline.
+     * @param converter The converter instance to remove.
      */
-    remove(nameOrInstance: string | TextmodeConverter): void;
-    /**
-     * Returns the framebuffer containing the textmode conversion result.
-     */
-    get texture(): Framebuffer;
+    remove(converter: TextmodeConverter): void;
     /**
      * Resizes all internal framebuffers.
      * @ignore
      */
-    resize(): void;
+    $resize(): void;
     /**
      * Checks if any converter in the pipeline is enabled.
      * @returns `true` if any converter is enabled, `false` otherwise.
@@ -80,7 +77,9 @@ export declare class TextmodeConversionPipeline {
      * Dispose of all resources used by this conversion pipeline.
      * This method is idempotent and safe to call multiple times.
      */
-    dispose(): void;
+    $dispose(): void;
+    /** Returns the framebuffer containing the textmode conversion result.*/
+    get texture(): Framebuffer;
     /** Returns the character framebuffer containing the combined result of all converters. */
     get characterFramebuffer(): Framebuffer;
     /** Returns the primary color framebuffer containing the combined result of all converters. */
@@ -91,4 +90,16 @@ export declare class TextmodeConversionPipeline {
     get rotationFramebuffer(): Framebuffer;
     /** Returns the transform framebuffer containing the combined result of all converters. */
     get transformFramebuffer(): Framebuffer;
+    /**
+     * Returns the pre-defined brightness converter that is part of the pipeline by default.
+     *
+     * This converter can also be removed from the pipeline via `pipeline.remove(pipeline.brightness)`.
+     */
+    get brightness(): TextmodeBrightnessConverter;
+    /**
+     * Returns the pre-defined custom converter that is part of the pipeline by default.
+     *
+     * This converter can also be removed from the pipeline via `pipeline.remove(pipeline.custom)`.
+     */
+    get custom(): TextmodeConverter;
 }

package/dist/types/textmode/Grid.d.ts

@@ -34,18 +34,18 @@ export declare class TextmodeGrid {
      * Reset the grid to the default number of columns and rows based on the current canvas dimensions, and the grid cell dimensions.
      * @ignore
      */
-    reset(): void;
+    $reset(): void;
     /**
      * Reset the total grid width & height, and the offset to the outer canvas.
      */
-    private _resizeGrid;
+    private _updateDimensions;
     /**
      * Re-assign the grid cell dimensions and `reset()` the grid.
      * @param newCellWidth The new cell width.
      * @param newCellHeight The new cell height.
      * @ignore
      */
-    resizeCellPixelDimensions(newCellWidth: number, newCellHeight: number): void;
+    $resizeCellPixelDimensions(newCellWidth: number, newCellHeight: number): void;
     /**
      * Re-assign the grid dimensions and resize the grid.
      *
@@ -54,34 +54,29 @@ export declare class TextmodeGrid {
      * @param newRows The new number of rows.
      * @ignore
      */
-    resizeGridDimensions(newCols: number, newRows: number): void;
+    $resizeGridDimensions(newCols: number, newRows: number): void;
     /**
      * Make the grid dimensions flexible again, and `reset()` the grid.
      * @ignore
      */
-    resetGridDimensions(): void;
+    $resetGridDimensions(): void;
     /**
      * Update the canvas used by the grid, and reset the grid dimensions.
      * @param canvas The new canvas element to use for the grid.
      * @ignore
      */
-    resize(): void;
+    $resize(): void;
     /**
      * Gets or sets whether the grid dimensions *(columns and rows)* are fixed or responsive based on the canvas dimensions.
      * @param value Optional. `true` to make the grid dimensions fixed, or `false` to make them responsive. If not provided, returns the current state.
      * @returns If no parameter is provided, returns `true` if the grid dimensions are fixed, or `false` if they are responsive.
      * @ignore
      */
-    fixedDimensions(value?: boolean): boolean | void;
+    $fixedDimensions(value?: boolean): boolean | void;
     /** Returns the width of each cell in the grid. */
     get cellWidth(): number;
     /** Returns the height of each cell in the grid. */
     get cellHeight(): number;
-    /**
-     * Dispose of this TextmodeGrid and clean up references.
-     * This method is idempotent and safe to call multiple times.
-     */
-    dispose(): void;
     /** Returns the number of columns in the grid. */
     get cols(): number;
     /** Returns the number of rows in the grid. */

package/dist/types/textmode/Textmodifier.d.ts

@@ -3,11 +3,11 @@ import { TextmodeFont } from './font';
 import { TextmodeGrid } from './Grid';
 import { TextmodeCanvas } from './Canvas';
 import { TextmodeConversionPipeline } from './ConversionPipeline';
-import type { TextmodeConverter } from './converters';
-import { type TextmodifierCore } from './mixins';
+import { type TextmodifierContext } from './mixins';
 import type { RenderingCapabilities } from './mixins/RenderingMixin';
 import type { ExportCapabilities } from './mixins/ExportMixin';
 import type { FontCapabilities } from './mixins/FontMixin';
+import type { ConversionCapabilities } from './mixins/ConversionMixin';
 /**
  * Supported capture sources for textmode rendering
  */
@@ -40,14 +40,14 @@ export type TextmodeOptions = {
 /**
  * Base class for mixin application
  */
-declare class TextmodifierBase implements TextmodifierCore {
+declare class TextmodifierCore implements TextmodifierContext {
     _renderer: GLRenderer;
     _font: TextmodeFont;
     _pipeline: TextmodeConversionPipeline;
     textmodeCanvas: TextmodeCanvas;
     _grid: TextmodeGrid;
 }
-declare const Textmodifier_base: typeof TextmodifierBase;
+declare const Textmodifier_base: typeof TextmodifierCore;
 /**
  * Manages textmode rendering on a canvas or video element.
  *
@@ -56,27 +56,26 @@ declare const Textmodifier_base: typeof TextmodifierBase;
  */
 export declare class Textmodifier extends Textmodifier_base {
     /** The element to capture content from (optional for standalone mode) */
-    private captureSource;
+    private _captureSource;
     /** Canvas framebuffer for capturing source content */
     private _canvasFramebuffer;
-    private resizeObserver;
+    private _resizeObserver;
     private _mode;
     private _frameRateLimit;
-    private animationFrameId;
-    private lastFrameTime;
-    private frameInterval;
+    private _animationFrameId;
+    private _lastFrameTime;
+    private _frameInterval;
     private _isLooping;
     private _frameRate;
-    private lastRenderTime;
+    private _lastRenderTime;
     private _frameCount;
-    private frameTimeHistory;
-    private frameTimeHistorySize;
+    private _frameTimeHistory;
+    private _frameTimeHistorySize;
     private _isDisposed;
     private _standalone;
     private _drawCallback;
     private _resizedCallback;
     private _windowResizeListener;
-    private _printDebug;
     constructor(source?: CaptureSource | null, opts?: TextmodeOptions);
     /**
      * Static factory method for creating and initializing a Textmodifier instance.
@@ -85,7 +84,7 @@ export declare class Textmodifier extends Textmodifier_base {
      * @ignore
      */
     static create<T extends Textmodifier>(source?: CaptureSource | null, opts?: TextmodeOptions): Promise<T>;
-    setupEventListeners(): void;
+    $setupEventListeners(): void;
     /**
      * Apply textmode rendering to the canvas.
      *
@@ -125,20 +124,20 @@ export declare class Textmodifier extends Textmodifier_base {
      * ```
      */
     render(): void;
-    private resize;
+    private _resize;
     /**
      * Start automatic rendering
      */
-    startAutoRendering(): void;
+    private _startAutoRendering;
     /**
      * Update FPS measurement - works for both auto and manual modes
      * Uses a rolling average for smoother frame rate reporting
      */
-    private measureFrameRate;
+    private _measureFrameRate;
     /**
      * Stop automatic rendering
      */
-    private stopAutoRendering;
+    private _stopAutoRendering;
     /**
      * Update the rendering mode.
      *
@@ -359,26 +358,6 @@ export declare class Textmodifier extends Textmodifier_base {
      * @param height The new height of the canvas.
      */
     resizeCanvas(width: number, height: number): void;
-    /**
-     * @inheritDoc TextmodeConversionPipeline.get
-     *
-     * @example
-     * ```javascript
-     * // Fetch a canvas element to apply textmode rendering to
-     * const canvas = document.querySelector('canvas#myCanvas');
-     *
-     * // Create a Textmodifier instance
-     * const textmodifier = await textmode.create(canvas);
-     *
-     * // Get the pre-defined brightness converter from the pipeline
-     * const brightnessConverter = textmodifier.converter('brightness');
-     *
-     * // Update properties of the brightness converter
-     * brightnessConverter.invert(true);
-     * brightnessConverter.characters(" .,;:*");
-     * ```
-     */
-    converter(name: string): TextmodeConverter | void;
     /**
      * Completely destroy this Textmodifier instance and free all associated resources.
      *
@@ -407,7 +386,6 @@ export declare class Textmodifier extends Textmodifier_base {
      * ```
      */
     destroy(): void;
-    debug(bool: boolean): void;
     /** Get the current grid object used for rendering. */
     get grid(): TextmodeGrid;
     /** Get the current font object used for rendering. */
@@ -427,6 +405,6 @@ export declare class Textmodifier extends Textmodifier_base {
     /** Check if the instance has been disposed/destroyed. */
     get isDisposed(): boolean;
 }
-export interface Textmodifier extends RenderingCapabilities, ExportCapabilities, FontCapabilities {
+export interface Textmodifier extends RenderingCapabilities, ExportCapabilities, FontCapabilities, ConversionCapabilities {
 }
 export {};

package/dist/types/textmode/converters/BrightnessConverter.d.ts

@@ -31,12 +31,12 @@ export declare const BRIGHTNESS_DEFAULT_OPTIONS: {
  * Converter that maps brightness values from a source texture to ASCII characters.
  */
 export declare class TextmodeBrightnessConverter extends TextmodeFeatureConverter {
-    private sampleShader;
-    private colorFillShader;
-    private charMappingShader;
-    private transformFillShader;
-    private rotationFillShader;
-    private sampleFramebuffer;
+    private _sampleShader;
+    private _colorFillShader;
+    private _charMappingShader;
+    private _transformFillShader;
+    private _rotationFillShader;
+    private _sampleFramebuffer;
     /**
      * Creates a new TextmodeBrightnessConverter instance.
      * @param renderer Renderer instance for texture creation
@@ -45,8 +45,8 @@ export declare class TextmodeBrightnessConverter extends TextmodeFeatureConverte
      * @ignore
      */
     constructor(renderer: GLRenderer, fontManager: TextmodeFont, grid: TextmodeGrid);
-    convert(framebuffer: Framebuffer): void;
-    resize(): void;
+    $convert(framebuffer: Framebuffer): void;
+    $resize(): void;
     /**
      * Sets the brightness range for ASCII character mapping.
      *