Options
All
  • Public
  • Public/Protected
  • All
Menu

Options class for atlasify and maxrects-packer

class

Options

implements

{IOption}

Hierarchy

  • Options

Implements

  • IOption

Index

Constructors

constructor

  • new Options(name?: string, width?: number, height?: number, padding?: number, type?: string): Options
  • Creates an instance of Options.

    memberof

    Options

    Parameters

    • Default value name: string = "sprite"
    • Default value width: number = 2048
    • Default value height: number = 2048
    • Default value padding: number = 0
    • Default value type: string = "JsonHash"

    Returns Options

Properties

allowRotation

allowRotation: boolean = false

Allow 90-degree rotation while packing

type

{boolean}

memberof

Options

alphaTolerence

alphaTolerence: number = 0

Trim alpha with tolerence value

type

{number}

memberof

Options

border

border: number = 0

Controlling packer border to edge

type

{number}

memberof

Options

debug

debug: boolean = false

Draw debug info onto atlas

type

{boolean}

memberof

Options

Optional exclusiveTag

exclusiveTag: undefined | false | true

extrude

extrude: number = 0

Extrude amount of edge pixels, will automaticly trimAlpha first.

type

{number}

memberof

Options

groupFolder

groupFolder: boolean = false

Group sheets packing based on folder

type

{boolean}

memberof

Options

height

height: number

instant

instant: boolean = false

Instant mode will skip sorting and pack using given array order

type

{boolean}

memberof

Options

name

name: string

padding

padding: number

pot

pot: boolean = true

Atlas size shall be power of 2

type

{boolean}

memberof

Options

searchDummy

searchDummy: boolean = false

Search duplicated dummy sprites to reduce atlas element

type

{boolean}

memberof

Options

seperateFolder

seperateFolder: boolean = false

Seperate sheets packing based on folder

type

{boolean}

memberof

Options

smart

smart: boolean = true

Atlas will automaticly shrink to the smallest possible square

type

{boolean}

memberof

Options

square

square: boolean = false

Atlas size shall be square

type

{boolean}

memberof

Options

Optional tag

tag: undefined | false | true

trimAlpha

trimAlpha: boolean = false

Remove surrounding transparent pixels

type

{boolean}

memberof

Options

type

type: string

width

width: number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc