Class Font

constructor

• new Font(
      source?: Readonly<
          Pick<
              Font,
              | typeof graphicsNative
              | "isSmooth"
              | typeof fontRevision
              | "getInfo"
              | "getGlyph"
              | "getGlyphById"
              | "hasGlyph"
              | "getKerning"
              | "getAscent"
              | "getDescent"
              | "getLineSpacing"
              | "getUnderlinePosition"
              | "getUnderlineThickness"
              | "getTexture",
          >,
      >,
  ): Font

  创建空字体，或从现有字体创建副本。

  Parameters

  • Optionalsource: Readonly<
        Pick<
            Font,
            | typeof graphicsNative
            | "isSmooth"
            | typeof fontRevision
            | "getInfo"
            | "getGlyph"
            | "getGlyphById"
            | "hasGlyph"
            | "getKerning"
            | "getAscent"
            | "getDescent"
            | "getLineSpacing"
            | "getUnderlinePosition"
            | "getUnderlineThickness"
            | "getTexture",
        >,
    >

  Returns Font

[fontRevision]

Readonly[graphicsNative]

getAscent

• getAscent(size: number): number

  返回指定像素字号的上升度量，单位为像素。

  Parameters

  • size: number

  Returns number

getDescent

• getDescent(size: number): number

  返回指定像素字号的下降度量，单位为像素。

  Parameters

  • size: number

  Returns number

getGlyph

• getGlyph(
      codePoint: number,
      characterSize: number,
      bold: boolean,
      outlineThickness?: number,
  ): ReadonlyValue<Glyph>

  获取 Unicode 码点对应的缓存字形；字号和轮廓厚度以像素计，bold 控制加粗。

  Parameters

  • codePoint: number
  • characterSize: number
  • bold: boolean
  • outlineThickness: number = 0

  Returns ReadonlyValue<Glyph>

getGlyphById

• getGlyphById(
      id: number,
      characterSize: number,
      bold: boolean,
      outlineThickness?: number,
  ): ReadonlyValue<Glyph>

  按字体内部字形编号取得字形；字号和轮廓厚度以像素计。

  Parameters

  • id: number
  • characterSize: number
  • bold: boolean
  • outlineThickness: number = 0

  Returns ReadonlyValue<Glyph>

getInfo

• getInfo(): FontInfo

  返回当前字体信息的只读视图。

  Returns FontInfo

getKerning

• getKerning(
      first: number,
      second: number,
      characterSize: number,
      bold?: boolean,
  ): number

  返回两个 Unicode 码点之间的字距调整量，单位为像素。

  Parameters

  • first: number
  • second: number
  • characterSize: number
  • bold: boolean = false

  Returns number

getLineSpacing

• getLineSpacing(size: number): number

  返回指定像素字号的推荐基线间距。

  Parameters

  • size: number

  Returns number

getTexture

• getTexture(characterSize: number): Readonly

  返回指定像素字号的字形图集只读纹理引用，后续加载字形可能更新其内容。

  Parameters

  • characterSize: number

  Returns Readonly

getUnderlinePosition

• getUnderlinePosition(size: number): number

  返回下划线相对基线的位置，单位为像素。

  Parameters

  • size: number

  Returns number

getUnderlineThickness

• getUnderlineThickness(size: number): number

  返回下划线厚度，单位为像素。

  Parameters

  • size: number

  Returns number

hasGlyph

• hasGlyph(codePoint: number): boolean

  返回字体是否包含指定 Unicode 码点的字形。

  Parameters

  • codePoint: number

  Returns boolean

isSmooth

• isSmooth(): boolean

  返回字体纹理是否启用平滑过滤。

  Returns boolean

openFromFile

• openFromFile(filename: string): Promise<boolean>

  异步打开字体文件，成功后替换字体并清空度量缓存，返回是否成功。

  Parameters

  • filename: string

  Returns Promise<boolean>

openFromMemory

• openFromMemory(data: Uint8Array): Promise<boolean>

  从编码字体字节异步打开字体，返回是否成功。

  Parameters

  • data: Uint8Array

  Returns Promise<boolean>

openFromStream

• openFromStream(stream: InputStream): Promise<boolean>

  从流起点读取全部字体字节并异步打开；返回是否成功，流异常会拒绝 Promise。

  Parameters

  • stream: InputStream

  Returns Promise<boolean>

setSmooth

• setSmooth(smooth: boolean): void

  设置字体纹理是否使用平滑过滤。

  Parameters

  • smooth: boolean

  Returns void