Class ParticleRenderer

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

Memberof

PIXI

Hierarchy (view full)

Constructors

constructor

Properties

properties shader state tempMatrix

Methods

destroy flush render start stop uploadPosition uploadRotation uploadTint uploadUvs uploadVertices

Constructors

constructor

Properties

properties

properties: IParticleRendererProperty[]

shader

shader: Shader

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

Readonly state

state: State

The WebGL state in which this renderer will work.

tempMatrix

tempMatrix: Matrix

Methods

destroy

  • destroy(): void

  • Destroys the ParticleRenderer.

    Returns void

flush

  • flush(): void

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

    Returns void

render

  • render(container): void

  • Renders the particle container object.

    Parameters

    Returns void

start

  • start(): void

  • Stub method that initializes any state required before rendering starts. It is different from the prerender signal, which occurs every frame, in that it is called whenever an object requests this renderer specifically.

    Returns void

stop

  • stop(): void

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

    Returns void

uploadPosition

  • uploadPosition(children, startIndex, amount, array, stride, offset): void

  • Uploads the position.

    Parameters

    • children: 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 void

uploadRotation

  • uploadRotation(children, startIndex, amount, array, stride, offset): void

  • Uploads the rotation.

    Parameters

    • children: 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 void

uploadTint

  • uploadTint(children, startIndex, amount, array, stride, offset): void

  • Uploads the tint.

    Parameters

    • children: 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 void

uploadUvs

  • uploadUvs(children, startIndex, amount, array, stride, offset): void

  • Uploads the UVs.

    Parameters

    • children: 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 void

uploadVertices

  • uploadVertices(children, startIndex, amount, array, stride, offset): void

  • Uploads the vertices.

    Parameters

    • children: 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 void

Settings

Member Visibility

Theme

On This Page

constructorpropertiesshaderstatetempMatrixdestroyflushrenderstartstopuploadPositionuploadRotationuploadTintuploadUvsuploadVertices

Generated using TypeDoc