Distance range used to generate the SDF bitmaps.
Array of supported fonts.
Maximum number of unique code points bitmaps this FontCatalog's
internal texture can store simultaneously.
FontCatalog's maximum glyph height (pixels).
FontCatalog's maximum glyph width (pixels).
FontCatalog's name.
If true, a replacement glyph is returned for every missing glyph.
FontCatalog's glyph size (pixels).
FontCatalog's type (sdf or msdf).
Array of supported Unicode blocks.
FontCatalog's URL.
Current internal loading state.
Internal WebGL Texture.
Internal WebGL Texture size.
Removes all loaded (and loading) assets.
Release all allocated resources.
Gets the best matched font for a specific character.
Character's Unicode code point.
Font name suggestion.
Best matched font.
Retrieves the loaded GlyphData for a specific character.
Returns undefined if the assets for this glyph haven't been loaded yet.
Character's Unicode code point.
Font to get this glyph from.
Specific FontStyle to get glyphs for.
GlyphData for this code point.
Retrieves the loaded GlyphData for the specified text.
Returns undefined if the assets for these glyphs haven't been loaded yet.
Input text.
Specific TextRenderStyle to get glyphs for.
Array containing the original letter case for the requested glyphs.
Array containing GlyphData for each character of the input text.
Loads the description file for a specific UnicodeBlock. This speeds up consequent calls
to FontCatalog.loadCharset() that require glyphs from this block to be loaded.
Requested UnicodeBlock.
Font to retrieve this Unicode block from.
FontStyle assets to load.
If true, all pages in this Unicode block will also be loaded.
Loaded Unicode Block json.
Loads all the required glyphs needed to render the input text. Character repetition will not be considered, and only styled assets (with applied font selection, style and variants) will be loaded.
Input text.
Specific TextRenderStyle for which glyphs will be loaded.
Promise containing an array of all loaded GlyphData for the input text.
Releases the description file for a specific UnicodeBlock (and all downloaded pages). Safe to call when no assets for this block have been loaded.
Requested UnicodeBlock.
Font to remove this Unicode block from.
FontStyle assets to remove.
Updates the internal WebGLRenderTarget. The update will copy the newly introduced glyphs since the previous update.
WebGLRenderer.
Update the info with the memory footprint caused by objects owned by the FontCatalog.
The info object to increment with the values from this FontCatalog.
Loads a FontCatalog.
Maximum number of unique code points bitmaps this FontCatalog's
internal texture can store simultaneously.
FontCatalog Promise.
Generated using TypeDoc
Collection of font assets used to render glyphs when using a TextCanvas.
A
FontCatalogworks as a stack of SDF bitmap fonts (using the BMFont format) designed to cover the widest Unicode code point range possible. In order to manage all these assets elegantly, the assets inside theFontCatalogare stored on a per-Unicode-Block basis, and assets for a block are only loaded once a glyph belonging to that block is requested.Bitmap information coming from all different fonts is then stored in a unified WebGL GPU Texture resource, which can be sampled to render all currently loaded glyphs.