asciify-engine 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 type ColorMode = 'grayscale' | 'fullcolor' | 'matrix' | 'accent';
 type RenderMode = 'ascii' | 'dots';
 type AnimationStyle = 'none' | 'wave' | 'pulse' | 'rain' | 'breathe' | 'sparkle' | 'glitch' | 'spiral' | 'typewriter' | 'scatter';
-type ArtStyle = 'classic' | 'particles' | 'letters' | 'claudeCode' | 'art' | 'terminal';
+type ArtStyle = 'classic' | 'particles' | 'letters' | 'claudeCode' | 'art' | 'terminal' | 'box' | 'lines';
 type HoverEffect = 'spotlight' | 'magnify' | 'repel' | 'glow' | 'colorShift';
 type HoverPreset = 'none' | 'subtle' | 'flashlight' | 'magnifier' | 'forceField' | 'neon' | 'fire' | 'ice';
 type SourceType = 'image' | 'video' | null;
@@ -24,6 +24,7 @@ interface AsciiOptions {
     hoverEffect: HoverEffect;
     hoverColor: string;
     artStyle: ArtStyle;
+    customText: string;
 }
 interface AsciiCell {
     char: string;
@@ -48,6 +49,8 @@ declare const CHARSETS: {
     readonly dots: " ⠁⠃⠇⡇⣇⣧⣷⣿";
     readonly letters: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
     readonly claudeCode: " ╔╗╚╝║═╠╣╦╩╬░▒▓█│─┌┐└┘├┤┬┴┼";
+    readonly box: " ▪◾◼■█";
+    readonly lines: " ˗‐–—―━";
 };
 type CharsetKey = keyof typeof CHARSETS;
 /**
@@ -95,7 +98,14 @@ declare function gifToAsciiFrames(buffer: ArrayBuffer, options: AsciiOptions, ta
 /**
  * Render an ASCII frame to a canvas context.
  * Supports both ASCII text mode and Dots mode.
- * Performance-critical: targets 60+ FPS with active hover effects.
+ * Always renders every cell at full quality.
+ *
+ * Performance strategy:
+ * - fillRect fast path for sub-6px text (30x faster than fillText)
+ * - Auto-scaling hover radius: at high cell counts, the hover area
+ *   is proportionally smaller so fewer cells compute hover effects
+ * - Hover bounding box early-exit skips cells outside the hover zone
+ *
  * @param time - elapsed time in seconds for animation effects
  * @param hoverPos - optional smoothed mouse position {x, y, intensity} for hover effect
  */
@@ -104,6 +114,26 @@ declare function renderFrameToCanvas(ctx: CanvasRenderingContext2D, frame: Ascii
     y: number;
     intensity?: number;
 } | null): void;
+interface AsciifySimpleOptions {
+    /** Character size in pixels. Default: 10 */
+    fontSize?: number;
+    /** Art style preset. Default: 'classic' */
+    style?: ArtStyle;
+    /** Extra options to merge on top of the preset */
+    options?: Partial<AsciiOptions>;
+}
+/**
+ * Convert an image/video/canvas element to ASCII art and render it onto a canvas.
+ *
+ * @example
+ * const img = document.querySelector('img');
+ * const canvas = document.querySelector('canvas');
+ * await asciify(img, canvas);
+ *
+ * @example with options
+ * await asciify(img, canvas, { fontSize: 8, style: 'letters' });
+ */
+declare function asciify(source: HTMLImageElement | HTMLVideoElement | HTMLCanvasElement | string, canvas: HTMLCanvasElement, { fontSize, style, options }?: AsciifySimpleOptions): Promise<void>;
 /**
  * Generate a self-contained HTML embed snippet for an ASCII image.
  * Features: canvas rendering, animation loop, hover effects.
@@ -115,4 +145,21 @@ declare function generateEmbedCode(frame: AsciiFrame, options: AsciiOptions, wid
  */
 declare function generateAnimatedEmbedCode(frames: AsciiFrame[], options: AsciiOptions, fps: number, width: number, height: number): string;
 
-export { ART_STYLE_PRESETS, type AnimationStyle, type ArtStyle, type AsciiCell, type AsciiFrame, type AsciiOptions, type AsciiResult, CHARSETS, type CharsetKey, type ColorMode, DEFAULT_OPTIONS, HOVER_PRESETS, type HoverEffect, type HoverPreset, type RenderMode, type SourceType, generateAnimatedEmbedCode, generateEmbedCode, gifToAsciiFrames, imageToAsciiFrame, renderFrameToCanvas, videoToAsciiFrames };
+interface WebGLRenderer {
+    render(frame: AsciiFrame, options: AsciiOptions, displayW: number, displayH: number, time: number, hoverPos?: {
+        x: number;
+        y: number;
+        intensity?: number;
+    } | null): void;
+    /** Call when options or the source frame has changed to invalidate cell data cache. */
+    notifyDirty(): void;
+    destroy(): void;
+}
+/**
+ * Try to create a WebGL2 renderer for the given canvas.
+ * Returns null if WebGL2 is unavailable (caller can then use Canvas2D).
+ * On setup failure after context is claimed, returns a stub that clears to dark.
+ */
+declare function tryCreateWebGLRenderer(canvas: HTMLCanvasElement): WebGLRenderer | null;
+
+export { ART_STYLE_PRESETS, type AnimationStyle, type ArtStyle, type AsciiCell, type AsciiFrame, type AsciiOptions, type AsciiResult, type AsciifySimpleOptions, CHARSETS, type CharsetKey, type ColorMode, DEFAULT_OPTIONS, HOVER_PRESETS, type HoverEffect, type HoverPreset, type RenderMode, type SourceType, type WebGLRenderer, asciify, generateAnimatedEmbedCode, generateEmbedCode, gifToAsciiFrames, imageToAsciiFrame, renderFrameToCanvas, tryCreateWebGLRenderer, videoToAsciiFrames };