PixiBitmapFontManager

PixiBitmapFontManager

PixiBitmapFontManager loads fnt/xml files (using fetch), from the "bitmapFont" resources of the game.

It installs the "BitmapFont" with PixiJS to be used with PIXI.BitmapText.

Constructor

new PixiBitmapFontManager(resources, imageManager)

Parameters:
Name Type Description
resources

The resources data of the game.

imageManager

The image manager to be used to get textures used by fonts.

Source:

Methods

getDefaultBitmapFont()

Get the instance of the default Pixi.BitmapFont, always available.

Source:

loadBitmapFontData()

Load the "bitmapFont" resources of the game, so that they are ready to be used when obtainBitmapFont is called.

Source:

obtainBitmapFont()

Given a bitmap font resource name and a texture atlas resource name, returns the PIXI.BitmapFont for it. The font is register and should be released with releaseBitmapFont - so that it can be removed from memory when unused.

Source:

releaseBitmapFont(bitmapFontInstallKey)

When a font is not used by an object anymore (object destroyed or font changed), call this function to decrease the internal count of objects using the font.

When a font is not unused anymore, it goes in a temporary cache. The cache holds up to 10 fonts. If the cache reaches its maximum capacity, the oldest font is uninstalled from memory.

Parameters:
Name Type Description
bitmapFontInstallKey

Name of the font of the BitmapFont (bitmapFont.font)

Source:

setResources(resources)

Update the resources data of the game. Useful for hot-reloading, should not be used otherwise.

Parameters:
Name Type Description
resources

The resources data of the game.

Source: