Pixi’VNClass: ParticleContainerPipe
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:20
Internal
Renderer for Particles that is designer for speed over feature set.
Extended by
Implements
Constructors
Constructor
> new ParticleContainerPipe(renderer, adaptor): ParticleContainerPipe
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:58
Parameters
renderer
The renderer this sprite batch works for.
adaptor
Returns
ParticleContainerPipe
Properties
adaptor
> adaptor: ParticleContainerAdaptor
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:29
Internal
defaultShader
> defaultShader: Shader
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:27
The default shader that is used if a sprite doesn't have a more specific one.
localUniforms
> readonly localUniforms: UniformGroup<{ uColor: { type: "vec4<f32>"; value: Float32Array<ArrayBuffer>; }; uResolution: { type: "vec2<f32>"; value: number[]; }; uRound: { type: "f32"; value: number; }; uTranslationMatrix: { type: "mat3x3<f32>"; value: Matrix; }; }>
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:36
Local uniforms that are used for rendering particles.
renderer
> readonly renderer: Renderer
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:33
Internal
state
> readonly state: State
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:31
Internal
Methods
addRenderable()
> addRenderable(renderable, instructionSet): void
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:60
This is where the renderable is added to the instruction set. This is called once per renderable. For instance, a MeshRenderPipe could be used to enqueue a 'draw mesh' command to the rendering instruction set, catering to the rendering of mesh geometry. In more complex scenarios, such as the SpritePipe, this seamlessly coordinates with a batchPipe to efficiently batch and add batch instructions to the instructions set
Add is called when the instructions set is being built.
Parameters
renderable
the renderable that needs to be rendered
instructionSet
the instruction set currently being built
Returns
void
Implementation of
destroy()
> destroy(): void
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:66
Destroys the ParticleRenderer.
Returns
void
execute()
> execute(container): void
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:64
Parameters
container
Returns
void
getBuffers()
> getBuffers(renderable): ParticleBuffer
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:61
Parameters
renderable
Returns
updateRenderable()
> updateRenderable(_renderable): void
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:63
Called whenever a renderable has been been updated, eg its position has changed. This is only called in the render loop if the instructions set is being reused from the last frame. Otherwise addRenderable is called.
Parameters
_renderable
Returns
void
Implementation of
validateRenderable()
> validateRenderable(_renderable): boolean
Defined in: node_modules/pixi.js/lib/scene/particle-container/shared/ParticleContainerPipe.d.ts:59
This function is called when the renderer is determining if it can use the same instruction set again to improve performance. If this function returns true, the renderer will rebuild the whole instruction set for the scene. This is only called if the scene has not its changed its structure .
Parameters
_renderable
Returns
boolean