imagescript 1.3.1 → 3.1.0

package/dist/render/hinting.d.ts

@@ -0,0 +1,110 @@
+/*!
+ * TrueType hinting interpreter. Where the TrueType specification leaves details open, its behavior and parts of its
+ * logic follow FreeType's TrueType interpreter (src/truetype/ttinterp.c): fixed point rounding, original distances
+ * on the unscaled outline (IP, IUP, MDRP, MD), the IUP interpolation, the movement along near-perpendicular vectors
+ * and the tolerance of invalid references. Portions of this software are copyright © 2026 The FreeType Project
+ * (https://freetype.org). All rights reserved. FreeType License, see THIRD_PARTY_NOTICES.md and licenses/FTL.txt
+ */
+import { Font, PathCommand } from './font.js';
+interface Vector {
+    x: number;
+    y: number;
+}
+interface GraphicsState {
+    pv: Vector;
+    fv: Vector;
+    dv: Vector;
+    rp0: number;
+    rp1: number;
+    rp2: number;
+    zp0: number;
+    zp1: number;
+    zp2: number;
+    loop: number;
+    minimumDistance: number;
+    cvtCutIn: number;
+    singleWidthCutIn: number;
+    singleWidth: number;
+    deltaBase: number;
+    deltaShift: number;
+    autoFlip: boolean;
+    /** null: rounding off */
+    round: {
+        period: number;
+        phase: number;
+        threshold: number;
+    } | null;
+    instructControl: number;
+}
+interface Zone {
+    curX: Float64Array;
+    curY: Float64Array;
+    orgX: Float64Array;
+    orgY: Float64Array;
+    /** unscaled original positions (font units), measurements between original glyph points use them */
+    orusX: Float64Array;
+    orusY: Float64Array;
+    touchX: Uint8Array;
+    touchY: Uint8Array;
+    on: Uint8Array;
+    ends: number[];
+}
+interface FunctionDef {
+    code: Uint8Array;
+    start: number;
+    end: number;
+}
+/** state of a font at one size, after the font and control value programs ran */
+interface SizeState {
+    ppem: number;
+    /** 26.6 units per font unit */
+    scale: number;
+    /** the same as 16.16 fixed point number */
+    scaleFixed: number;
+    cvt: Float64Array;
+    storage: Int32Array;
+    state: GraphicsState;
+    twilight: Zone;
+    functions: Map<number, FunctionDef>;
+    instructions: Map<number, FunctionDef>;
+    /** set if the font and control value programs failed, the font is then rendered unhinted */
+    broken: boolean;
+}
+export interface HintedGlyph {
+    /** outline in pixels, relative to the pen position (y up) */
+    path: PathCommand[];
+    /** advance width in whole pixels */
+    advance: number;
+}
+/**
+ * Executes TrueType instructions for one font
+ */
+export declare class Hinter {
+    font: Font;
+    fpgm: Uint8Array;
+    prep: Uint8Array;
+    cvt: Int16Array;
+    maxStack: number;
+    maxStorage: number;
+    maxTwilight: number;
+    sizes: Map<number, SizeState>;
+    /** 26.6 units per font unit (16.16 fixed point) of the glyph being loaded */
+    private scaleFixed;
+    constructor(font: Font);
+    /** whether the font has hinting instructions (a font program, control value program or control values) */
+    get hasInstructions(): boolean;
+    private size;
+    /**
+     * Hints a glyph at a size
+     * @param size pixels per em
+     * @return the hinted outline, or null if the glyph can't be hinted (it is then rendered unhinted)
+     */
+    glyph(glyph: number, size: number): HintedGlyph | null;
+    /**
+     * Loads, scales and hints a glyph (recursively for composites)
+     * @return the glyph zone (with 4 phantom points after the outline points)
+     */
+    private load;
+    private phantoms;
+}
+export {};