API / PixiTextureAtlasData

Class: PixiTextureAtlasData

Defined in: pixi/PixiTextureAtlasData.ts:35

The PixiJS texture atlas data.

Extends

• TextureAtlasData

Constructors

Constructor

new PixiTextureAtlasData(): PixiTextureAtlasData;

Returns

PixiTextureAtlasData

Inherited from

TextureAtlasData.constructor

Properties

hashCode

readonly hashCode: number;

Defined in: core/BaseObject.ts:156

A unique identification number assigned to the object.

Inherited from

TextureAtlasData.hashCode

---

imagePath

imagePath: string;

Defined in: model/TextureAtlasData.ts:66

The image path of the texture atlas.

Inherited from

TextureAtlasData.imagePath

---

name

name: string;

Defined in: model/TextureAtlasData.ts:58

The texture atlas name.

Inherited from

TextureAtlasData.name

Accessors

renderTexture

Get Signature

get renderTexture(): Texture<TextureSource<any>>;

Defined in: pixi/PixiTextureAtlasData.ts:66

The PixiJS texture.

Returns

Texture<TextureSource<any>>

Set Signature

set renderTexture(value: Texture<TextureSource<any>>): void;

Defined in: pixi/PixiTextureAtlasData.ts:70

Parameters

Parameter	Type
value	Texture<TextureSource<any>>

Returns

void

Methods

addTexture()

addTexture(value: TextureData): void;

Defined in: model/TextureAtlasData.ts:117

Internal

Parameters

Parameter	Type
value	TextureData

Returns

void

Inherited from

TextureAtlasData.addTexture

---

createTexture()

createTexture(): TextureData;

Defined in: pixi/PixiTextureAtlasData.ts:55

Internal

Returns

TextureData

Overrides

TextureAtlasData.createTexture

---

returnToPool()

returnToPool(): void;

Defined in: core/BaseObject.ts:167

Clear the object and return it back to object pool。

Returns

void

Inherited from

TextureAtlasData.returnToPool

---

borrowObject()

static borrowObject<T>(objectConstructor: () => T): T;

Defined in: core/BaseObject.ts:136

Get an instance of the specify class from object pool.

Type Parameters

Type Parameter
T extends BaseObject

Parameters

Parameter	Type	Description
objectConstructor	() => T	The specify class.

Returns

T

Inherited from

TextureAtlasData.borrowObject

---

clearPool()

static clearPool(objectConstructor: typeof BaseObject): void;

Defined in: core/BaseObject.ts:111

Clear the cached instances of a specify object pool.

Parameters

Parameter	Type	Default value	Description
objectConstructor	typeof BaseObject	null	Specify class. (Clear all cached instances if not set)

Returns

void

Inherited from

TextureAtlasData.clearPool

---

setMaxCount()

static setMaxCount(objectConstructor: typeof BaseObject, maxCount: number): void;

Defined in: core/BaseObject.ts:72

Set the maximum cache count of the specify object pool.

Parameters

Parameter	Type	Description
objectConstructor	typeof BaseObject	The specify class. (Set all object pools max cache count if not set)
maxCount	number	Max count.

Returns

void

Inherited from

TextureAtlasData.setMaxCount

---

toString()

static toString(): string;

Defined in: pixi/PixiTextureAtlasData.ts:36

Returns

string

Overrides

TextureAtlasData.toString