Skip to main content

Class: Options

Options class for atlasify and maxrects-packer

implements {IOption}

Implements​

  • IOption

Constructors​

constructor​

• new Options(name?, width?, height?, padding?, type?)

Creates an instance of Options.

memberof Options

Parameters​

NameTypeDefault value
namestring'sprite'
widthnumber2048
heightnumber2048
paddingnumber0
typestring"JsonHash"

Defined in​

atlasify.ts:133

Properties​

allowRotation​

• allowRotation: boolean = false

Allow 90-degree rotation while packing

memberof Options

Implementation of​

IOption.allowRotation

Defined in​

atlasify.ts:49

alphaTolerence​

• alphaTolerence: number = 0

Trim alpha with tolerence value

memberof Options

Defined in​

atlasify.ts:99

border​

• border: number = 0

Controlling packer border to edge

memberof Options

Implementation of​

IOption.border

Defined in​

atlasify.ts:57

debug​

• debug: boolean = false

Draw debug info onto atlas

memberof Options

Defined in​

atlasify.ts:115

exclusiveTag​

• Optional exclusiveTag: boolean

Implementation of​

IOption.exclusiveTag

Defined in​

atlasify.ts:83

extrude​

• extrude: number = 0

Extrude amount of edge pixels, will automaticly trimAlpha first.

memberof Options

Defined in​

atlasify.ts:107

groupFolder​

• groupFolder: boolean = false

Group sheets packing based on folder

memberof Options

Defined in​

atlasify.ts:82

height​

• height: number = 2048

instant​

• instant: boolean = false

Instant mode will skip sorting and pack using given array order

memberof Options

Defined in​

atlasify.ts:65

name​

• name: string = 'sprite'

padding​

• padding: number = 0

pot​

• pot: boolean = true

Atlas size shall be power of 2

memberof Options

Implementation of​

IOption.pot

Defined in​

atlasify.ts:33

searchDummy​

• searchDummy: boolean = false

Search duplicated dummy sprites to reduce atlas element

memberof Options

Defined in​

atlasify.ts:123

seperateFolder​

• seperateFolder: boolean = false

Seperate sheets packing based on folder

memberof Options

Defined in​

atlasify.ts:73

smart​

• smart: boolean = true

Atlas will automaticly shrink to the smallest possible square

memberof Options

Implementation of​

IOption.smart

Defined in​

atlasify.ts:25

square​

• square: boolean = false

Atlas size shall be square

memberof Options

Implementation of​

IOption.square

Defined in​

atlasify.ts:41

tag​

• Optional tag: boolean

Implementation of​

IOption.tag

Defined in​

atlasify.ts:74

trimAlpha​

• trimAlpha: boolean = false

Remove surrounding transparent pixels

memberof Options

Defined in​

atlasify.ts:91

type​

• type: string = "JsonHash"

width​

• width: number = 2048