three-text 0.2.13 → 0.2.14

package/dist/index.d.ts

@@ -1,24 +1,10 @@
-declare class Vec3 {
-    x: number;
-    y: number;
-    z: number;
-    constructor(x?: number, y?: number, z?: number);
-    set(x: number, y: number, z: number): Vec3;
-    clone(): Vec3;
-    copy(v: Vec3): Vec3;
-    add(v: Vec3): Vec3;
-    sub(v: Vec3): Vec3;
-    multiply(scalar: number): Vec3;
-    divide(scalar: number): Vec3;
-    length(): number;
-    lengthSq(): number;
-    normalize(): Vec3;
-    dot(v: Vec3): number;
-    cross(v: Vec3): Vec3;
-    distanceTo(v: Vec3): number;
-    distanceToSquared(v: Vec3): number;
-    equals(v: Vec3): boolean;
+interface HyphenationTrieNode {
+    patterns: number[] | null;
+    children: {
+        [char: string]: HyphenationTrieNode;
+    };
 }
+
 interface BoundingBox {
     min: {
         x: number;
@@ -32,13 +18,6 @@ interface BoundingBox {
     };
 }
 
-interface HyphenationTrieNode {
-    patterns: number[] | null;
-    children: {
-        [char: string]: HyphenationTrieNode;
-    };
-}
-
 type TextAlign = 'left' | 'center' | 'right' | 'justify';
 type TextDirection = 'ltr' | 'rtl';
 interface LineInfo {
@@ -156,6 +135,25 @@ interface ProcessedGeometry {
     triangles: Triangles;
     contours: number[][];
 }
+interface GlyphData {
+    geometry: ProcessedGeometry;
+    vertices: Float32Array;
+    normals: Float32Array;
+    indices: Uint32Array;
+    bounds: {
+        min: {
+            x: number;
+            y: number;
+            z: number;
+        };
+        max: {
+            x: number;
+            y: number;
+            z: number;
+        };
+    };
+    useCount: number;
+}
 interface PathInfo {
     start: number;
     count: number;
@@ -227,6 +225,13 @@ interface TextGeometryInfo {
     query(options: TextQueryOptions): TextRange[];
     coloredRanges?: ColoredRange[];
 }
+interface TextHandle extends TextGeometryInfo {
+    getLoadedFont(): LoadedFont | undefined;
+    getCacheStatistics(): any;
+    clearCache(): void;
+    measureTextWidth(text: string, letterSpacing?: number): number;
+    update(options: Partial<TextOptions>): Promise<TextHandle>;
+}
 interface ColorByRange {
     start: number;
     end: number;
@@ -319,48 +324,6 @@ interface LayoutOptions {
     shortLineThreshold?: number;
 }
 
-interface GlyphData {
-    geometry: ProcessedGeometry;
-    vertices: Float32Array;
-    normals: Float32Array;
-    indices: Uint16Array | Uint32Array;
-    bounds: {
-        min: Vec3;
-        max: Vec3;
-    };
-    useCount: number;
-}
-interface GlyphCacheStats {
-    hits: number;
-    misses: number;
-    totalGlyphs: number;
-    uniqueGlyphs: number;
-    cacheSize: number;
-    saved: number;
-    memoryUsage: number;
-}
-declare class GlyphCache {
-    private cache;
-    private head;
-    private tail;
-    private stats;
-    private maxCacheSize?;
-    constructor(maxCacheSizeMB?: number);
-    private getCacheKey;
-    has(fontId: string, glyphId: number, depth: number, removeOverlaps: boolean): boolean;
-    get(fontId: string, glyphId: number, depth: number, removeOverlaps: boolean): GlyphData | undefined;
-    set(fontId: string, glyphId: number, depth: number, removeOverlaps: boolean, glyph: GlyphData): void;
-    private calculateMemoryUsage;
-    private evictLRU;
-    private addToHead;
-    private removeNode;
-    private removeTail;
-    private moveToHead;
-    clear(): void;
-    getStats(): GlyphCacheStats;
-}
-declare const globalGlyphCache: GlyphCache;
-
 declare global {
     interface Window {
         hbjs?: any;
@@ -371,7 +334,10 @@ declare class Text {
     private static patternCache;
     private static hbInitPromise;
     private static fontCache;
+    private static fontCacheMemoryBytes;
+    private static maxFontCacheMemoryBytes;
     private static fontIdCounter;
+    private static stableStringify;
     private fontLoader;
     private loadedFont?;
     private currentFontId;
@@ -382,13 +348,12 @@ declare class Text {
     static setHarfBuzzPath(path: string): void;
     static setHarfBuzzBuffer(wasmBuffer: ArrayBuffer): void;
     static init(): Promise<HarfBuzzInstance>;
-    static create(options: TextOptions): Promise<TextGeometryInfo & Pick<Text, 'getLoadedFont' | 'getCacheStatistics' | 'clearCache' | 'measureTextWidth'> & {
-        update: (options: Partial<TextOptions>) => Promise<TextGeometryInfo & Pick<Text, 'getLoadedFont' | 'getCacheStatistics' | 'clearCache' | 'measureTextWidth'> & {
-            update: (options: Partial<TextOptions>) => Promise<any>;
-        }>;
-    }>;
+    static create(options: TextOptions): Promise<TextHandle>;
     private static resolveFont;
     private static loadAndCacheFont;
+    private static trackFontCacheAdd;
+    private static trackFontCacheRemove;
+    private static enforceFontCacheMemoryLimit;
     private static generateFontContentHash;
     private setLoadedFont;
     private loadFont;
@@ -402,9 +367,14 @@ declare class Text {
     getFontMetrics(): FontMetrics;
     static preloadPatterns(languages: string[], patternsPath?: string): Promise<void>;
     static registerPattern(language: string, pattern: HyphenationTrieNode): void;
+    static clearFontCache(): void;
+    static setMaxFontCacheMemoryMB(limitMB: number): void;
     getLoadedFont(): LoadedFont | undefined;
     measureTextWidth(text: string, letterSpacing?: number): number;
-    getCacheStatistics(): GlyphCacheStats | null;
+    getCacheStatistics(): (CacheStats & {
+        hitRate: number;
+        memoryUsageMB: number;
+    }) | null;
     clearCache(): void;
     private createGlyphAttributes;
     private resetHelpers;
@@ -466,4 +436,46 @@ declare class FontMetadataExtractor {
     static getFontMetrics(metrics: ExtractedMetrics): FontMetrics;
 }
 
-export { ColorByRange, ColorOptions, ColoredRange, CurveFidelityConfig, DEFAULT_CURVE_FIDELITY, ExtractedMetrics, FontMetadataExtractor, FontMetrics, GeometryOptimizationOptions, GlyphCache, GlyphCacheStats, GlyphData, GlyphGeometryInfo, HarfBuzzAPI, HarfBuzzBlob, HarfBuzzBuffer, HarfBuzzFace, HarfBuzzFont, HarfBuzzInstance, HarfBuzzModule, HyphenationPatternsMap, HyphenationTrieNode, LayoutOptions, LineInfo, LoadedFont, PathInfo, ProcessedGeometry, Text, TextAlign, TextDirection, TextGeometryInfo, TextOptions, TextQueryOptions, TextRange, Triangles, VariationAxis, VerticalMetrics, globalGlyphCache };
+interface LRUCacheOptions<K, V> {
+    maxEntries?: number;
+    maxMemoryBytes?: number;
+    calculateSize?: (value: V) => number;
+    onEvict?: (key: K, value: V) => void;
+}
+interface CacheStats {
+    hits: number;
+    misses: number;
+    evictions: number;
+    size: number;
+    memoryUsage: number;
+}
+declare class LRUCache<K, V> {
+    private cache;
+    private head;
+    private tail;
+    private stats;
+    private options;
+    constructor(options?: LRUCacheOptions<K, V>);
+    get(key: K): V | undefined;
+    has(key: K): boolean;
+    set(key: K, value: V): void;
+    delete(key: K): boolean;
+    clear(): void;
+    getStats(): CacheStats & {
+        hitRate: number;
+        memoryUsageMB: number;
+    };
+    keys(): K[];
+    get size(): number;
+    private evictIfNeeded;
+    private evictTail;
+    private addToHead;
+    private removeNode;
+    private removeTail;
+    private moveToHead;
+}
+
+declare const globalGlyphCache: LRUCache<string, GlyphData>;
+declare function createGlyphCache(maxCacheSizeMB?: number): LRUCache<string, GlyphData>;
+
+export { CacheStats, ColorByRange, ColorOptions, ColoredRange, CurveFidelityConfig, DEFAULT_CURVE_FIDELITY, ExtractedMetrics, FontMetadataExtractor, FontMetrics, GeometryOptimizationOptions, GlyphData, GlyphGeometryInfo, HarfBuzzAPI, HarfBuzzBlob, HarfBuzzBuffer, HarfBuzzFace, HarfBuzzFont, HarfBuzzInstance, HarfBuzzModule, HyphenationPatternsMap, HyphenationTrieNode, LayoutOptions, LineInfo, LoadedFont, PathInfo, ProcessedGeometry, Text, TextAlign, TextDirection, TextGeometryInfo, TextHandle, TextOptions, TextQueryOptions, TextRange, Triangles, VariationAxis, VerticalMetrics, createGlyphCache, globalGlyphCache };