Type Alias SpriteAtlasFrame

One Frame of a Sprite Atlas JSON. The shape TexturePacker, Aseprite, Free Texture Packer and Phaser write: the frame's rectangle in the sheet, and flags for frames the packer rotated or trimmed.

type SpriteAtlasFrame = {
    filename?: string;
    frame: { h: number; w: number; x: number; y: number };
    rotated?: boolean;
    trimmed?: boolean;
}

Index

Properties

filename? frame rotated? trimmed?

Properties

`Optional` `Readonly`filename

filename?: string

Frame Name (the "JSON Array" layout; the "JSON Hash" layout keys frames by name instead).

`Readonly`frame

frame: { h: number; w: number; x: number; y: number }

Frame Rectangle in the Sheet (source pixels).

Type Declaration

Readonlyh: number

Height.
Readonlyw: number

Width.
Readonlyx: number

Left Edge.
Readonlyy: number

Top Edge.

`Optional` `Readonly`rotated

rotated?: boolean

Rotated by the Packer (not supported: export the sheet without rotation).

`Optional` `Readonly`trimmed

trimmed?: boolean

Trimmed by the Packer (frames of different sizes are each stretched to the particle size).

Type Alias SpriteAtlasFrame

Index

Properties

Properties

`Optional` `Readonly`filename

`Readonly`frame

Type Declaration

`Readonly`h: number

`Readonly`w: number

`Readonly`x: number

`Readonly`y: number

`Optional` `Readonly`rotated

`Optional` `Readonly`trimmed

Settings

On This Page

Type Alias SpriteAtlasFrame

Index

Properties

Properties

Optional Readonlyfilename

Readonlyframe

Type Declaration

Readonlyh: number

Readonlyw: number

Readonlyx: number

Readonlyy: number

Optional Readonlyrotated

Optional Readonlytrimmed

Settings

On This Page

`Optional` `Readonly`filename

`Readonly`frame

`Readonly`h: number

`Readonly`w: number

`Readonly`x: number

`Readonly`y: number

`Optional` `Readonly`rotated

`Optional` `Readonly`trimmed