restty 0.1.15 → 0.1.17

package/dist/app/atlas-builder.d.ts

@@ -1,9 +1,27 @@
+/**
+ * Metadata for constrained glyph rendering.
+ * - cp: Unicode code point
+ * - constraintWidth: target cell width constraint
+ * - variable: whether glyph can render at multiple widths
+ * - widths: set of all required cell widths for this glyph
+ */
 export type GlyphConstraintMeta = {
     cp: number;
     constraintWidth: number;
     variable?: boolean;
     widths?: Set<number>;
 };
+/**
+ * Context for constraint-based atlas building, primarily for Nerd Fonts symbol alignment.
+ * - cellW: cell width in pixels
+ * - cellH: cell height in pixels
+ * - yPad: vertical padding
+ * - baselineOffset: baseline offset adjustment
+ * - baselineAdjust: additional baseline adjustment
+ * - fontScale: scale factor for font rendering
+ * - nerdMetrics: Nerd Fonts specific layout metrics
+ * - fontEntry: reference to font entry object
+ */
 export type AtlasConstraintContext = {
     cellW: number;
     cellH: number;
@@ -60,6 +78,17 @@ type BuildAtlasDeps = {
         atlasScale: number;
     }) => boolean;
 };
+/**
+ * Parameters for font atlas building.
+ * - entry: font entry containing the font object and cached atlas
+ * - neededGlyphIds: set of glyph IDs required in the atlas
+ * - glyphMeta: optional constraint metadata for symbol font glyphs
+ * - fontSizePx: base font size in pixels
+ * - atlasScale: scaling factor for high-DPI rendering
+ * - fontIndex: index in the font fallback chain (0 = primary font)
+ * - constraintContext: optional constraint context for symbol alignment
+ * - deps: external dependencies for atlas building
+ */
 export type BuildFontAtlasParams = {
     entry: any;
     neededGlyphIds: Set<number>;
@@ -70,6 +99,14 @@ export type BuildFontAtlasParams = {
     constraintContext?: AtlasConstraintContext | null;
     deps: BuildAtlasDeps;
 };
+/**
+ * Result from font atlas building.
+ * - rebuilt: true if a new atlas was generated
+ * - atlas: the atlas object containing glyph metrics and bitmap
+ * - rgba: RGBA pixel data ready for WebGL upload
+ * - colorGlyphs: set of glyph IDs that are color emoji
+ * - preferNearest: whether to use nearest-neighbor texture filtering
+ */
 export type BuildFontAtlasResult = {
     rebuilt: boolean;
     atlas: any | null;
@@ -77,5 +114,6 @@ export type BuildFontAtlasResult = {
     colorGlyphs?: Set<number>;
     preferNearest: boolean;
 };
+/** Builds or reuses a font atlas, detecting when rebuild is needed based on glyph requirements, size changes, or constraint updates. */
 export declare function buildFontAtlasIfNeeded(params: BuildFontAtlasParams): BuildFontAtlasResult;
 export {};

package/dist/app/font-sources.d.ts

@@ -1,3 +1,5 @@
 import type { ResttyFontPreset, ResttyFontSource } from "./types";
+/** Default font fallback chain with JetBrains Mono, Nerd Fonts symbols, Noto symbols, color emoji, black emoji, and CJK support. */
 export declare const DEFAULT_FONT_SOURCES: ResttyFontSource[];
+/** Validates user-provided font sources or returns defaults based on preset (none returns empty array, otherwise default CDN fonts). */
 export declare function normalizeFontSources(sources: ResttyFontSource[] | undefined, preset: ResttyFontPreset | undefined): ResttyFontSource[];