textmode.js 0.1.4-beta.2 → 0.1.4-beta.4

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

@@ -57,16 +57,17 @@ export declare class Textmodifier {
     private animationFrameId;
     private lastFrameTime;
     private frameInterval;
+    private _isLooping;
     private _frameRate;
     private lastRenderTime;
     private _frameCount;
     private frameTimeHistory;
     private frameTimeHistorySize;
     private _pipeline;
+    private _isDisposed;
     private _standalone;
     private _drawCallback;
     private _resizedCallback;
-    private _isDestroyed;
     private _windowResizeListener;
     private constructor();
     /**
@@ -332,6 +333,90 @@ export declare class Textmodifier {
      * ```
      */
     frameRate(fps?: number): number | void;
+    /**
+     * Stop the automatic rendering loop while keeping the render mode as 'auto'.
+     *
+     * This method pauses the render loop without changing the render mode, allowing
+     * it to be resumed later with {@link loop}. This is useful for temporarily pausing
+     * animation while maintaining the ability to restart it.
+     *
+     * **Note:** This only affects rendering when in `'auto'` mode. In `'manual'` mode,
+     * this method has no effect since rendering is already controlled manually.
+     *
+     * @example
+     * ```javascript
+     * // Create a textmodifier instance in auto mode
+     * const textmodifier = await textmode.create(canvas);
+     *
+     * // The render loop is running automatically
+     * console.log(textmodifier.isLooping()); // true
+     *
+     * // Stop the automatic rendering loop
+     * textmodifier.noLoop();
+     * console.log(textmodifier.isLooping()); // false
+     *
+     * // Resume the automatic rendering loop
+     * textmodifier.loop();
+     * console.log(textmodifier.isLooping()); // true
+     * ```
+     */
+    noLoop(): void;
+    /**
+     * Resume the automatic rendering loop if it was stopped by {@link noLoop}.
+     *
+     * This method restarts the render loop when in `'auto'` mode. If the render mode
+     * is `'manual'`, the loop state will be set but automatic rendering will not start
+     * until the mode is changed back to `'auto'`.
+     *
+     * @example
+     * ```javascript
+     * // Create a textmodifier instance
+     * const textmodifier = await textmode.create(canvas);
+     *
+     * // Stop the loop
+     * textmodifier.noLoop();
+     *
+     * // Resume the loop
+     * textmodifier.loop();
+     *
+     * // You can also use this pattern for conditional animation
+     * if (someCondition) {
+     *   textmodifier.loop();
+     * } else {
+     *   textmodifier.noLoop();
+     * }
+     * ```
+     */
+    loop(): void;
+    /**
+     * Check whether the textmodifier is currently running the automatic render loop.
+     *
+     * Returns `true` when both the render mode is `'auto'` AND the loop is active.
+     * Returns `false` when in `'manual'` mode or when {@link noLoop} has been called.
+     *
+     * @returns True if the automatic render loop is currently active, false otherwise.
+     *
+     * @example
+     * ```javascript
+     * const textmodifier = await textmode.create(canvas);
+     *
+     * // Check loop status in different states
+     * console.log(textmodifier.isLooping()); // true (auto mode, looping)
+     *
+     * textmodifier.noLoop();
+     * console.log(textmodifier.isLooping()); // false (auto mode, not looping)
+     *
+     * textmodifier.renderMode('manual');
+     * console.log(textmodifier.isLooping()); // false (manual mode)
+     *
+     * textmodifier.renderMode('auto');
+     * console.log(textmodifier.isLooping()); // false (auto mode, but loop was stopped)
+     *
+     * textmodifier.loop();
+     * console.log(textmodifier.isLooping()); // true (auto mode, looping)
+     * ```
+     */
+    isLooping(): boolean;
     /**
      * Set the font size used for rendering.
      * @param size The font size to set.
@@ -858,10 +943,11 @@ export declare class Textmodifier {
     get pipeline(): TextmodeConversionPipeline;
     /** Get the current frame count. */
     get frameCount(): number;
+    set frameCount(value: number);
     /** Get the width of the canvas. */
     get width(): number;
     /** Get the height of the canvas. */
     get height(): number;
-    /** Check if this Textmodifier instance has been destroyed. */
-    get isDestroyed(): boolean;
+    /** Check if the instance has been disposed/destroyed. */
+    get isDisposed(): boolean;
 }

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

@@ -47,10 +47,6 @@ export declare class TextmodeConverter {
      * This method is idempotent and safe to call multiple times.
      */
     dispose(): void;
-    /**
-     * Check if this converter has been disposed
-     */
-    get isDisposed(): boolean;
     /** Returns the framebuffer containing character data. */
     get characterFramebuffer(): Framebuffer;
     /** Returns the framebuffer containing primary color data. */

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

@@ -24,12 +24,12 @@ export declare abstract class TextmodeFeatureConverter extends TextmodeConverter
     /**
      * Sets the color of the characters affected by the converter.
      * This is only used when `characterColorMode` is set to `'fixed'`.
-     * @param r Red component (0-255).
+     * @param r Red component (0-255) or hex string (e.g., '#FF0000', '#F00', 'FF0000', 'F00').
      * @param g Green component (0-255).
      * @param b Blue component (0-255).
      * @param a Alpha component (0-255).
      */
-    characterColor(r: number, g?: number, b?: number, a?: number): void;
+    characterColor(r: number | string, g?: number, b?: number, a?: number): void;
     /**
      * Sets the character color mode.
      * - `'sampled'`: Uses sampled colors from the source texture.
@@ -40,12 +40,12 @@ export declare abstract class TextmodeFeatureConverter extends TextmodeConverter
     /**
      * Sets the cell color for all cells affected by the converter.
      * This is only used when `cellColorMode` is set to `'fixed'`.
-     * @param r Red component (0-255).
+     * @param r Red component (0-255) or hex string (e.g., '#FF0000', '#F00', 'FF0000', 'F00').
      * @param g Green component (0-255).
      * @param b Blue component (0-255).
      * @param a Alpha component (0-255).
      */
-    cellColor(r: number, g?: number, b?: number, a?: number): void;
+    cellColor(r: number | string, g?: number, b?: number, a?: number): void;
     /**
      * Sets the cell color mode.
      * - `'sampled'`: Uses sampled colors from the source texture.
@@ -73,4 +73,10 @@ export declare abstract class TextmodeFeatureConverter extends TextmodeConverter
      * @param flip If `true`, characters are flipped vertically. If `false`, no flip is applied.
      */
     flipVertically(flip: boolean | number): void;
+    /**
+     * 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;
 }

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

@@ -97,10 +97,6 @@ export declare class TextmodeFont {
      * This method is idempotent and safe to call multiple times.
      */
     dispose(): void;
-    /**
-     * Check if this font manager has been disposed
-     */
-    get isDisposed(): boolean;
     /** Returns the font size used for rendering. */
     get fontSize(): number;
     /** Returns the Typr.js font object. @ignore */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "textmode.js",
-  "version": "0.1.4-beta.2",
+  "version": "0.1.4-beta.4",
   "description": "Apply real-time ASCII conversion to any HTML canvas.",
   "type": "module",
   "types": "./dist/types/index.d.ts",
@@ -19,7 +19,7 @@
     }
   },
   "scripts": {
-    "dev": "vite",
+    "dev": "vite --port 5177 --host",
     "build": "vite build && vite build --mode min && tsc",
     "build:full": "vite build && tsc",
     "build:min": "vite build --mode min && tsc",