Home

class: ParticleBuffer

The particle buffer manages the static and dynamic buffers for a particle container.

Methods summary

Public methods
private	initBuffers(): void
public	uploadDynamic(children: Array., startIndex: number, amount: number): void
public	uploadStatic(children: Array., startIndex: number, amount: number): void
public	destroy(): void
private	initBuffers(): void
public	uploadDynamic(children: Array., startIndex: number, amount: number): void
public	uploadStatic(children: Array., startIndex: number, amount: number): void
public	destroy(): void

Properties

Name	Type	Attribute	Description
gl	WebGLRenderingContext	public	The current WebGL drawing context.
vertSize	number	public	Size of a single vertex.
vertByteSize	number	public	Size of a single vertex in bytes.
size	number	public	The number of particles the buffer can hold
dynamicProperties	Array.<object>	public	A list of the properties that are dynamic.
staticProperties	Array.<object>	public	A list of the properties that are static.
indices	Uint16Array	public	Holds the indices of the geometry (quads) to draw
gl	WebGLRenderingContext	public	The current WebGL drawing context.
vertSize	number	public	Size of a single vertex.
vertByteSize	number	public	Size of a single vertex in bytes.
size	number	public	The number of particles the buffer can hold
dynamicProperties	Array.<object>	public	A list of the properties that are dynamic.
staticProperties	Array.<object>	public	A list of the properties that are static.
indices	Uint16Array	public	Holds the indices of the geometry (quads) to draw

Methods

initBuffers(): void

particles\webgl\ParticleBuffer.js, line 116

Sets up the renderer context and necessary buffers.

Returns:

void

uploadDynamic(children: Array., startIndex: number, amount: number): void

particles\webgl\ParticleBuffer.js, line 199

Uploads the dynamic properties.

Params:

Name	Type	Attribute	Description
children			The children to upload.
startIndex			The index to start at.
amount			The number to upload.

Returns:

void

uploadStatic(children: Array., startIndex: number, amount: number): void

particles\webgl\ParticleBuffer.js, line 218

Uploads the static properties.

Params:

Name	Type	Attribute	Description
children			The children to upload.
startIndex			The index to start at.
amount			The number to upload.

Returns:

void

destroy(): void

particles\webgl\ParticleBuffer.js, line 234

Destroys the ParticleBuffer.

Returns:

void

initBuffers(): void

particles\webgl\ParticleBuffer.js, line 116

Sets up the renderer context and necessary buffers.

Returns:

void

uploadDynamic(children: Array., startIndex: number, amount: number): void

particles\webgl\ParticleBuffer.js, line 199

Uploads the dynamic properties.

Params:

Name	Type	Attribute	Description
children			The children to upload.
startIndex			The index to start at.
amount			The number to upload.

Returns:

void

uploadStatic(children: Array., startIndex: number, amount: number): void

particles\webgl\ParticleBuffer.js, line 218

Uploads the static properties.

Params:

Name	Type	Attribute	Description
children			The children to upload.
startIndex			The index to start at.
amount			The number to upload.

Returns:

void

destroy(): void

particles\webgl\ParticleBuffer.js, line 234

Destroys the ParticleBuffer.

Returns:

void

{ "comment": "/**\n * The particle buffer manages the static and dynamic buffers for a particle container.\n *\n * @class\n * @private\n * @memberof PIXI\n */", "meta": { "range": [ 744, 7057 ], "filename": "ParticleBuffer.js", "lineno": 25, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": { "id": "astnode100071238", "name": "ParticleBuffer", "type": "ClassDeclaration", "paramnames": [ "gl", "properties", "dynamicPropertyFlags", "size" ] } }, "classdesc": "

The particle buffer manages the static and dynamic buffers for a particle container.

", "kind": "class", "access": "private", "memberof": "PIXI", "name": "ParticleBuffer", "longname": "PIXI.ParticleBuffer", "scope": "static", "params": [ { "type": { "names": [ "WebGLRenderingContext" ] }, "description": "

The rendering context.

", "name": "gl" }, { "type": { "names": [ "object" ] }, "description": "

The properties to upload.

", "name": "properties" }, { "type": { "names": [ "Array." ] }, "description": "

Flags for which properties are dynamic.

", "name": "dynamicPropertyFlags" }, { "type": { "names": [ "number" ] }, "description": "

The size of the batch.

", "name": "size" } ], "___id": "T000002R006614", "___s": true, "$methods": [ { "comment": "/**\n * Sets up the renderer context and necessary buffers.\n *\n * @private\n */", "meta": { "range": [ 3242, 5539 ], "filename": "ParticleBuffer.js", "lineno": 116, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": { "id": "astnode100071391", "name": "ParticleBuffer#initBuffers", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Sets up the renderer context and necessary buffers.

", "access": "private", "name": "initBuffers", "longname": "PIXI.ParticleBuffer#initBuffers", "kind": "function", "memberof": "PIXI.ParticleBuffer", "scope": "instance", "params": [], "___id": "T000002R006641", "___s": true, "skip": true, "slug": "PIXI.ParticleBufferinitBuffers", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * Uploads the dynamic properties.\n *\n * @param {PIXI.DisplayObject[]} children - The children to upload.\n * @param {number} startIndex - The index to start at.\n * @param {number} amount - The number to upload.\n */", "meta": { "range": [ 5792, 6148 ], "filename": "ParticleBuffer.js", "lineno": 199, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": { "id": "astnode100071719", "name": "ParticleBuffer#uploadDynamic", "type": "MethodDefinition", "paramnames": [ "children", "startIndex", "amount" ] }, "vars": { "": null } }, "description": "

Uploads the dynamic properties.

", "params": [ { "type": { "names": [ "Array." ] }, "description": "

The children to upload.

", "name": "children" }, { "type": { "names": [ "number" ] }, "description": "

The index to start at.

", "name": "startIndex" }, { "type": { "names": [ "number" ] }, "description": "

The number to upload.

", "name": "amount" } ], "name": "uploadDynamic", "longname": "PIXI.ParticleBuffer#uploadDynamic", "kind": "function", "memberof": "PIXI.ParticleBuffer", "scope": "instance", "___id": "T000002R006669", "___s": true, "skip": true, "slug": "PIXI.ParticleBufferuploadDynamic", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * Uploads the static properties.\n *\n * @param {PIXI.DisplayObject[]} children - The children to upload.\n * @param {number} startIndex - The index to start at.\n * @param {number} amount - The number to upload.\n */", "meta": { "range": [ 6400, 6750 ], "filename": "ParticleBuffer.js", "lineno": 218, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": { "id": "astnode100071773", "name": "ParticleBuffer#uploadStatic", "type": "MethodDefinition", "paramnames": [ "children", "startIndex", "amount" ] }, "vars": { "": null } }, "description": "

Uploads the static properties.

", "params": [ { "type": { "names": [ "Array." ] }, "description": "

The children to upload.

", "name": "children" }, { "type": { "names": [ "number" ] }, "description": "

The index to start at.

", "name": "startIndex" }, { "type": { "names": [ "number" ] }, "description": "

The number to upload.

", "name": "amount" } ], "name": "uploadStatic", "longname": "PIXI.ParticleBuffer#uploadStatic", "kind": "function", "memberof": "PIXI.ParticleBuffer", "scope": "instance", "___id": "T000002R006672", "___s": true, "skip": true, "slug": "PIXI.ParticleBufferuploadStatic", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * Destroys the ParticleBuffer.\n *\n */", "meta": { "range": [ 6815, 7054 ], "filename": "ParticleBuffer.js", "lineno": 234, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": { "id": "astnode100071827", "name": "ParticleBuffer#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroys the ParticleBuffer.

", "name": "destroy", "longname": "PIXI.ParticleBuffer#destroy", "kind": "function", "memberof": "PIXI.ParticleBuffer", "scope": "instance", "params": [], "___id": "T000002R006675", "___s": true, "skip": true, "slug": "PIXI.ParticleBufferdestroy", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * Sets up the renderer context and necessary buffers.\n *\n * @private\n */", "meta": { "range": [ 3242, 5539 ], "filename": "ParticleBuffer.js", "lineno": 116, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": { "id": "astnode100146070", "name": "ParticleBuffer#initBuffers", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Sets up the renderer context and necessary buffers.

", "access": "private", "name": "initBuffers", "longname": "PIXI.ParticleBuffer#initBuffers", "kind": "function", "memberof": "PIXI.ParticleBuffer", "scope": "instance", "params": [], "___id": "T000002R013575", "___s": true, "skip": true, "slug": "PIXI.ParticleBufferinitBuffers", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * Uploads the dynamic properties.\n *\n * @param {PIXI.DisplayObject[]} children - The children to upload.\n * @param {number} startIndex - The index to start at.\n * @param {number} amount - The number to upload.\n */", "meta": { "range": [ 5792, 6148 ], "filename": "ParticleBuffer.js", "lineno": 199, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": { "id": "astnode100146398", "name": "ParticleBuffer#uploadDynamic", "type": "MethodDefinition", "paramnames": [ "children", "startIndex", "amount" ] }, "vars": { "": null } }, "description": "

Uploads the dynamic properties.

", "params": [ { "type": { "names": [ "Array." ] }, "description": "

The children to upload.

", "name": "children" }, { "type": { "names": [ "number" ] }, "description": "

The index to start at.

", "name": "startIndex" }, { "type": { "names": [ "number" ] }, "description": "

The number to upload.

", "name": "amount" } ], "name": "uploadDynamic", "longname": "PIXI.ParticleBuffer#uploadDynamic", "kind": "function", "memberof": "PIXI.ParticleBuffer", "scope": "instance", "___id": "T000002R013603", "___s": true, "skip": true, "slug": "PIXI.ParticleBufferuploadDynamic", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * Uploads the static properties.\n *\n * @param {PIXI.DisplayObject[]} children - The children to upload.\n * @param {number} startIndex - The index to start at.\n * @param {number} amount - The number to upload.\n */", "meta": { "range": [ 6400, 6750 ], "filename": "ParticleBuffer.js", "lineno": 218, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": { "id": "astnode100146452", "name": "ParticleBuffer#uploadStatic", "type": "MethodDefinition", "paramnames": [ "children", "startIndex", "amount" ] }, "vars": { "": null } }, "description": "

Uploads the static properties.

", "params": [ { "type": { "names": [ "Array." ] }, "description": "

The children to upload.

", "name": "children" }, { "type": { "names": [ "number" ] }, "description": "

The index to start at.

", "name": "startIndex" }, { "type": { "names": [ "number" ] }, "description": "

The number to upload.

", "name": "amount" } ], "name": "uploadStatic", "longname": "PIXI.ParticleBuffer#uploadStatic", "kind": "function", "memberof": "PIXI.ParticleBuffer", "scope": "instance", "___id": "T000002R013606", "___s": true, "skip": true, "slug": "PIXI.ParticleBufferuploadStatic", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * Destroys the ParticleBuffer.\n *\n */", "meta": { "range": [ 6815, 7054 ], "filename": "ParticleBuffer.js", "lineno": 234, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": { "id": "astnode100146506", "name": "ParticleBuffer#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroys the ParticleBuffer.

", "name": "destroy", "longname": "PIXI.ParticleBuffer#destroy", "kind": "function", "memberof": "PIXI.ParticleBuffer", "scope": "instance", "params": [], "___id": "T000002R013609", "___s": true, "skip": true, "slug": "PIXI.ParticleBufferdestroy", "filepath": "particles\\webgl\\ParticleBuffer.js" } ], "$attributes": [ { "comment": "/**\n * The current WebGL drawing context.\n *\n * @member {WebGLRenderingContext} PIXI.ParticleBuffer#gl\n */", "meta": { "range": [ 1127, 1265 ], "filename": "ParticleBuffer.js", "lineno": 35, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": {} }, "description": "

The current WebGL drawing context.

", "kind": "member", "name": "gl", "type": { "names": [ "WebGLRenderingContext" ] }, "memberof": "PIXI.ParticleBuffer", "longname": "PIXI.ParticleBuffer#gl", "scope": "instance", "___id": "T000002R006616", "___s": true, "skip": true, "slug": "PIXI.ParticleBuffergl", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * Size of a single vertex.\n *\n * @member {number} PIXI.ParticleBuffer#vertSize\n */", "meta": { "range": [ 1297, 1416 ], "filename": "ParticleBuffer.js", "lineno": 42, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": {} }, "description": "

Size of a single vertex.

", "kind": "member", "name": "vertSize", "type": { "names": [ "number" ] }, "memberof": "PIXI.ParticleBuffer", "longname": "PIXI.ParticleBuffer#vertSize", "scope": "instance", "___id": "T000002R006618", "___s": true, "skip": true, "slug": "PIXI.ParticleBuffervertSize", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * Size of a single vertex in bytes.\n *\n * @member {number} PIXI.ParticleBuffer#vertByteSize\n */", "meta": { "range": [ 1453, 1585 ], "filename": "ParticleBuffer.js", "lineno": 49, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": {} }, "description": "

Size of a single vertex in bytes.

", "kind": "member", "name": "vertByteSize", "type": { "names": [ "number" ] }, "memberof": "PIXI.ParticleBuffer", "longname": "PIXI.ParticleBuffer#vertByteSize", "scope": "instance", "___id": "T000002R006620", "___s": true, "skip": true, "slug": "PIXI.ParticleBuffervertByteSize", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * The number of particles the buffer can hold\n *\n * @member {number} PIXI.ParticleBuffer#size\n */", "meta": { "range": [ 1642, 1776 ], "filename": "ParticleBuffer.js", "lineno": 56, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": {} }, "description": "

The number of particles the buffer can hold

", "kind": "member", "name": "size", "type": { "names": [ "number" ] }, "memberof": "PIXI.ParticleBuffer", "longname": "PIXI.ParticleBuffer#size", "scope": "instance", "___id": "T000002R006622", "___s": true, "skip": true, "slug": "PIXI.ParticleBuffersize", "filepath": "particles\\webgl\\ParticleBuffer.js" }, { "comment": "/**\n * A list of the properties that are dynamic.\n *\n * @member {object[]} PIXI.ParticleBuffer#dynamicProperties\n */", "meta": { "range": [ 1812, 1960 ], "filename": "ParticleBuffer.js", "lineno": 63, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl", "code": {} }, "description": "

A list of the properties that are dynamic.

", "kind": "member", "name": "dynamicProperties", "type": { "names": [ "Array.