1681-engine / index / ParticleBudget

Class: ParticleBudget

Defined in: src/particles/ParticleBudget.ts:9

Particles alive across every emitter that shares this budget. An emitter asks before it spawns and gives back as its particles die, so a crowd of emitters at once costs no more than limit: ten explosions in one frame share the budget instead of adding up to a frame the GPU cannot finish. Under reduced effects or the battery saver the limit shrinks by thinFactor.

Constructors

Constructor

new ParticleBudget(limit?, thinFactor?): ParticleBudget;

Defined in: src/particles/ParticleBudget.ts:12

Parameters

Parameter	Type	Default value	Description
limit	number	4000	Particles alive at once, for every emitter together.
thinFactor	number	0.35	The share of limit left under reduced effects or the battery saver.

Returns

ParticleBudget

Properties

limit

limit: number = 4000;

Defined in: src/particles/ParticleBudget.ts:14

Particles alive at once, for every emitter together.

---

thinFactor

thinFactor: number = 0.35;

Defined in: src/particles/ParticleBudget.ts:16

The share of limit left under reduced effects or the battery saver.

Accessors

effectiveLimit

Get Signature

get effectiveLimit(): number;

Defined in: src/particles/ParticleBudget.ts:20

The limit as the settings stand now.

Returns

number

---

live

Get Signature

get live(): number;

Defined in: src/particles/ParticleBudget.ts:25

Returns

number

Methods

give()

give(n): void;

Defined in: src/particles/ParticleBudget.ts:37

Returns n particles that died or were cleared.

Parameters

Parameter	Type
n	number

Returns

void

---

take()

take(n): number;

Defined in: src/particles/ParticleBudget.ts:30

Reserves up to n particles and returns how many were granted (0 when the budget is spent).

Parameters

Parameter	Type
n	number

Returns

number