class: ParticleRenderer
Methods summary
| Public methods |
|
private
|
onContextChange(): void
|
|
public
|
start(): void
|
|
public
|
render(container: PIXI.ParticleContainer): void
|
|
public
|
generateBuffers(container: PIXI.ParticleContainer): Array.
|
|
public
|
uploadVertices(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
|
|
public
|
uploadPosition(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
|
|
public
|
uploadRotation(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
|
|
public
|
uploadUvs(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
|
|
public
|
uploadAlpha(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
|
|
public
|
destroy(): void
|
|
private
|
onContextChange(): void
|
|
public
|
start(): void
|
|
public
|
render(container: PIXI.ParticleContainer): void
|
|
public
|
generateBuffers(container: PIXI.ParticleContainer): Array.
|
|
public
|
uploadVertices(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
|
|
public
|
uploadPosition(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
|
|
public
|
uploadRotation(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
|
|
public
|
uploadUvs(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
|
|
public
|
uploadAlpha(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
|
|
public
|
destroy(): void
|
Properties
| Name |
Type |
Attribute |
Description |
| shader |
PIXI.Shader
|
public |
The default shader that is used if a sprite doesn't have a more specific one. |
| shader |
PIXI.Shader
|
public |
The default shader that is used if a sprite doesn't have a more specific one. |
Methods
onContextChange(): void
When there is a WebGL context change
Returns:
void
start(): void
Starts a new particle batch.
Returns:
void
render(container: PIXI.ParticleContainer): void
Renders the particle container object.
Params:
| Name |
Type |
Attribute |
Description |
| container |
|
|
The container to render using this ParticleRenderer |
Returns:
void
generateBuffers(container: PIXI.ParticleContainer): Array.
Creates one particle buffer for each child in the container we want to render and updates internal properties
Params:
| Name |
Type |
Attribute |
Description |
| container |
|
|
The container to render using this ParticleRenderer |
Returns:
Array.
uploadVertices(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
Uploads the verticies.
Params:
| Name |
Type |
Attribute |
Description |
| children |
|
|
the array of display objects to render |
| startIndex |
|
|
the index to start from in the children array |
| amount |
|
|
the amount of children that will have their vertices uploaded |
| array |
|
|
The vertices to upload. |
| stride |
|
|
Stride to use for iteration. |
| offset |
|
|
Offset to start at. |
Returns:
void
uploadPosition(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
Params:
| Name |
Type |
Attribute |
Description |
| children |
|
|
the array of display objects to render |
| startIndex |
|
|
the index to start from in the children array |
| amount |
|
|
the amount of children that will have their positions uploaded |
| array |
|
|
The vertices to upload. |
| stride |
|
|
Stride to use for iteration. |
| offset |
|
|
Offset to start at. |
Returns:
void
uploadRotation(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
Params:
| Name |
Type |
Attribute |
Description |
| children |
|
|
the array of display objects to render |
| startIndex |
|
|
the index to start from in the children array |
| amount |
|
|
the amount of children that will have their rotation uploaded |
| array |
|
|
The vertices to upload. |
| stride |
|
|
Stride to use for iteration. |
| offset |
|
|
Offset to start at. |
Returns:
void
uploadUvs(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
Params:
| Name |
Type |
Attribute |
Description |
| children |
|
|
the array of display objects to render |
| startIndex |
|
|
the index to start from in the children array |
| amount |
|
|
the amount of children that will have their rotation uploaded |
| array |
|
|
The vertices to upload. |
| stride |
|
|
Stride to use for iteration. |
| offset |
|
|
Offset to start at. |
Returns:
void
uploadAlpha(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
Params:
| Name |
Type |
Attribute |
Description |
| children |
|
|
the array of display objects to render |
| startIndex |
|
|
the index to start from in the children array |
| amount |
|
|
the amount of children that will have their rotation uploaded |
| array |
|
|
The vertices to upload. |
| stride |
|
|
Stride to use for iteration. |
| offset |
|
|
Offset to start at. |
Returns:
void
destroy(): void
Destroys the ParticleRenderer.
Returns:
void
onContextChange(): void
When there is a WebGL context change
Returns:
void
start(): void
Starts a new particle batch.
Returns:
void
render(container: PIXI.ParticleContainer): void
Renders the particle container object.
Params:
| Name |
Type |
Attribute |
Description |
| container |
|
|
The container to render using this ParticleRenderer |
Returns:
void
generateBuffers(container: PIXI.ParticleContainer): Array.
Creates one particle buffer for each child in the container we want to render and updates internal properties
Params:
| Name |
Type |
Attribute |
Description |
| container |
|
|
The container to render using this ParticleRenderer |
Returns:
Array.
uploadVertices(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
Uploads the verticies.
Params:
| Name |
Type |
Attribute |
Description |
| children |
|
|
the array of display objects to render |
| startIndex |
|
|
the index to start from in the children array |
| amount |
|
|
the amount of children that will have their vertices uploaded |
| array |
|
|
The vertices to upload. |
| stride |
|
|
Stride to use for iteration. |
| offset |
|
|
Offset to start at. |
Returns:
void
uploadPosition(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
Params:
| Name |
Type |
Attribute |
Description |
| children |
|
|
the array of display objects to render |
| startIndex |
|
|
the index to start from in the children array |
| amount |
|
|
the amount of children that will have their positions uploaded |
| array |
|
|
The vertices to upload. |
| stride |
|
|
Stride to use for iteration. |
| offset |
|
|
Offset to start at. |
Returns:
void
uploadRotation(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
Params:
| Name |
Type |
Attribute |
Description |
| children |
|
|
the array of display objects to render |
| startIndex |
|
|
the index to start from in the children array |
| amount |
|
|
the amount of children that will have their rotation uploaded |
| array |
|
|
The vertices to upload. |
| stride |
|
|
Stride to use for iteration. |
| offset |
|
|
Offset to start at. |
Returns:
void
uploadUvs(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
Params:
| Name |
Type |
Attribute |
Description |
| children |
|
|
the array of display objects to render |
| startIndex |
|
|
the index to start from in the children array |
| amount |
|
|
the amount of children that will have their rotation uploaded |
| array |
|
|
The vertices to upload. |
| stride |
|
|
Stride to use for iteration. |
| offset |
|
|
Offset to start at. |
Returns:
void
uploadAlpha(children: Array., startIndex: number, amount: number, array: Array.<number>, stride: number, offset: number): void
Params:
| Name |
Type |
Attribute |
Description |
| children |
|
|
the array of display objects to render |
| startIndex |
|
|
the index to start from in the children array |
| amount |
|
|
the amount of children that will have their rotation uploaded |
| array |
|
|
The vertices to upload. |
| stride |
|
|
Stride to use for iteration. |
| offset |
|
|
Offset to start at. |
Returns:
void
destroy(): void
Destroys the ParticleRenderer.
Returns:
void
{
"comment": "/**\n *\n * @class\n * @private\n * @memberof PIXI\n */",
"meta": {
"range": [
681,
13294
],
"filename": "ParticleRenderer.js",
"lineno": 25,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100071884",
"name": "ParticleRenderer",
"type": "ClassDeclaration",
"paramnames": [
"renderer"
]
}
},
"kind": "class",
"access": "private",
"memberof": "PIXI",
"name": "ParticleRenderer",
"longname": "PIXI.ParticleRenderer",
"scope": "static",
"params": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "The renderer this sprite batch works for.
",
"name": "renderer"
}
],
"___id": "T000002R006681",
"___s": true,
"$methods": [
{
"comment": "/**\n * When there is a WebGL context change\n *\n * @private\n */",
"meta": {
"range": [
1672,
3023
],
"filename": "ParticleRenderer.js",
"lineno": 61,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100071932",
"name": "ParticleRenderer#onContextChange",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "When there is a WebGL context change
",
"access": "private",
"name": "onContextChange",
"longname": "PIXI.ParticleRenderer#onContextChange",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R006689",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereronContextChange",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * Starts a new particle batch.\n *\n */",
"meta": {
"range": [
3088,
3154
],
"filename": "ParticleRenderer.js",
"lineno": 113,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100072053",
"name": "ParticleRenderer#start",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Starts a new particle batch.
",
"name": "start",
"longname": "PIXI.ParticleRenderer#start",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R006714",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendererstart",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * Renders the particle container object.\n *\n * @param {PIXI.ParticleContainer} container - The container to render using this ParticleRenderer\n */",
"meta": {
"range": [
3332,
5389
],
"filename": "ParticleRenderer.js",
"lineno": 123,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100072067",
"name": "ParticleRenderer#render",
"type": "MethodDefinition",
"paramnames": [
"container"
]
},
"vars": {
"": null
}
},
"description": "Renders the particle container object.
",
"params": [
{
"type": {
"names": [
"PIXI.ParticleContainer"
]
},
"description": "The container to render using this ParticleRenderer
",
"name": "container"
}
],
"name": "render",
"longname": "PIXI.ParticleRenderer#render",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R006715",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendererrender",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * Creates one particle buffer for each child in the container we want to render and updates internal properties\n *\n * @param {PIXI.ParticleContainer} container - The container to render using this ParticleRenderer\n * @return {PIXI.ParticleBuffer[]} The buffers\n */",
"meta": {
"range": [
5689,
6137
],
"filename": "ParticleRenderer.js",
"lineno": 198,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100072327",
"name": "ParticleRenderer#generateBuffers",
"type": "MethodDefinition",
"paramnames": [
"container"
]
},
"vars": {
"": null
}
},
"description": "Creates one particle buffer for each child in the container we want to render and updates internal properties
",
"params": [
{
"type": {
"names": [
"PIXI.ParticleContainer"
]
},
"description": "The container to render using this ParticleRenderer
",
"name": "container"
}
],
"returns": [
{
"type": {
"names": [
"Array."
]
},
"description": "The buffers
"
}
],
"name": "generateBuffers",
"longname": "PIXI.ParticleRenderer#generateBuffers",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R006739",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRenderergenerateBuffers",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * Uploads the verticies.\n *\n * @param {PIXI.DisplayObject[]} children - the array of display objects to render\n * @param {number} startIndex - the index to start from in the children array\n * @param {number} amount - the amount of children that will have their vertices uploaded\n * @param {number[]} array - The vertices to upload.\n * @param {number} stride - Stride to use for iteration.\n * @param {number} offset - Offset to start at.\n */",
"meta": {
"range": [
6629,
8222
],
"filename": "ParticleRenderer.js",
"lineno": 224,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100072389",
"name": "ParticleRenderer#uploadVertices",
"type": "MethodDefinition",
"paramnames": [
"children",
"startIndex",
"amount",
"array",
"stride",
"offset"
]
},
"vars": {
"": null
}
},
"description": "Uploads the verticies.
",
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "the array of display objects to render
",
"name": "children"
},
{
"type": {
"names": [
"number"
]
},
"description": "the index to start from in the children array
",
"name": "startIndex"
},
{
"type": {
"names": [
"number"
]
},
"description": "the amount of children that will have their vertices uploaded
",
"name": "amount"
},
{
"type": {
"names": [
"Array."
]
},
"description": "The vertices to upload.
",
"name": "array"
},
{
"type": {
"names": [
"number"
]
},
"description": "Stride to use for iteration.
",
"name": "stride"
},
{
"type": {
"names": [
"number"
]
},
"description": "Offset to start at.
",
"name": "offset"
}
],
"name": "uploadVertices",
"longname": "PIXI.ParticleRenderer#uploadVertices",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R006747",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereruploadVertices",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n *\n * @param {PIXI.DisplayObject[]} children - the array of display objects to render\n * @param {number} startIndex - the index to start from in the children array\n * @param {number} amount - the amount of children that will have their positions uploaded\n * @param {number[]} array - The vertices to upload.\n * @param {number} stride - Stride to use for iteration.\n * @param {number} offset - Offset to start at.\n */",
"meta": {
"range": [
8685,
9396
],
"filename": "ParticleRenderer.js",
"lineno": 284,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100072672",
"name": "ParticleRenderer#uploadPosition",
"type": "MethodDefinition",
"paramnames": [
"children",
"startIndex",
"amount",
"array",
"stride",
"offset"
]
},
"vars": {
"": null
}
},
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "the array of display objects to render
",
"name": "children"
},
{
"type": {
"names": [
"number"
]
},
"description": "the index to start from in the children array
",
"name": "startIndex"
},
{
"type": {
"names": [
"number"
]
},
"description": "the amount of children that will have their positions uploaded
",
"name": "amount"
},
{
"type": {
"names": [
"Array."
]
},
"description": "The vertices to upload.
",
"name": "array"
},
{
"type": {
"names": [
"number"
]
},
"description": "Stride to use for iteration.
",
"name": "stride"
},
{
"type": {
"names": [
"number"
]
},
"description": "Offset to start at.
",
"name": "offset"
}
],
"name": "uploadPosition",
"longname": "PIXI.ParticleRenderer#uploadPosition",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R006776",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereruploadPosition",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n *\n * @param {PIXI.DisplayObject[]} children - the array of display objects to render\n * @param {number} startIndex - the index to start from in the children array\n * @param {number} amount - the amount of children that will have their rotation uploaded\n * @param {number[]} array - The vertices to upload.\n * @param {number} stride - Stride to use for iteration.\n * @param {number} offset - Offset to start at.\n */",
"meta": {
"range": [
9858,
10319
],
"filename": "ParticleRenderer.js",
"lineno": 315,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100072801",
"name": "ParticleRenderer#uploadRotation",
"type": "MethodDefinition",
"paramnames": [
"children",
"startIndex",
"amount",
"array",
"stride",
"offset"
]
},
"vars": {
"": null
}
},
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "the array of display objects to render
",
"name": "children"
},
{
"type": {
"names": [
"number"
]
},
"description": "the index to start from in the children array
",
"name": "startIndex"
},
{
"type": {
"names": [
"number"
]
},
"description": "the amount of children that will have their rotation uploaded
",
"name": "amount"
},
{
"type": {
"names": [
"Array."
]
},
"description": "The vertices to upload.
",
"name": "array"
},
{
"type": {
"names": [
"number"
]
},
"description": "Stride to use for iteration.
",
"name": "stride"
},
{
"type": {
"names": [
"number"
]
},
"description": "Offset to start at.
",
"name": "offset"
}
],
"name": "uploadRotation",
"longname": "PIXI.ParticleRenderer#uploadRotation",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R006788",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereruploadRotation",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n *\n * @param {PIXI.DisplayObject[]} children - the array of display objects to render\n * @param {number} startIndex - the index to start from in the children array\n * @param {number} amount - the amount of children that will have their rotation uploaded\n * @param {number[]} array - The vertices to upload.\n * @param {number} stride - Stride to use for iteration.\n * @param {number} offset - Offset to start at.\n */",
"meta": {
"range": [
10781,
12070
],
"filename": "ParticleRenderer.js",
"lineno": 339,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100072872",
"name": "ParticleRenderer#uploadUvs",
"type": "MethodDefinition",
"paramnames": [
"children",
"startIndex",
"amount",
"array",
"stride",
"offset"
]
},
"vars": {
"": null
}
},
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "the array of display objects to render
",
"name": "children"
},
{
"type": {
"names": [
"number"
]
},
"description": "the index to start from in the children array
",
"name": "startIndex"
},
{
"type": {
"names": [
"number"
]
},
"description": "the amount of children that will have their rotation uploaded
",
"name": "amount"
},
{
"type": {
"names": [
"Array."
]
},
"description": "The vertices to upload.
",
"name": "array"
},
{
"type": {
"names": [
"number"
]
},
"description": "Stride to use for iteration.
",
"name": "stride"
},
{
"type": {
"names": [
"number"
]
},
"description": "Offset to start at.
",
"name": "offset"
}
],
"name": "uploadUvs",
"longname": "PIXI.ParticleRenderer#uploadUvs",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R006796",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereruploadUvs",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n *\n * @param {PIXI.DisplayObject[]} children - the array of display objects to render\n * @param {number} startIndex - the index to start from in the children array\n * @param {number} amount - the amount of children that will have their rotation uploaded\n * @param {number[]} array - The vertices to upload.\n * @param {number} stride - Stride to use for iteration.\n * @param {number} offset - Offset to start at.\n */",
"meta": {
"range": [
12532,
12972
],
"filename": "ParticleRenderer.js",
"lineno": 390,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100073089",
"name": "ParticleRenderer#uploadAlpha",
"type": "MethodDefinition",
"paramnames": [
"children",
"startIndex",
"amount",
"array",
"stride",
"offset"
]
},
"vars": {
"": null
}
},
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "the array of display objects to render
",
"name": "children"
},
{
"type": {
"names": [
"number"
]
},
"description": "the index to start from in the children array
",
"name": "startIndex"
},
{
"type": {
"names": [
"number"
]
},
"description": "the amount of children that will have their rotation uploaded
",
"name": "amount"
},
{
"type": {
"names": [
"Array."
]
},
"description": "The vertices to upload.
",
"name": "array"
},
{
"type": {
"names": [
"number"
]
},
"description": "Stride to use for iteration.
",
"name": "stride"
},
{
"type": {
"names": [
"number"
]
},
"description": "Offset to start at.
",
"name": "offset"
}
],
"name": "uploadAlpha",
"longname": "PIXI.ParticleRenderer#uploadAlpha",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R006817",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereruploadAlpha",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * Destroys the ParticleRenderer.\n *\n */",
"meta": {
"range": [
13039,
13291
],
"filename": "ParticleRenderer.js",
"lineno": 409,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100073160",
"name": "ParticleRenderer#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Destroys the ParticleRenderer.
",
"name": "destroy",
"longname": "PIXI.ParticleRenderer#destroy",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R006825",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendererdestroy",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * When there is a WebGL context change\n *\n * @private\n */",
"meta": {
"range": [
1672,
3023
],
"filename": "ParticleRenderer.js",
"lineno": 61,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100146611",
"name": "ParticleRenderer#onContextChange",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "When there is a WebGL context change
",
"access": "private",
"name": "onContextChange",
"longname": "PIXI.ParticleRenderer#onContextChange",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R013623",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereronContextChange",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * Starts a new particle batch.\n *\n */",
"meta": {
"range": [
3088,
3154
],
"filename": "ParticleRenderer.js",
"lineno": 113,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100146732",
"name": "ParticleRenderer#start",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Starts a new particle batch.
",
"name": "start",
"longname": "PIXI.ParticleRenderer#start",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R013648",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendererstart",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * Renders the particle container object.\n *\n * @param {PIXI.ParticleContainer} container - The container to render using this ParticleRenderer\n */",
"meta": {
"range": [
3332,
5389
],
"filename": "ParticleRenderer.js",
"lineno": 123,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100146746",
"name": "ParticleRenderer#render",
"type": "MethodDefinition",
"paramnames": [
"container"
]
},
"vars": {
"": null
}
},
"description": "Renders the particle container object.
",
"params": [
{
"type": {
"names": [
"PIXI.ParticleContainer"
]
},
"description": "The container to render using this ParticleRenderer
",
"name": "container"
}
],
"name": "render",
"longname": "PIXI.ParticleRenderer#render",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R013649",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendererrender",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * Creates one particle buffer for each child in the container we want to render and updates internal properties\n *\n * @param {PIXI.ParticleContainer} container - The container to render using this ParticleRenderer\n * @return {PIXI.ParticleBuffer[]} The buffers\n */",
"meta": {
"range": [
5689,
6137
],
"filename": "ParticleRenderer.js",
"lineno": 198,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100147006",
"name": "ParticleRenderer#generateBuffers",
"type": "MethodDefinition",
"paramnames": [
"container"
]
},
"vars": {
"": null
}
},
"description": "Creates one particle buffer for each child in the container we want to render and updates internal properties
",
"params": [
{
"type": {
"names": [
"PIXI.ParticleContainer"
]
},
"description": "The container to render using this ParticleRenderer
",
"name": "container"
}
],
"returns": [
{
"type": {
"names": [
"Array."
]
},
"description": "The buffers
"
}
],
"name": "generateBuffers",
"longname": "PIXI.ParticleRenderer#generateBuffers",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R013673",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRenderergenerateBuffers",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * Uploads the verticies.\n *\n * @param {PIXI.DisplayObject[]} children - the array of display objects to render\n * @param {number} startIndex - the index to start from in the children array\n * @param {number} amount - the amount of children that will have their vertices uploaded\n * @param {number[]} array - The vertices to upload.\n * @param {number} stride - Stride to use for iteration.\n * @param {number} offset - Offset to start at.\n */",
"meta": {
"range": [
6629,
8222
],
"filename": "ParticleRenderer.js",
"lineno": 224,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100147068",
"name": "ParticleRenderer#uploadVertices",
"type": "MethodDefinition",
"paramnames": [
"children",
"startIndex",
"amount",
"array",
"stride",
"offset"
]
},
"vars": {
"": null
}
},
"description": "Uploads the verticies.
",
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "the array of display objects to render
",
"name": "children"
},
{
"type": {
"names": [
"number"
]
},
"description": "the index to start from in the children array
",
"name": "startIndex"
},
{
"type": {
"names": [
"number"
]
},
"description": "the amount of children that will have their vertices uploaded
",
"name": "amount"
},
{
"type": {
"names": [
"Array."
]
},
"description": "The vertices to upload.
",
"name": "array"
},
{
"type": {
"names": [
"number"
]
},
"description": "Stride to use for iteration.
",
"name": "stride"
},
{
"type": {
"names": [
"number"
]
},
"description": "Offset to start at.
",
"name": "offset"
}
],
"name": "uploadVertices",
"longname": "PIXI.ParticleRenderer#uploadVertices",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R013681",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereruploadVertices",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n *\n * @param {PIXI.DisplayObject[]} children - the array of display objects to render\n * @param {number} startIndex - the index to start from in the children array\n * @param {number} amount - the amount of children that will have their positions uploaded\n * @param {number[]} array - The vertices to upload.\n * @param {number} stride - Stride to use for iteration.\n * @param {number} offset - Offset to start at.\n */",
"meta": {
"range": [
8685,
9396
],
"filename": "ParticleRenderer.js",
"lineno": 284,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100147351",
"name": "ParticleRenderer#uploadPosition",
"type": "MethodDefinition",
"paramnames": [
"children",
"startIndex",
"amount",
"array",
"stride",
"offset"
]
},
"vars": {
"": null
}
},
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "the array of display objects to render
",
"name": "children"
},
{
"type": {
"names": [
"number"
]
},
"description": "the index to start from in the children array
",
"name": "startIndex"
},
{
"type": {
"names": [
"number"
]
},
"description": "the amount of children that will have their positions uploaded
",
"name": "amount"
},
{
"type": {
"names": [
"Array."
]
},
"description": "The vertices to upload.
",
"name": "array"
},
{
"type": {
"names": [
"number"
]
},
"description": "Stride to use for iteration.
",
"name": "stride"
},
{
"type": {
"names": [
"number"
]
},
"description": "Offset to start at.
",
"name": "offset"
}
],
"name": "uploadPosition",
"longname": "PIXI.ParticleRenderer#uploadPosition",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R013710",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereruploadPosition",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n *\n * @param {PIXI.DisplayObject[]} children - the array of display objects to render\n * @param {number} startIndex - the index to start from in the children array\n * @param {number} amount - the amount of children that will have their rotation uploaded\n * @param {number[]} array - The vertices to upload.\n * @param {number} stride - Stride to use for iteration.\n * @param {number} offset - Offset to start at.\n */",
"meta": {
"range": [
9858,
10319
],
"filename": "ParticleRenderer.js",
"lineno": 315,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100147480",
"name": "ParticleRenderer#uploadRotation",
"type": "MethodDefinition",
"paramnames": [
"children",
"startIndex",
"amount",
"array",
"stride",
"offset"
]
},
"vars": {
"": null
}
},
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "the array of display objects to render
",
"name": "children"
},
{
"type": {
"names": [
"number"
]
},
"description": "the index to start from in the children array
",
"name": "startIndex"
},
{
"type": {
"names": [
"number"
]
},
"description": "the amount of children that will have their rotation uploaded
",
"name": "amount"
},
{
"type": {
"names": [
"Array."
]
},
"description": "The vertices to upload.
",
"name": "array"
},
{
"type": {
"names": [
"number"
]
},
"description": "Stride to use for iteration.
",
"name": "stride"
},
{
"type": {
"names": [
"number"
]
},
"description": "Offset to start at.
",
"name": "offset"
}
],
"name": "uploadRotation",
"longname": "PIXI.ParticleRenderer#uploadRotation",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R013722",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereruploadRotation",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n *\n * @param {PIXI.DisplayObject[]} children - the array of display objects to render\n * @param {number} startIndex - the index to start from in the children array\n * @param {number} amount - the amount of children that will have their rotation uploaded\n * @param {number[]} array - The vertices to upload.\n * @param {number} stride - Stride to use for iteration.\n * @param {number} offset - Offset to start at.\n */",
"meta": {
"range": [
10781,
12070
],
"filename": "ParticleRenderer.js",
"lineno": 339,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100147551",
"name": "ParticleRenderer#uploadUvs",
"type": "MethodDefinition",
"paramnames": [
"children",
"startIndex",
"amount",
"array",
"stride",
"offset"
]
},
"vars": {
"": null
}
},
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "the array of display objects to render
",
"name": "children"
},
{
"type": {
"names": [
"number"
]
},
"description": "the index to start from in the children array
",
"name": "startIndex"
},
{
"type": {
"names": [
"number"
]
},
"description": "the amount of children that will have their rotation uploaded
",
"name": "amount"
},
{
"type": {
"names": [
"Array."
]
},
"description": "The vertices to upload.
",
"name": "array"
},
{
"type": {
"names": [
"number"
]
},
"description": "Stride to use for iteration.
",
"name": "stride"
},
{
"type": {
"names": [
"number"
]
},
"description": "Offset to start at.
",
"name": "offset"
}
],
"name": "uploadUvs",
"longname": "PIXI.ParticleRenderer#uploadUvs",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R013730",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereruploadUvs",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n *\n * @param {PIXI.DisplayObject[]} children - the array of display objects to render\n * @param {number} startIndex - the index to start from in the children array\n * @param {number} amount - the amount of children that will have their rotation uploaded\n * @param {number[]} array - The vertices to upload.\n * @param {number} stride - Stride to use for iteration.\n * @param {number} offset - Offset to start at.\n */",
"meta": {
"range": [
12532,
12972
],
"filename": "ParticleRenderer.js",
"lineno": 390,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100147768",
"name": "ParticleRenderer#uploadAlpha",
"type": "MethodDefinition",
"paramnames": [
"children",
"startIndex",
"amount",
"array",
"stride",
"offset"
]
},
"vars": {
"": null
}
},
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "the array of display objects to render
",
"name": "children"
},
{
"type": {
"names": [
"number"
]
},
"description": "the index to start from in the children array
",
"name": "startIndex"
},
{
"type": {
"names": [
"number"
]
},
"description": "the amount of children that will have their rotation uploaded
",
"name": "amount"
},
{
"type": {
"names": [
"Array."
]
},
"description": "The vertices to upload.
",
"name": "array"
},
{
"type": {
"names": [
"number"
]
},
"description": "Stride to use for iteration.
",
"name": "stride"
},
{
"type": {
"names": [
"number"
]
},
"description": "Offset to start at.
",
"name": "offset"
}
],
"name": "uploadAlpha",
"longname": "PIXI.ParticleRenderer#uploadAlpha",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"___id": "T000002R013751",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendereruploadAlpha",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * Destroys the ParticleRenderer.\n *\n */",
"meta": {
"range": [
13039,
13291
],
"filename": "ParticleRenderer.js",
"lineno": 409,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {
"id": "astnode100147839",
"name": "ParticleRenderer#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Destroys the ParticleRenderer.
",
"name": "destroy",
"longname": "PIXI.ParticleRenderer#destroy",
"kind": "function",
"memberof": "PIXI.ParticleRenderer",
"scope": "instance",
"params": [],
"___id": "T000002R013759",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRendererdestroy",
"filepath": "particles\\webgl\\ParticleRenderer.js"
}
],
"$attributes": [
{
"comment": "/**\n * The default shader that is used if a sprite doesn't have a more specific one.\n *\n * @member {PIXI.Shader} PIXI.ParticleRenderer#shader\n */",
"meta": {
"range": [
1228,
1405
],
"filename": "ParticleRenderer.js",
"lineno": 40,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {}
},
"description": "The default shader that is used if a sprite doesn't have a more specific one.
",
"kind": "member",
"name": "shader",
"type": {
"names": [
"PIXI.Shader"
]
},
"memberof": "PIXI.ParticleRenderer",
"longname": "PIXI.ParticleRenderer#shader",
"scope": "instance",
"___id": "T000002R006683",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRenderershader",
"filepath": "particles\\webgl\\ParticleRenderer.js"
},
{
"comment": "/**\n * The default shader that is used if a sprite doesn't have a more specific one.\n *\n * @member {PIXI.Shader} PIXI.ParticleRenderer#shader\n */",
"meta": {
"range": [
1228,
1405
],
"filename": "ParticleRenderer.js",
"lineno": 40,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\particles\\webgl",
"code": {}
},
"description": "The default shader that is used if a sprite doesn't have a more specific one.
",
"kind": "member",
"name": "shader",
"type": {
"names": [
"PIXI.Shader"
]
},
"memberof": "PIXI.ParticleRenderer",
"longname": "PIXI.ParticleRenderer#shader",
"scope": "instance",
"___id": "T000002R013617",
"___s": true,
"skip": true,
"slug": "PIXI.ParticleRenderershader",
"filepath": "particles\\webgl\\ParticleRenderer.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [],
"filepath": "particles\\webgl\\ParticleRenderer.js"
}