2021-05-11 18:30:36 -07:00

4.1 KiB
Raw Permalink Blame History

Planck.js API Doc › Globals › Pool

Class: Pool ‹T›

Type parameters

▪ T

Hierarchy

  • Pool

Index

Constructors

Properties

Methods

Constructors

constructor

+ new Pool(opts: object): Pool

Defined in src/util/Pool.ts:31

Parameters:

▪ opts: object

Name Type
allocate? function
create? function
discard? function
max? number
release? function

Returns: Pool

Properties

_createCount

• _createCount: number = 0

Defined in src/util/Pool.ts:28


_createFn

• _createFn: function

Defined in src/util/Pool.ts:23

Type declaration:

▸ (): T


_discardCount

• _discardCount: number = 0

Defined in src/util/Pool.ts:31


_discardFn

• _discardFn: function

Defined in src/util/Pool.ts:26

Type declaration:

▸ (item: T): T

Parameters:

Name Type
item T

_inCount

• _inCount: number = 0

Defined in src/util/Pool.ts:30


_inFn

• _inFn: function

Defined in src/util/Pool.ts:25

Type declaration:

▸ (item: T): void

Parameters:

Name Type
item T

_list

• _list: T[] = []

Defined in src/util/Pool.ts:20


_max

• _max: number = Infinity

Defined in src/util/Pool.ts:21


_outCount

• _outCount: number = 0

Defined in src/util/Pool.ts:29


_outFn

• _outFn: function

Defined in src/util/Pool.ts:24

Type declaration:

▸ (item: T): void

Parameters:

Name Type
item T

Methods

allocate

▸ allocate(): T

Defined in src/util/Pool.ts:61

Returns: T


max

▸ max(n?: number): number | Pool‹T›

Defined in src/util/Pool.ts:49

Parameters:

Name Type
n? number

Returns: number | Pool‹T›


release

▸ release(item: T): void

Defined in src/util/Pool.ts:81

Parameters:

Name Type
item T

Returns: void


size

▸ size(): number

Defined in src/util/Pool.ts:57

Returns: number


toString

▸ toString(): string

Defined in src/util/Pool.ts:96

Returns: string