Phaser.LoaderParser

new LoaderParser()

Phaser.LoaderParser parses data objects from Phaser.Loader that need more preparation before they can be inserted into the Cache.

Source - loader/LoaderParser.js, line 12

Methods

<static> bitmapFont(xml, baseTexture, xSpacing, ySpacing, frame, resolution)→ {object}

Alias for xmlBitmapFont, for backwards compatibility.

Name

Type

Argument

Default

Description

xml

object

XML data you want to parse.

baseTexture

PIXI.BaseTexture

The BaseTexture this font uses.

xSpacing

number

<optional>

0

Additional horizontal spacing between the characters.

ySpacing

number

<optional>

0

Additional vertical spacing between the characters.

frame

Phaser.Frame

<optional>

Optional Frame, if this font is embedded in a texture atlas.

resolution

number

<optional>

1

Optional game resolution to apply to the kerning data.

object-

The parsed Bitmap Font data.

Source - loader/LoaderParser.js, line 14

<static> dds(arrayBuffer)→ {object}

Extract DDS header from loaded binary

Name Type Description
arrayBuffer ArrayBuffer

object-

The parsed DDS file including texture data.

Source - loader/LoaderParser.js, line 288

<static> jsonBitmapFont(json, baseTexture, xSpacing, ySpacing, frame,resolution)→ {object}

Parse a Bitmap Font from a JSON file.

Name

Type

Argument

Default

Description

json

object

JSON data you want to parse.

baseTexture

PIXI.BaseTexture

The BaseTexture this font uses.

xSpacing

number

<optional>

0

Additional horizontal spacing between the characters.

ySpacing

number

<optional>

0

Additional vertical spacing between the characters.

frame

Phaser.Frame

<optional>

Optional Frame, if this font is embedded in a texture atlas.

resolution

number

<optional>

1

Optional game resolution to apply to the kerning data.

object-

The parsed Bitmap Font data.

Source - loader/LoaderParser.js, line 96

<static> ktx(arrayBuffer)→ {object}

Extract KTX header from loaded binary

Name Type Description
arrayBuffer ArrayBuffer

object-

The parsed KTX file including texture data.

Source - loader/LoaderParser.js, line 385

<static> pkm(arrayBuffer)→ {object}

Extract PKM header from loaded binary

Name Type Description
arrayBuffer ArrayBuffer

object-

The parsed PKM file including texture data.

Source - loader/LoaderParser.js, line 484

<static> pvr(arrayBuffer)→ {object}

Extract PVR header from loaded binary

Name Type Description
arrayBuffer ArrayBuffer

object-

The parsed PVR file including texture data.

Source - loader/LoaderParser.js, line 189

<static> xmlBitmapFont(xml, baseTexture, xSpacing, ySpacing, frame,resolution)→ {object}

Parse a Bitmap Font from an XML file.

Name

Type

Argument

Default

Description

xml

object

XML data you want to parse.

baseTexture

PIXI.BaseTexture

The BaseTexture this font uses.

xSpacing

number

<optional>

0

Additional horizontal spacing between the characters.

ySpacing

number

<optional>

0

Additional vertical spacing between the characters.

frame

Phaser.Frame

<optional>

Optional Frame, if this font is embedded in a texture atlas.

resolution

number

<optional>

1

Optional game resolution to apply to the kerning data.

object-

The parsed Bitmap Font data.

Source - loader/LoaderParser.js, line 32