Winter Cardinal UI - v0.457.0 / DynamicAtlas

Class: DynamicAtlas

Table of contents

Constructors

• constructor

Properties

• _baseTexture
• _canvas
• _idToDatum
• _isDirty
• _predefined
• _sortedData
• INSTANCE

Methods

• applyFrames
• begin
• calcCanvasWidth
• cleanup
• contains
• destroy
• end
• get
• getBaseTexture
• getDefaultTexture
• release
• renderFrames
• repack
• set
• toDirty
• updateFrames
• ITEM_COMPARATOR

Constructors

constructor

• new DynamicAtlas(resolution): DynamicAtlas

Parameters

Name	Type
resolution	number

Returns

DynamicAtlas

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:23

Properties

_baseTexture

• Protected _baseTexture: BaseTexture

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:19

---

_canvas

• Protected _canvas: HTMLCanvasElement

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:16

---

_idToDatum

• Protected _idToDatum: Record<string, DynamicAtlasItem>

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:18

---

_isDirty

• Protected _isDirty: boolean

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:20

---

_predefined

• Protected _predefined: Record<string, DynamicAtlasItem>

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:21

---

_sortedData

• Protected _sortedData: DynamicAtlasItem[]

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:17

---

INSTANCE

▪ Static Protected INSTANCE: null | DynamicAtlas

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:14

Methods

applyFrames

▸ applyFrames(data): void

Parameters

Name	Type
data	DynamicAtlasItem[]

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:82

---

begin

▸ begin(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:113

---

calcCanvasWidth

▸ calcCanvasWidth(data): number

Parameters

Name	Type
data	DynamicAtlasItem[]

Returns

number

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:89

---

cleanup

▸ cleanup(data): void

Parameters

Name	Type
data	DynamicAtlasItem[]

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:101

---

contains

▸ contains(id): boolean

Parameters

Name	Type
id	string

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:167

---

destroy

▸ destroy(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:207

---

end

▸ end(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:123

---

get

▸ get(id): null | DynamicAtlasItem

Parameters

Name	Type
id	string

Returns

null | DynamicAtlasItem

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:151

---

getBaseTexture

▸ getBaseTexture(): BaseTexture

Returns

BaseTexture

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:188

---

getDefaultTexture

▸ getDefaultTexture(): Texture

Returns

Texture

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:184

---

release

▸ release(id): void

Parameters

Name	Type
id	string

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:192

---

renderFrames

▸ renderFrames(width, height, data): void

Parameters

Name	Type
width	number
height	number
data	DynamicAtlasItem[]

Returns

void

Defined in

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

---

repack

▸ repack(forcibly?): void

Parameters

Name	Type
forcibly?	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:138

---

set

▸ set(id, item): undefined | DynamicAtlasItem

Parameters

Name	Type
id	string
item	DynamicAtlasItem

Returns

undefined | DynamicAtlasItem

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:171

---

toDirty

▸ toDirty(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:180

---

updateFrames

▸ updateFrames(width, data): number

Parameters

Name	Type
width	number
data	DynamicAtlasItem[]

Returns

number

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:43

---

ITEM_COMPARATOR

▸ ITEM_COMPARATOR(a, b): number

Parameters

Name	Type
a	DynamicAtlasItem
b	DynamicAtlasItem

Returns

number

Defined in

src/main/typescript/wcardinal/ui/util/dynamic-atlas.ts:214

Edit this page.