Winter Cardinal UI - v0.457.0 / UtilSvgAtlasBuilder

Class: UtilSvgAtlasBuilder

Table of contents

Constructors

• constructor

Properties

• _built
• _frames
• _height
• _margin
• _mipmap
• _nextX
• _nextY
• _ratio
• _resolution
• _scaling
• _svg
• _width

Accessors

• mappings
• margin
• ratio
• width

Methods

• add
• build
• has

Constructors

constructor

• new UtilSvgAtlasBuilder(options): UtilSvgAtlasBuilder

Parameters

Name	Type
options	UtilSvgAtlasBuilderOptions

Returns

UtilSvgAtlasBuilder

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:40

Properties

_built

• Protected Optional _built: Record<string, Texture>

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:38

---

_frames

• Protected _frames: Record<string, Rectangle>

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:32

---

_height

• Protected _height: number

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:36

---

_margin

• Protected _margin: number

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:27

---

_mipmap

• Protected _mipmap: MIPMAP_MODES

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:30

---

_nextX

• Protected _nextX: number

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:34

---

_nextY

• Protected _nextY: number

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:35

---

_ratio

• Protected _ratio: number

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:26

---

_resolution

• Protected _resolution: number

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:28

---

_scaling

• Protected _scaling: SCALE_MODES

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:29

---

_svg

• Protected _svg: string

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:33

---

_width

• Protected _width: number

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:25

Accessors

mappings

• get mappings(): Record<string, Texture>

Returns

Record<string, Texture>

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:130

---

margin

• get margin(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:69

---

ratio

• get ratio(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:65

---

width

• get width(): number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:61

Methods

add

▸ add(name, width, height, path): boolean

Parameters

Name	Type
name	string
width	number
height	number
path	string

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:73

▸ add(name, width, height, path, frameX, frameY, frameWidth, frameHeight): boolean

Parameters

Name	Type
name	string
width	number
height	number
path	string
frameX	number
frameY	number
frameWidth	number
frameHeight	number

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:74

---

build

▸ build(options?): Record<string, Texture>

Parameters

Name	Type
options?	UtilSvgAtlasBuilderBuildOptions

Returns

Record<string, Texture>

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:134

---

has

▸ has(name): boolean

Parameters

Name	Type
name	string

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/util-svg-atlas-builder.ts:126

Edit this page.