textmode.js 0.0.1 → 0.0.2

package/dist/types/{FontManager.d.ts → textmode/Font.d.ts}

@@ -1,11 +1,22 @@
-import type { Renderer } from './renderer/Renderer.ts';
-import type { Framebuffer } from './renderer/Framebuffer.ts';
-export interface FontCharacter {
+import type { Renderer } from '../rendering/Renderer.ts';
+import type { Framebuffer } from '../rendering/Framebuffer.ts';
+/**
+ * Represents a single character in the textmode font.
+ */
+export type TextmodeCharacter = {
+    /** The character itself. */
     character: string;
+    /** The Unicode code point of the character. */
     unicode: number;
+    /** The RGB color associated with the character for identification. */
     color: [number, number, number];
-}
-export declare class FontManager {
+};
+/**
+ * Manages the textmode font used for rendering characters.
+ *
+ * This class handles loading the font, creating a texture atlas, and providing character color information.
+ */
+export declare class TextmodeFont {
     private _font;
     private _characters;
     private _fontFramebuffer;
@@ -22,11 +33,13 @@ export declare class FontManager {
      * Creates a new FontManager instance
      * @param renderer Renderer instance for texture creation
      * @param fontSize Font size to use for the texture atlas
+     * @ignore
      */
     constructor(renderer: Renderer, fontSize?: number);
     /**
      * Initializes the font manager by loading the font and creating the texture atlas
      * @returns Promise that resolves when initialization is complete
+     * @ignore
      */
     initialize(): Promise<void>;
     /**
@@ -41,30 +54,51 @@ export declare class FontManager {
      * Creates the texture atlas containing all characters
      */
     private _createTextureAtlas;
+    /**
+     * Get the color associated with a character.
+     * @param character The character to get the color for.
+     * @returns The RGB color as an array `[r, g, b]`.
+     */
     getCharacterColor(character: string): [number, number, number];
+    /**
+     * Get the colors associated with a string of characters.
+     * @param characters The string of characters to get colors for.
+     * @returns An array of RGB colors for each character in the string.
+     * Each color is represented as an array `[r, g, b]`.
+     */
     getCharacterColors(characters: string): [number, number, number][];
+    /**
+     * Checks if all characters in the given string exist in the font.
+     * @param str The string to check.
+     * @returns `true` if all characters exist in the font, `false` otherwise.
+     */
+    hasAllCharacters(str: string): boolean;
     /**
      * Updates the font by loading a new font file and regenerating all related properties
      * @param fontPath Path to the .otf or .ttf font file
      * @param fontSize Optional new font size (defaults to current fontSize)
      * @returns Promise that resolves when font update is complete
+     * @ignore
      */
     loadFont(fontPath: string): Promise<void>;
+    /**
+     * Returns the WebGL framebuffer containing the font texture atlas.
+     * @ignore
+     */
     get fontFramebuffer(): Framebuffer;
-    get textureWidth(): number;
-    get textureHeight(): number;
-    get textureCanvas(): HTMLCanvasElement;
-    get characters(): FontCharacter[];
+    /** Returns the array of {@link TextmodeCharacter} objects in the font. */
+    get characters(): TextmodeCharacter[];
+    /** Returns a string representation of all characters in the font.*/
     get charactersString(): string;
+    /** Returns the number of columns in the texture atlas.*/
     get textureColumns(): number;
+    /** Returns the number of rows in the texture atlas. */
     get textureRows(): number;
+    /** Returns the maximum dimensions of a glyph in the font. */
     get maxGlyphDimensions(): {
         width: number;
         height: number;
     };
+    /** Returns the font size used for rendering. */
     get fontSize(): number;
-    get textureDimensions(): {
-        width: number;
-        height: number;
-    };
 }

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

@@ -1,5 +1,5 @@
 /**
- * Manages the grid for the ASCII rendering pipeline of a Textmodifier instance.
+ * Manages the grid for the ASCII rendering pipeline of a {@link Textmodifier} instance.
  */
 export declare class TextmodeGrid {
     /** The number of columns in the grid. */

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

@@ -1,7 +1,16 @@
-export interface TextModeOptions {
+import { TextmodeFont } from './Font';
+import { TextmodeGrid } from './Grid';
+import { TextmodeErrorLevel } from '../errors';
+/**
+ * Options for initializing a {@link Textmodifier} instance.
+ */
+export type TextmodeOptions = {
+    /** The font size to use for text rendering. Defaults to 16. */
     fontSize?: number;
-}
-export type TextmodifierInitializationState = 'pending' | 'initialized' | 'failed';
+};
+/**
+ * Main class for handling textmode rendering in a WebGL context.
+ */
 export declare class Textmodifier {
     /** The canvas element to capture content from */
     private captureCanvas;
@@ -12,26 +21,33 @@ export declare class Textmodifier {
     private asciiShader;
     private canvasFramebuffer;
     private brightnessConverter;
-    private fontManager;
-    private grid;
+    private _fontManager;
+    private _grid;
     private resizeObserver;
     private resultFramebuffer;
-    private initialized;
-    constructor(canvas: HTMLCanvasElement, opts?: TextModeOptions);
+    private constructor();
     /**
-     * Initialize the textmodifier. Must be called before using render().
+     * 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.
      */
-    initialize(): Promise<void>;
+    static create(canvas: HTMLCanvasElement, opts?: TextmodeOptions): Promise<Textmodifier>;
+    private setupEventListeners;
     /**
-     * Check if the textmodifier is ready for use
+     * Update the font used for rendering.
+     * @param fontUrl The URL of the font to load.
      */
-    isInitialized(): boolean;
+    loadFont(fontUrl: string): Promise<void>;
     /**
-     * Static factory method for creating and initializing a Textmodifier instance
+     * Apply textmode rendering to the canvas.
      */
-    static create(canvas: HTMLCanvasElement, opts?: TextModeOptions): Promise<Textmodifier>;
-    private setupEventListeners;
-    loadFont(fontUrl: string): Promise<void>;
     render(): void;
+    /**
+     * Set the global error handling level for the library. This applies to all `Textmodifier` instances.
+     * @param level The error handling level to set.
+     */
+    setErrorLevel(level: TextmodeErrorLevel): void;
     private resize;
+    get grid(): TextmodeGrid;
+    get fontManager(): TextmodeFont;
 }

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

@@ -1,9 +1,8 @@
-import { Renderer } from "../../renderer/Renderer";
-import { Framebuffer } from "../../renderer/Framebuffer";
-import { ColorPalette } from "../../ColorPalette";
-import { FontManager } from "../../FontManager";
+import { Renderer } from "../../rendering/Renderer";
+import { Framebuffer } from "../../rendering/Framebuffer";
+import { TextmodeFont } from "../Font";
 import { TextmodeGrid } from "../Grid";
-import { Converter } from "./Converter";
+import { TextmodeFeatureConverter } from "./FeatureConverter";
 export declare const BRIGHTNESS_DEFAULT_OPTIONS: {
     /** Enable/disable the renderer */
     enabled: boolean;
@@ -28,23 +27,12 @@ export declare const BRIGHTNESS_DEFAULT_OPTIONS: {
     /** Range of brightness values to map to ASCII characters */
     brightnessRange: [number, number];
 };
-export declare class BrightnessConverter extends Converter {
+export declare class TextmodeBrightnessConverter extends TextmodeFeatureConverter {
     private sampleShader;
     private charMappingShader;
     sampleFramebuffer: Framebuffer;
-    palette: ColorPalette;
-    private options;
-    constructor(renderer: Renderer, fontManager: FontManager, grid: TextmodeGrid);
+    constructor(renderer: Renderer, fontManager: TextmodeFont, grid: TextmodeGrid);
     convert(framebuffer: Framebuffer): void;
     resize(): void;
-    characters(characters: string): void;
-    characterColor(r: number, g?: number, b?: number, a?: number): void;
-    characterColorMode(mode: "sampled" | "fixed"): void;
-    backgroundColor(r: number, g?: number, b?: number, a?: number): void;
-    backgroundColorMode(mode: "sampled" | "fixed"): void;
-    invert(invert: boolean): void;
-    rotation(angle: number): void;
-    flipHorizontally(flip: boolean): void;
-    flipVertically(flip: boolean): void;
     brightnessRange(range: [number, number]): void;
 }

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

@@ -0,0 +1,33 @@
+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;
+    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;
+    backgroundColor(r: number, g?: number, b?: number, a?: number): void;
+    backgroundColorMode(mode: "sampled" | "fixed"): void;
+    invert(invert: boolean | number): void;
+    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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "textmode.js",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Apply real-time ASCII conversion to any HTML canvas.",
   "type": "module",
   "types": "./dist/types/index.d.ts",
@@ -16,6 +16,8 @@
   "scripts": {
     "dev": "vite",
     "build": "vite build && tsc",
+    "build-docs": "typedoc",
+    "dev-docs": "typedoc --watch",
     "preview": "vite preview"
   },
   "devDependencies": {
@@ -47,5 +49,9 @@
   "homepage": "https://github.com/humanbydefinition/textmode.js",
   "files": [
     "dist"
-  ]
+  ],
+  "dependencies": {
+    "typedoc": "^0.28.7",
+    "typedoc-plugin-markdown": "^4.7.0"
+  }
 }

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

@@ -1,21 +0,0 @@
-import type { FontManager } from "../../FontManager";
-import type { Framebuffer } from "../../renderer/Framebuffer";
-import type { Renderer } from "../../renderer/Renderer";
-import type { TextmodeGrid } from "../Grid";
-export declare class Converter {
-    protected renderer: Renderer;
-    protected fontManager: FontManager;
-    protected grid: TextmodeGrid;
-    protected _characterFramebuffer: Framebuffer;
-    protected _primaryColorFramebuffer: Framebuffer;
-    protected _secondaryColorFramebuffer: Framebuffer;
-    protected _rotationFramebuffer: Framebuffer;
-    protected _transformFramebuffer: Framebuffer;
-    constructor(renderer: Renderer, fontManager: FontManager, grid: TextmodeGrid);
-    resize(): void;
-    get characterFramebuffer(): Framebuffer;
-    get primaryColorFramebuffer(): Framebuffer;
-    get secondaryColorFramebuffer(): Framebuffer;
-    get rotationFramebuffer(): Framebuffer;
-    get transformFramebuffer(): Framebuffer;
-}