Class BpxFont

A method to create a font as an extension of an already defined font.

Example

const pico8FontWithExtraGlyphs = BpxFont.basedOn($font_pico8, baseFontConfig => ({
  ...baseFontConfig,
  glyphs: new Map<string, BpxGlyph>([
    ...baseFontConfig.glyphs,
    // additional glyphs defined here
  ]),
});
Copy

A method to create a font from scratch.

See

BpxFontConfig.ascent

See

BpxFontConfig.descent

See

BpxFontConfig.lineGap

A list of sprite sheets gathered from the all sprite glyphs defined for this font.

Useful for defining the assets to fetch in BeetPx.start

Example

$.start({
  // ...
  assets: [
    ...myFont.spriteSheetUrls
  ],
})
Copy

The main methods of the font, which iterates of the text segments (characters, but with a support for multi-char emojis, e.g. "❤️"), and arranges their corresponding glyphs in a virtual visual space.

The resulting array of BpxArrangedGlyph is further used by BeetPxDraw.measureText for a headless text rendering and by BeetPxDraw.text for an actual text rendering.

You rather doesn't have to use this method directly.