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

  空のフォントを作成するか、既存フォントをコピーします。

  引数

  sourceオプション

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

  戻り値

  Font

  ソースと継承

getAscent

• getAscent(size: number): number

  指定ピクセル文字サイズでのアセントをピクセル単位で返します。

  引数

  size

  number

  戻り値

  number

  ソースと継承

getDescent

• getDescent(size: number): number

  指定ピクセル文字サイズでのディセントをピクセル単位で返します。

  引数

  size

  number

  戻り値

  number

  ソースと継承

getGlyph

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

  Unicode コードポイントのキャッシュ済みグリフを取得します。サイズと輪郭の太さはピクセル単位で、bold は太字化を制御します。

  引数

  codePoint

  number

  characterSize

  number

  bold

  boolean

  outlineThickness

  number = 0

  戻り値

  ReadonlyValue<Glyph>

  ソースと継承

getGlyphById

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

  フォント内部のグリフ番号でグリフを取得します。サイズと輪郭の太さはピクセル単位です。

  引数

  id

  number

  characterSize

  number

  bold

  boolean

  outlineThickness

  number = 0

  戻り値

  ReadonlyValue<Glyph>

  ソースと継承

getInfo

• getInfo(): FontInfo

  現在のフォント情報の読み取り専用ビューを返します。

  戻り値

  FontInfo

  ソースと継承

getKerning

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

  二つの Unicode コードポイント間のカーニング量をピクセル単位で返します。

  引数

  first

  number

  second

  number

  characterSize

  number

  bold

  boolean = false

  戻り値

  number

  ソースと継承

getLineSpacing

• getLineSpacing(size: number): number

  指定ピクセル文字サイズでの推奨ベースライン間隔を返します。

  引数

  size

  number

  戻り値

  number

  ソースと継承

getTexture

• getTexture(characterSize: number): Readonly

  指定ピクセル文字サイズのグリフアトラステクスチャへの読み取り専用参照を返します。後続のグリフ読み込みで内容が更新される場合があります。

  引数

  characterSize

  number

  戻り値

  Readonly

  ソースと継承

getUnderlinePosition

• getUnderlinePosition(size: number): number

  ベースラインに対する下線位置をピクセル単位で返します。

  引数

  size

  number

  戻り値

  number

  ソースと継承

getUnderlineThickness

• getUnderlineThickness(size: number): number

  下線の太さをピクセル単位で返します。

  引数

  size

  number

  戻り値

  number

  ソースと継承

hasGlyph

• hasGlyph(codePoint: number): boolean

  指定 Unicode コードポイントのグリフをフォントが含むかを返します。

  引数

  codePoint

  number

  戻り値

  boolean

  ソースと継承

isSmooth

• isSmooth(): boolean

  フォントテクスチャで平滑化フィルタリングが有効かを返します。

  戻り値

  boolean

  ソースと継承

openFromFile

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

  フォントファイルを非同期に開きます。成功時にフォントを置き換え、メトリクスキャッシュを消去します。成功したかを返します。

  引数

  filename

  string

  戻り値

  Promise<boolean>

  ソースと継承

openFromMemory

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

  エンコードされたフォントバイト列を非同期に開き、成功したかを返します。

  引数

  data

  Uint8Array

  戻り値

  Promise<boolean>

  ソースと継承

openFromStream

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

  ストリームの先頭からフォントの全バイトを読み、非同期に開きます。成功したかを返し、ストリーム例外では Promise が拒否されます。

  引数

  stream

  InputStream

  戻り値

  Promise<boolean>

  ソースと継承

setSmooth

• setSmooth(smooth: boolean): void

  フォントテクスチャに平滑化フィルタリングを使用するかを設定します。

  引数

  smooth

  boolean

  戻り値

  void

  ソースと継承

[fontRevision]

読み取り専用[graphicsNative]