ParticlePool
Defined in: particles/src/ParticlePool.ts:5
Pre-allocated pool of PixiJS Particle instances.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ParticlePool(
texture,capacity):ParticlePool
Defined in: particles/src/ParticlePool.ts:11
Parameters
Section titled “Parameters”texture
Section titled “texture”TextureResource
capacity
Section titled “capacity”number
Returns
Section titled “Returns”ParticlePool
Properties
Section titled “Properties”capacity
Section titled “capacity”
readonlycapacity:number
Defined in: particles/src/ParticlePool.ts:8
Accessors
Section titled “Accessors”activeCount
Section titled “activeCount”Get Signature
Section titled “Get Signature”get activeCount():
number
Defined in: particles/src/ParticlePool.ts:43
Number of particles currently in use.
Returns
Section titled “Returns”number
freeCount
Section titled “freeCount”Get Signature
Section titled “Get Signature”get freeCount():
number
Defined in: particles/src/ParticlePool.ts:48
Number of particles available for reuse.
Returns
Section titled “Returns”number
Methods
Section titled “Methods”acquire()
Section titled “acquire()”acquire():
Particle|undefined
Defined in: particles/src/ParticlePool.ts:22
Acquire a recycled particle, or undefined if at capacity.
Returns
Section titled “Returns”Particle | undefined
release()
Section titled “release()”release(
particle):void
Defined in: particles/src/ParticlePool.ts:29
Release a particle back to the pool.
Parameters
Section titled “Parameters”particle
Section titled “particle”Particle
Returns
Section titled “Returns”void