PixiJS

Interface: IBitmapFontOptions

PIXI.IBitmapFontOptions

Properties:
Name Type Default Description
alphaMode PIXI.ALPHA_MODES PIXI.BaseTexture.defaultOptions.alphaMode

Pre multiply the image alpha. Note: for MSDF/SDF fonts, alphaMode is not supported.
anisotropicLevel number PIXI.BaseTexture.defaultOptions.anisotropicLevel

Anisotropic filtering level of texture.
chars string | (string | string[])[] PIXI.BitmapFont.ALPHANUMERIC

Characters included in the font set. You can also use ranges. For example, [['a', 'z'], ['A', 'Z'], "!@#$%^&*()~{}[] "]. Don't forget to include spaces ' ' in your character set!
mipmap PIXI.MIPMAP_MODES PIXI.BaseTexture.defaultOptions.mipmap

If mipmapping is enabled for texture. For instance, by default PixiJS only enables mipmapping on Power-of-Two textures. If your textureWidth or textureHeight are not power-of-two, you may consider enabling mipmapping to get better quality with lower font sizes. Note: for MSDF/SDF fonts, mipmapping is not supported.
padding number 4

Padding between glyphs on texture atlas. Lower values could mean more visual artifacts and bleeding from other glyphs, larger values increase the space required on the texture.
resolution number 1

Render resolution for glyphs.
scaleMode PIXI.SCALE_MODES PIXI.BaseTexture.defaultOptions.scaleMode

Default scale mode, linear, nearest. Nearest can be helpful for bitmap-style fonts.
skipKerning boolean false

Skip generation of kerning information for the BitmapFont. If true, this could potentially increase the performance, but may impact the rendered text appearance.
textureHeight number 512

Optional height of atlas, smaller values to reduce memory.
textureWidth number 512

Optional width of atlas, smaller values to reduce memory.

Extends

  • BaseOptions

Members

alphaMode PIXI.ALPHA_MODES

Pre multiply the image alpha. Note: for MSDF/SDF fonts, alphaMode is not supported.

Default Value:
  • PIXI.BaseTexture.defaultOptions.alphaMode

anisotropicLevel number

Anisotropic filtering level of texture.

Default Value:
  • PIXI.BaseTexture.defaultOptions.anisotropicLevel

chars string | (string | string[])[]

Characters included in the font set. You can also use ranges. For example, [['a', 'z'], ['A', 'Z'], "!@#$%^&*()~{}[] "]. Don't forget to include spaces ' ' in your character set!

Default Value:
  • PIXI.BitmapFont.ALPHANUMERIC

mipmap PIXI.MIPMAP_MODES

If mipmapping is enabled for texture. For instance, by default PixiJS only enables mipmapping on Power-of-Two textures. If your textureWidth or textureHeight are not power-of-two, you may consider enabling mipmapping to get better quality with lower font sizes. Note: for MSDF/SDF fonts, mipmapping is not supported.

Default Value:
  • PIXI.BaseTexture.defaultOptions.mipmap

padding number

Padding between glyphs on texture atlas. Lower values could mean more visual artifacts and bleeding from other glyphs, larger values increase the space required on the texture.

Default Value:
  • 4

resolution number

Render resolution for glyphs.

Default Value:
  • 1

scaleMode PIXI.SCALE_MODES

Default scale mode, linear, nearest. Nearest can be helpful for bitmap-style fonts.

Default Value:
  • PIXI.BaseTexture.defaultOptions.scaleMode

skipKerning boolean

Skip generation of kerning information for the BitmapFont. If true, this could potentially increase the performance, but may impact the rendered text appearance.

Default Value:
  • false

textureHeight number

Optional height of atlas, smaller values to reduce memory.

Default Value:
  • 512

textureWidth number

Optional width of atlas, smaller values to reduce memory.

Default Value:
  • 512