ParticleBatch

class ParticleBatch

import { ParticleBatch } from '@driftengine/core';

Constructor

`new`

constructor(gl: WebGL2RenderingContext, capacity: number, options: ParticleBatchOptions)

Parameter	Type	Description
`gl`	`WebGL2RenderingContext`
`capacity`	`number`
`options`	`ParticleBatchOptions`

Properties

Name	Type	Description
`program`readonly	`WebGLProgram`
`uniforms`readonly	`Record<string, WebGLUniformLocation>`
`texture`readonly	`SurfaceTexture \| null`	The sprite's own: its image, its flipbook and its fades. See `ParticleBatchOptions`.
`cells`readonly	`readonly [number, number]`
`blendCells`readonly	`boolean`
`softDepth`readonly	`number`
`cameraFade`readonly	`number`
`cameraOffset`readonly	`number`
`material`readonly	`ParticleMaterial`	Which material compiled this batch's program, so `reuse` can be checked.

Methods

`upload`

upload(gl: WebGL2RenderingContext, given: ParticleInstances, eye: ArrayLike<number>): void

Send this frame's particles.

Parameter	Type	Description
`gl`	`WebGL2RenderingContext`
`given`	`ParticleInstances`
`eye`	`ArrayLike<number>`

Only the live prefix of each array, which is what the pool's compaction exists for: a pool at a tenth of its capacity uploads a tenth of the bytes.

`bindMaterial`

bindMaterial(gl: WebGL2RenderingContext): void

Bind this material's own constants. Called once per draw, before drawTo.

Parameter	Type	Description
`gl`	`WebGL2RenderingContext`

`drawTo`

drawTo(gl: WebGL2RenderingContext, count: number): void

Draw the live particles.

Parameter	Type	Description
`gl`	`WebGL2RenderingContext`
`count`	`number`

Depth tested but not written, so a puff is correctly hidden behind the deck and never hides a puff behind it. Culling off, because a blade seen from behind is exactly as valid as one seen from the front.

`dispose`

dispose(gl: WebGL2RenderingContext): void

Parameter	Type	Description
`gl`	`WebGL2RenderingContext`