PIXI.ParticleRenderer

class ParticleRenderer extends PIXI.ObjectRenderer

Renderer for Particles that is designer for speed over feature set.

Constructor


new PIXI.ParticleRenderer(renderer: PIXI.Renderer) → {}
Parameters:
Name Type Description
renderer PIXI.Renderer

The renderer this sprite batch works for.

Summary


Properties from ParticleRenderer

PIXI.Shader
shader

The default shader that is used if a sprite doesn't have a more specific one.

PIXI.State
state

The WebGL state in which this renderer will work.

Methods from ParticleRenderer

void
destroy()

Destroys the ParticleRenderer.

void
render(container: PIXI.ParticleContainer)
void
uploadPosition(children: PIXI.Sprite[], startIndex: number, amount: number, array: number[], stride: number, offset: number)
void
uploadRotation(children: PIXI.Sprite[], startIndex: number, amount: number, array: number[], stride: number, offset: number)
void
uploadTint(children: PIXI.Sprite[], startIndex: number, amount: number, array: number[], stride: number, offset: number)
void
uploadUvs(children: PIXI.Sprite[], startIndex: number, amount: number, array: number[], stride: number, offset: number)
void
uploadVertices(children: PIXI.Sprite[], startIndex: number, amount: number, array: number[], stride: number, offset: number)

Properties inherited from ObjectRenderer

PIXI.Renderer
protected renderer

The renderer this manager works for.

Methods inherited from ObjectRenderer

void
flush()

Stub method that should be used to empty the current batch by rendering objects now.

void
start()
void
stop()

Stops the renderer. It should free up any state and become dormant.

Public Properties


shader ParticleRenderer.ts:49
shader: PIXI.Shader

The default shader that is used if a sprite doesn't have a more specific one.

state ParticleRenderer.ts:46
state: PIXI.State

The WebGL state in which this renderer will work.

Public Methods


destroy ParticleRenderer.ts:448
destroy() → {void}

Destroys the ParticleRenderer.

Returns:
Type Description
void
render ParticleRenderer.ts:116
render(container: PIXI.ParticleContainer) → {void}

Renders the particle container object.

Parameters:
Name Type Description
container PIXI.ParticleContainer

The container to render using this ParticleRenderer.

Returns:
Type Description
void
uploadPosition ParticleRenderer.ts:300
uploadPosition(children: PIXI.Sprite[], startIndex: number, amount: number, array: number[], stride: number, offset: number) → {void}

Uploads the position.

Parameters:
Name Type Description
children PIXI.Sprite[]

the array of sprites to render

startIndex number

the index to start from in the children array

amount number

the amount of children that will have their positions uploaded

array number[]

The vertices to upload.

stride number

Stride to use for iteration.

offset number

Offset to start at.

Returns:
Type Description
void
uploadRotation ParticleRenderer.ts:334
uploadRotation(children: PIXI.Sprite[], startIndex: number, amount: number, array: number[], stride: number, offset: number) → {void}

Uploads the rotation.

Parameters:
Name Type Description
children PIXI.Sprite[]

the array of sprites to render

startIndex number

the index to start from in the children array

amount number

the amount of children that will have their rotation uploaded

array number[]

The vertices to upload.

stride number

Stride to use for iteration.

offset number

Offset to start at.

Returns:
Type Description
void
uploadTint ParticleRenderer.ts:415
uploadTint(children: PIXI.Sprite[], startIndex: number, amount: number, array: number[], stride: number, offset: number) → {void}

Uploads the tint.

Parameters:
Name Type Description
children PIXI.Sprite[]

the array of sprites to render

startIndex number

the index to start from in the children array

amount number

the amount of children that will have their rotation uploaded

array number[]

The vertices to upload.

stride number

Stride to use for iteration.

offset number

Offset to start at.

Returns:
Type Description
void
uploadUvs ParticleRenderer.ts:361
uploadUvs(children: PIXI.Sprite[], startIndex: number, amount: number, array: number[], stride: number, offset: number) → {void}

Uploads the UVs.

Parameters:
Name Type Description
children PIXI.Sprite[]

the array of sprites to render

startIndex number

the index to start from in the children array

amount number

the amount of children that will have their rotation uploaded

array number[]

The vertices to upload.

stride number

Stride to use for iteration.

offset number

Offset to start at.

Returns:
Type Description
void
uploadVertices ParticleRenderer.ts:237
uploadVertices(children: PIXI.Sprite[], startIndex: number, amount: number, array: number[], stride: number, offset: number) → {void}

Uploads the vertices.

Parameters:
Name Type Description
children PIXI.Sprite[]

the array of sprites to render

startIndex number

the index to start from in the children array

amount number

the amount of children that will have their vertices uploaded

array number[]

The vertices to upload.

stride number

Stride to use for iteration.

offset number

Offset to start at.

Returns:
Type Description
void

Powered by webdoc!