Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DynamicFont

ビットマップフォントを逐次生成するフォント。

Hierarchy

Implements

Index

Constructors

constructor

  • 各種パラメータを指定して DynamicFont のインスタンスを生成する。

    Parameters

    Returns DynamicFont

Properties

Private _atlasSet

_atlasSet: SurfaceAtlasSet

Private _destroyed

_destroyed: boolean

Private _glyphFactory

_glyphFactory: GlyphFactory

Private _glyphs

_glyphs: object

Type declaration

Private _isSurfaceAtlasSetOwner

_isSurfaceAtlasSetOwner: boolean

Private _resourceFactory

_resourceFactory: ResourceFactory

fontColor

fontColor: string

フォント色。CSS Colorで指定する。

default

"black"

fontFamily

fontFamily: FontFamily | string | (string | SansSerif | Serif | Monospace)[]

フォントファミリ。

このプロパティは読み出し専用である。

fontWeight

fontWeight: FontWeight

フォントウェイト。

default

FontWeight.Normal

hint

ヒント。

size

size: number

フォントサイズ。

strokeColor

strokeColor: string

輪郭色。CSS Colorで指定する。

default

"black"

strokeOnly

strokeOnly: boolean

文字の輪郭のみを描画するか切り替える。 true を指定した場合、輪郭のみ描画される。 false を指定した場合、文字と輪郭が描画される。

default

false

strokeWidth

strokeWidth: number

輪郭幅。 0 以上の数値でなければならない。 0 を指定した場合、輪郭は描画されない。

default

0

Methods

asBitmapFont

  • asBitmapFont(missingGlyphChar?: string): BitmapFont
  • BtimapFontの生成。

    実装上の制限から、このメソッドを呼び出す場合、maxAtlasNum が 1 または undefined/null(1として扱われる) である必要がある。 そうでない場合、失敗する可能性がある。

    Parameters

    • Optional missingGlyphChar: string

    Returns BitmapFont

destroy

  • destroy(): void

destroyed

  • destroyed(): boolean

glyphForCharacter

  • glyphForCharacter(code: number): Glyph
  • グリフの取得。

    取得に失敗するとnullが返る。

    取得に失敗した時、次のようにすることで成功するかもしれない。

    • DynamicFont生成時に指定する文字サイズを小さくする
    • アトラスの初期サイズ・最大サイズを大きくする

    Parameters

    • code: number

      文字コード

    Returns Glyph

measureText

  • 対象の文字列を一行で描画した際の計測情報を返す。

    Parameters

    • text: string

      文字列

    Returns TextMetrix

Generated using TypeDoc