textmode.js 0.0.2 → 0.0.4

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

@@ -1,12 +1,21 @@
 import { TextmodeFont } from './Font';
 import { TextmodeGrid } from './Grid';
-import { TextmodeErrorLevel } from '../errors';
+import { TextmodeConversionPipeline } from './ConversionPipeline';
+import type { TextmodeConverter } from './converters';
 /**
  * Options for initializing a {@link Textmodifier} instance.
  */
 export type TextmodeOptions = {
     /** The font size to use for text rendering. Defaults to 16. */
     fontSize?: number;
+    /**
+     * Automatic rendering mode. Defaults to 'auto'.
+     * - 'manual': Requires manual `render()` calls
+     * - 'auto': Automatically renders using requestAnimationFrame
+     */
+    renderMode?: 'manual' | 'auto';
+    /** Maximum frames per second for auto rendering. Defaults to 120. */
+    frameRate?: number;
 };
 /**
  * Main class for handling textmode rendering in a WebGL context.
@@ -18,18 +27,24 @@ export declare class Textmodifier {
     private textmodeCanvas;
     /** Core WebGL renderer */
     private renderer;
-    private asciiShader;
     private canvasFramebuffer;
-    private brightnessConverter;
-    private _fontManager;
+    private _font;
     private _grid;
     private resizeObserver;
-    private resultFramebuffer;
+    private _mode;
+    private _frameRateLimit;
+    private animationFrameId;
+    private lastFrameTime;
+    private frameInterval;
+    private _frameRate;
+    private lastRenderTime;
+    private _pipeline;
     private constructor();
     /**
      * Static factory method for creating and initializing a Textmodifier instance.
      * @param canvas The HTML canvas element to capture content from.
      * @param opts Optional configuration options for the `Textmodifier` instance.
+     * @ignore
      */
     static create(canvas: HTMLCanvasElement, opts?: TextmodeOptions): Promise<Textmodifier>;
     private setupEventListeners;
@@ -40,14 +55,40 @@ export declare class Textmodifier {
     loadFont(fontUrl: string): Promise<void>;
     /**
      * Apply textmode rendering to the canvas.
+     *
+     * **Note:** In `'auto'` mode, this is called automatically.
+     * In `'manual'` mode, you need to call this method when you want to update the rendering.
      */
     render(): void;
+    private resize;
     /**
-     * Set the global error handling level for the library. This applies to all `Textmodifier` instances.
-     * @param level The error handling level to set.
+     * Start automatic rendering
      */
-    setErrorLevel(level: TextmodeErrorLevel): void;
-    private resize;
+    private startAutoRendering;
+    /**
+     * Update FPS measurement - works for both auto and manual modes
+     */
+    private measureFrameRate;
+    /**
+     * Stop automatic rendering
+     */
+    private stopAutoRendering;
+    /**
+     * Change the rendering mode.
+     */
+    renderMode(mode?: 'manual' | 'auto'): void | 'auto' | 'manual';
+    /**
+     * Set the maximum frame rate for auto rendering. If called without arguments, returns the current measured frame rate.
+     * @param fps The maximum frames per second for auto rendering.
+     */
+    frameRate(fps?: number): number | void;
+    converter(): TextmodeConverter;
+    /** Get the current grid object used for rendering. */
     get grid(): TextmodeGrid;
-    get fontManager(): TextmodeFont;
+    /** Get the current font object used for rendering. */
+    get font(): TextmodeFont;
+    /** Get the current rendering mode.*/
+    get mode(): 'manual' | 'auto';
+    /** Get the current textmode conversion pipeline */
+    get pipeline(): TextmodeConversionPipeline;
 }

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

