textmode.js 0.1.6-beta.6 → 0.1.7

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

@@ -11,27 +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;
+    $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

@@ -11,14 +11,12 @@ import type { TextmodeGrid } from "./Grid";
  * color adjustments, transformations, and more.
  */
 export declare class TextmodeConversionPipeline {
-    private renderer;
-    private font;
-    private grid;
-    private converters;
-    /** Pre-configured brightness converter for easy access */
-    readonly brightness: TextmodeBrightnessConverter;
-    /** Pre-configured custom converter for easy access */
-    readonly custom: TextmodeConverter;
+    private _renderer;
+    private _font;
+    private _grid;
+    private _converters;
+    private _brightness;
+    private _custom;
     private _resultFramebuffer;
     private _asciiShader;
     private _characterFramebuffer;
@@ -39,7 +37,7 @@ export declare class TextmodeConversionPipeline {
      * @param sourceFramebuffer The source framebuffer to convert.
      * @ignore
      */
-    render(sourceFramebuffer: Framebuffer): void;
+    $render(sourceFramebuffer: Framebuffer): void;
     /**
      * Adds a new converter to the pipeline.
      * @param converter The converter instance to add.
@@ -57,15 +55,11 @@ export declare class TextmodeConversionPipeline {
      * @param converter The converter instance to remove.
      */
     remove(converter: TextmodeConverter): void;
-    /**
-     * Returns the framebuffer containing the textmode conversion result.
-     */
-    get texture(): Framebuffer;
     /**
      * 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.
@@ -83,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. */
@@ -94,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,7 +34,7 @@ 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.
      */
@@ -45,7 +45,7 @@ export declare class TextmodeGrid {
      * @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,25 +54,25 @@ 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. */

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

@@ -44,7 +44,7 @@ declare class TextmodifierCore implements TextmodifierContext {
     _renderer: GLRenderer;
     _font: TextmodeFont;
     _pipeline: TextmodeConversionPipeline;
-    textmodeCanvas: TextmodeCanvas;
+    _canvas: TextmodeCanvas;
     _grid: TextmodeGrid;
 }
 declare const Textmodifier_base: typeof TextmodifierCore;
@@ -56,27 +56,26 @@ declare const Textmodifier_base: typeof TextmodifierCore;
  */
 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.
      *
@@ -387,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. */
@@ -404,6 +402,7 @@ export declare class Textmodifier extends Textmodifier_base {
     get width(): number;
     /** Get the height of the canvas. */
     get height(): number;
+    get canvas(): TextmodeCanvas;
     /** Check if the instance has been disposed/destroyed. */
     get isDisposed(): boolean;
 }

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.
      *

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

@@ -6,9 +6,9 @@ import type { TextmodeGrid } from "../Grid";
  * Base class for all textmode converters.
  */
 export declare class TextmodeConverter {
-    protected renderer: GLRenderer;
-    protected fontManager: TextmodeFont;
-    protected grid: TextmodeGrid;
+    protected _renderer: GLRenderer;
+    protected _fontManager: TextmodeFont;
+    protected _grid: TextmodeGrid;
     protected _characterFramebuffer: Framebuffer;
     protected _primaryColorFramebuffer: Framebuffer;
     protected _secondaryColorFramebuffer: Framebuffer;
@@ -28,7 +28,7 @@ export declare class TextmodeConverter {
      * Resizes all internal framebuffers to match the grid dimensions.
      * @ignore
      */
-    resize(): void;
+    $resize(): void;
     /**
      * Enables or disables the converter.
      * @param enabled Whether to enable or disable the converter.
@@ -46,7 +46,7 @@ export declare class TextmodeConverter {
      * Dispose of all framebuffers used by this converter.
      * This method is idempotent and safe to call multiple times.
      */
-    dispose(): void;
+    $dispose(): void;
     /** Returns the framebuffer containing character data. */
     get characterFramebuffer(): Framebuffer;
     /** Returns the framebuffer containing primary color data. */

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

@@ -8,14 +8,14 @@ import type { Framebuffer } from "../../rendering/webgl/Framebuffer";
  * Abstract base class for all feature-based textmode converters like `'brightness'`.
  */
 export declare abstract class TextmodeFeatureConverter extends TextmodeConverter {
-    protected palette: ColorPalette;
+    protected _palette: ColorPalette;
     protected constructor(renderer: GLRenderer, fontManager: TextmodeFont, grid: TextmodeGrid, options?: any);
     /**
      * Converts the source framebuffer to the target format.
      * @param sourceFramebuffer The source framebuffer to convert.
      * @ignore
      */
-    abstract convert(sourceFramebuffer: Framebuffer): void;
+    abstract $convert(sourceFramebuffer: Framebuffer): void;
     /**
      * Sets the characters used for mapping.
      * @param characters The characters to use for mapping, usually ordered from darkest to brightest.
@@ -82,25 +82,25 @@ export declare abstract class TextmodeFeatureConverter extends TextmodeConverter
      * @param a Alpha component (0-255).
      * @returns Normalized RGBA array [r, g, b, a] (0-1 range) or null if invalid.
      */
-    private parseColor;
+    private _parseColor;
     /**
      * Helper method to set color mode with validation.
      * @param mode The color mode to set.
      * @param optionKey The option key to set in _options.
      * @param errorMessage The error message to show if validation fails.
      */
-    private setColorMode;
+    private _setColorMode;
     /**
      * Helper method to set boolean options with validation.
      * @param value The boolean or number value to set.
      * @param optionKey The option key to set in _options.
      * @param displayName The display name for error messages.
      */
-    private setBooleanOption;
+    private _setBooleanOption;
     /**
      * Parses a hex color string and returns RGBA values.
      * @param hex Hex color string (e.g., '#FF0000', '#F00', 'FF0000', 'F00').
      * @returns RGBA array [r, g, b, a] or null if invalid.
      */
-    private parseHexColor;
+    private _parseHexColor;
 }

package/dist/types/textmode/font/TextmodeFont.d.ts

@@ -34,20 +34,20 @@ export declare class TextmodeFont {
      * @returns Promise that resolves when initialization is complete
      * @ignore
      */
-    initialize(fontSource?: string | URL): Promise<void>;
+    $initialize(fontSource?: string | URL): Promise<void>;
     /**
      * Sets the font size for rendering.
      * @param size The font size to set. If undefined, returns the current font size.
      * @ignore
      */
-    setFontSize(size: number | undefined): void | number;
+    $setFontSize(size: number | undefined): void | number;
     /**
      * Loads a new font from a file path.
      * @param fontPath Path to the .otf or .ttf font file
      * @returns Promise that resolves when font loading is complete
      * @ignore
      */
-    loadFont(fontPath: string): Promise<void>;
+    $loadFont(fontPath: string): Promise<void>;
     /**
      * Loads a FontFace from a font buffer.
      * @param fontBuffer ArrayBuffer containing font data
@@ -76,6 +76,11 @@ export declare class TextmodeFont {
      * @returns `true` if all characters exist in the font, `false` otherwise.
      */
     hasAllCharacters(str: string): boolean;
+    /**
+     * Dispose of all resources used by this font manager.
+     * This method is idempotent and safe to call multiple times.
+     */
+    $dispose(): void;
     /**
      * Returns the WebGL framebuffer containing the font texture atlas.
      * @ignore
@@ -92,11 +97,6 @@ export declare class TextmodeFont {
         width: number;
         height: number;
     };
-    /**
-     * Dispose of all resources used by this font manager.
-     * This method is idempotent and safe to call multiple times.
-     */
-    dispose(): void;
     /** Returns the font size used for rendering. */
     get fontSize(): number;
     /** Returns the Typr.js font object. @ignore */

package/dist/types/textmode/mixins/TextmodifierMixin.d.ts

@@ -26,7 +26,7 @@ export interface TextmodifierContext {
     /** Conversion pipeline @ignore */
     readonly _pipeline: TextmodeConversionPipeline;
     /** Canvas management @ignore */
-    readonly textmodeCanvas: TextmodeCanvas;
+    readonly _canvas: TextmodeCanvas;
     /** Grid management @ignore */
     readonly _grid: TextmodeGrid;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "textmode.js",
-  "version": "0.1.6-beta.6",
+  "version": "0.1.7",
   "description": "Apply real-time ASCII conversion to any HTML canvas.",
   "type": "module",
   "types": "./dist/types/index.d.ts",