@@ -0,0 +1,23 @@
+import type { TextmodeFont } from "../Font";
+import type { Framebuffer } from "../../rendering/Framebuffer";
+import type { Renderer } from "../../rendering/Renderer";
+import type { TextmodeGrid } from "../Grid";
+export declare abstract class TextmodeConverter {
+    protected renderer: Renderer;
+    protected fontManager: TextmodeFont;
+    protected grid: TextmodeGrid;
+    protected _characterFramebuffer: Framebuffer;
+    protected _primaryColorFramebuffer: Framebuffer;
+    protected _secondaryColorFramebuffer: Framebuffer;
+    protected _rotationFramebuffer: Framebuffer;
+    protected _transformFramebuffer: Framebuffer;
+    protected options: any;
+    constructor(renderer: Renderer, fontManager: TextmodeFont, grid: TextmodeGrid, options?: any);
+    abstract convert(sourceFramebuffer: Framebuffer): void;
+    resize(): void;
+    get characterFramebuffer(): Framebuffer;
+    get primaryColorFramebuffer(): Framebuffer;
+    get secondaryColorFramebuffer(): Framebuffer;
+    get rotationFramebuffer(): Framebuffer;
+    get transformFramebuffer(): Framebuffer;
+}

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

@@ -1,21 +1,11 @@
 import { ColorPalette } from "../../ColorPalette";
 import type { TextmodeFont } from "../Font";
-import type { Framebuffer } from "../../rendering/Framebuffer";
 import type { Renderer } from "../../rendering/Renderer";
 import type { TextmodeGrid } from "../Grid";
-export declare class TextmodeFeatureConverter {
-    protected renderer: Renderer;
-    protected fontManager: TextmodeFont;
-    protected grid: TextmodeGrid;
-    protected _characterFramebuffer: Framebuffer;
-    protected _primaryColorFramebuffer: Framebuffer;
-    protected _secondaryColorFramebuffer: Framebuffer;
-    protected _rotationFramebuffer: Framebuffer;
-    protected _transformFramebuffer: Framebuffer;
+import { TextmodeConverter } from "./Converter";
+export declare abstract class TextmodeFeatureConverter extends TextmodeConverter {
     protected palette: ColorPalette;
-    protected options: any;
     constructor(renderer: Renderer, fontManager: TextmodeFont, grid: TextmodeGrid, options?: any);
-    resize(): void;
     characters(characters: string): void;
     characterColor(r: number, g?: number, b?: number, a?: number): void;
     characterColorMode(mode: "sampled" | "fixed"): void;
@@ -25,9 +15,4 @@ export declare class TextmodeFeatureConverter {
     rotation(angle: number): void;
     flipHorizontally(flip: boolean | number): void;
     flipVertically(flip: boolean | number): void;
-    get characterFramebuffer(): Framebuffer;
-    get primaryColorFramebuffer(): Framebuffer;
-    get secondaryColorFramebuffer(): Framebuffer;
-    get rotationFramebuffer(): Framebuffer;
-    get transformFramebuffer(): Framebuffer;
 }

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

@@ -0,0 +1,3 @@
+export { TextmodeConverter } from './Converter';
+export { TextmodeFeatureConverter } from './FeatureConverter';
+export { TextmodeBrightnessConverter } from './BrightnessConverter';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "textmode.js",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "Apply real-time ASCII conversion to any HTML canvas.",
   "type": "module",
   "types": "./dist/types/index.d.ts",
@@ -22,13 +22,14 @@
   },
   "devDependencies": {
     "@types/node": "^24.0.13",
-    "@types/p5": "^1.7.6",
     "@vitest/ui": "^3.1.2",
     "tslib": "^2.8.1",
     "typescript": "^5.8.3",
     "vite": "^6.3.4",
     "vite-plugin-glsl": "^1.5.1",
-    "vitest": "^3.1.2"
+    "vitest": "^3.1.2",
+    "typedoc": "^0.28.7",
+    "typedoc-plugin-markdown": "^4.7.0"
   },
   "repository": {
     "type": "git",
@@ -49,9 +50,5 @@
   "homepage": "https://github.com/humanbydefinition/textmode.js",
   "files": [
     "dist"
-  ],
-  "dependencies": {
-    "typedoc": "^0.28.7",
-    "typedoc-plugin-markdown": "^4.7.0"
-  }
+  ]
 }