An object containing WebGL specific properties to be used by the WebGL renderer
| Public methods | |
|---|---|
| public | reset(): void |
| public | upload(): void |
| public | destroy(): void |
| public | reset(): void |
| public | upload(): void |
| public | destroy(): void |
| Name | Type | Attribute | Description |
|---|---|---|---|
| gl | WebGLRenderingContext | public | The current WebGL drawing context |
| color | Array.<number> | public | An array of color components (r,g,b) |
| points |
Array. |
public | An array of points to draw |
| indices | Array.<number> | public | The indices of the vertices |
| buffer | WebGLBuffer | public | The main buffer |
| indexBuffer | WebGLBuffer | public | The index buffer |
| dirty | boolean | public | Whether this graphics is dirty or not |
| shader | PIXI.Shader | public | |
| gl | WebGLRenderingContext | public | The current WebGL drawing context |
| color | Array.<number> | public | An array of color components (r,g,b) |
| points |
Array. |
public | An array of points to draw |
| indices | Array.<number> | public | The indices of the vertices |
| buffer | WebGLBuffer | public | The main buffer |
| indexBuffer | WebGLBuffer | public | The index buffer |
| dirty | boolean | public | Whether this graphics is dirty or not |
| shader | PIXI.Shader | public |
Resets the vertices and the indices
void
Binds the buffers and uploads the data
void
Empties all the data
void
Resets the vertices and the indices
void
Binds the buffers and uploads the data
void
Empties all the data
void
{
"comment": "/**\n * An object containing WebGL specific properties to be used by the WebGL renderer\n *\n * @class\n * @private\n * @memberof PIXI\n */",
"meta": {
"range": [
205,
3081
],
"filename": "WebGLGraphicsData.js",
"lineno": 12,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {
"id": "astnode100016044",
"name": "WebGLGraphicsData",
"type": "ClassDeclaration",
"paramnames": [
"gl",
"shader",
"attribsState"
]
}
},
"classdesc": "An object containing WebGL specific properties to be used by the WebGL renderer
",
"kind": "class",
"access": "private",
"memberof": "PIXI",
"name": "WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData",
"scope": "static",
"params": [
{
"type": {
"names": [
"WebGLRenderingContext"
]
},
"description": "The current WebGL drawing context
",
"name": "gl"
},
{
"type": {
"names": [
"PIXI.Shader"
]
},
"description": "The shader
",
"name": "shader"
},
{
"type": {
"names": [
"object"
]
},
"description": "The state for the VAO
",
"name": "attribsState"
}
],
"___id": "T000002R001466",
"___s": true,
"$methods": [
{
"comment": "/**\n * Resets the vertices and the indices\n */",
"meta": {
"range": [
2274,
2358
],
"filename": "WebGLGraphicsData.js",
"lineno": 82,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {
"id": "astnode100016186",
"name": "WebGLGraphicsData#reset",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Resets the vertices and the indices
",
"name": "reset",
"longname": "PIXI.WebGLGraphicsData#reset",
"kind": "function",
"memberof": "PIXI.WebGLGraphicsData",
"scope": "instance",
"params": [],
"___id": "T000002R001487",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatareset",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * Binds the buffers and uploads the data\n */",
"meta": {
"range": [
2426,
2679
],
"filename": "WebGLGraphicsData.js",
"lineno": 91,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {
"id": "astnode100016206",
"name": "WebGLGraphicsData#upload",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Binds the buffers and uploads the data
",
"name": "upload",
"longname": "PIXI.WebGLGraphicsData#upload",
"kind": "function",
"memberof": "PIXI.WebGLGraphicsData",
"scope": "instance",
"params": [],
"___id": "T000002R001490",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDataupload",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * Empties all the data\n */",
"meta": {
"range": [
2729,
3079
],
"filename": "WebGLGraphicsData.js",
"lineno": 105,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {
"id": "astnode100016256",
"name": "WebGLGraphicsData#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Empties all the data
",
"name": "destroy",
"longname": "PIXI.WebGLGraphicsData#destroy",
"kind": "function",
"memberof": "PIXI.WebGLGraphicsData",
"scope": "instance",
"params": [],
"___id": "T000002R001494",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatadestroy",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * Resets the vertices and the indices\n */",
"meta": {
"range": [
2274,
2358
],
"filename": "WebGLGraphicsData.js",
"lineno": 82,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {
"id": "astnode100090865",
"name": "WebGLGraphicsData#reset",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Resets the vertices and the indices
",
"name": "reset",
"longname": "PIXI.WebGLGraphicsData#reset",
"kind": "function",
"memberof": "PIXI.WebGLGraphicsData",
"scope": "instance",
"params": [],
"___id": "T000002R008421",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatareset",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * Binds the buffers and uploads the data\n */",
"meta": {
"range": [
2426,
2679
],
"filename": "WebGLGraphicsData.js",
"lineno": 91,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {
"id": "astnode100090885",
"name": "WebGLGraphicsData#upload",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Binds the buffers and uploads the data
",
"name": "upload",
"longname": "PIXI.WebGLGraphicsData#upload",
"kind": "function",
"memberof": "PIXI.WebGLGraphicsData",
"scope": "instance",
"params": [],
"___id": "T000002R008424",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDataupload",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * Empties all the data\n */",
"meta": {
"range": [
2729,
3079
],
"filename": "WebGLGraphicsData.js",
"lineno": 105,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {
"id": "astnode100090935",
"name": "WebGLGraphicsData#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Empties all the data
",
"name": "destroy",
"longname": "PIXI.WebGLGraphicsData#destroy",
"kind": "function",
"memberof": "PIXI.WebGLGraphicsData",
"scope": "instance",
"params": [],
"___id": "T000002R008428",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatadestroy",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
}
],
"$attributes": [
{
"comment": "/**\n * The current WebGL drawing context\n *\n * @member {WebGLRenderingContext} PIXI.WebGLGraphicsData#gl\n */",
"meta": {
"range": [
488,
628
],
"filename": "WebGLGraphicsData.js",
"lineno": 21,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "The current WebGL drawing context
",
"kind": "member",
"name": "gl",
"type": {
"names": [
"WebGLRenderingContext"
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#gl",
"scope": "instance",
"___id": "T000002R001468",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatagl",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * An array of color components (r,g,b)\n * @member {number[]} PIXI.WebGLGraphicsData#color\n */",
"meta": {
"range": [
722,
844
],
"filename": "WebGLGraphicsData.js",
"lineno": 29,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "An array of color components (r,g,b)
",
"kind": "member",
"name": "color",
"type": {
"names": [
"Array."
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#color",
"scope": "instance",
"___id": "T000002R001470",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatacolor",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * An array of points to draw\n * @member {PIXI.Point[]} PIXI.WebGLGraphicsData#points\n */",
"meta": {
"range": [
902,
1019
],
"filename": "WebGLGraphicsData.js",
"lineno": 35,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "An array of points to draw
",
"kind": "member",
"name": "points",
"type": {
"names": [
"Array."
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#points",
"scope": "instance",
"___id": "T000002R001472",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatapoints",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * The indices of the vertices\n * @member {number[]} PIXI.WebGLGraphicsData#indices\n */",
"meta": {
"range": [
1055,
1170
],
"filename": "WebGLGraphicsData.js",
"lineno": 41,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "The indices of the vertices
",
"kind": "member",
"name": "indices",
"type": {
"names": [
"Array."
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#indices",
"scope": "instance",
"___id": "T000002R001474",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDataindices",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * The main buffer\n * @member {WebGLBuffer} PIXI.WebGLGraphicsData#buffer\n */",
"meta": {
"range": [
1206,
1311
],
"filename": "WebGLGraphicsData.js",
"lineno": 46,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "The main buffer
",
"kind": "member",
"name": "buffer",
"type": {
"names": [
"WebGLBuffer"
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#buffer",
"scope": "instance",
"___id": "T000002R001476",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatabuffer",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * The index buffer\n * @member {WebGLBuffer} PIXI.WebGLGraphicsData#indexBuffer\n */",
"meta": {
"range": [
1383,
1494
],
"filename": "WebGLGraphicsData.js",
"lineno": 52,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "The index buffer
",
"kind": "member",
"name": "indexBuffer",
"type": {
"names": [
"WebGLBuffer"
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#indexBuffer",
"scope": "instance",
"___id": "T000002R001478",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDataindexBuffer",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * Whether this graphics is dirty or not\n * @member {boolean} PIXI.WebGLGraphicsData#dirty\n */",
"meta": {
"range": [
1570,
1692
],
"filename": "WebGLGraphicsData.js",
"lineno": 58,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "Whether this graphics is dirty or not
",
"kind": "member",
"name": "dirty",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#dirty",
"scope": "instance",
"___id": "T000002R001480",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatadirty",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n *\n * @member {PIXI.Shader} PIXI.WebGLGraphicsData#shader\n */",
"meta": {
"range": [
1791,
1880
],
"filename": "WebGLGraphicsData.js",
"lineno": 67,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"kind": "member",
"name": "shader",
"type": {
"names": [
"PIXI.Shader"
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#shader",
"scope": "instance",
"___id": "T000002R001484",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatashader",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * The current WebGL drawing context\n *\n * @member {WebGLRenderingContext} PIXI.WebGLGraphicsData#gl\n */",
"meta": {
"range": [
488,
628
],
"filename": "WebGLGraphicsData.js",
"lineno": 21,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "The current WebGL drawing context
",
"kind": "member",
"name": "gl",
"type": {
"names": [
"WebGLRenderingContext"
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#gl",
"scope": "instance",
"___id": "T000002R008402",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatagl",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * An array of color components (r,g,b)\n * @member {number[]} PIXI.WebGLGraphicsData#color\n */",
"meta": {
"range": [
722,
844
],
"filename": "WebGLGraphicsData.js",
"lineno": 29,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "An array of color components (r,g,b)
",
"kind": "member",
"name": "color",
"type": {
"names": [
"Array."
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#color",
"scope": "instance",
"___id": "T000002R008404",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatacolor",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * An array of points to draw\n * @member {PIXI.Point[]} PIXI.WebGLGraphicsData#points\n */",
"meta": {
"range": [
902,
1019
],
"filename": "WebGLGraphicsData.js",
"lineno": 35,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "An array of points to draw
",
"kind": "member",
"name": "points",
"type": {
"names": [
"Array."
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#points",
"scope": "instance",
"___id": "T000002R008406",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatapoints",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * The indices of the vertices\n * @member {number[]} PIXI.WebGLGraphicsData#indices\n */",
"meta": {
"range": [
1055,
1170
],
"filename": "WebGLGraphicsData.js",
"lineno": 41,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "The indices of the vertices
",
"kind": "member",
"name": "indices",
"type": {
"names": [
"Array."
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#indices",
"scope": "instance",
"___id": "T000002R008408",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDataindices",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * The main buffer\n * @member {WebGLBuffer} PIXI.WebGLGraphicsData#buffer\n */",
"meta": {
"range": [
1206,
1311
],
"filename": "WebGLGraphicsData.js",
"lineno": 46,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "The main buffer
",
"kind": "member",
"name": "buffer",
"type": {
"names": [
"WebGLBuffer"
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#buffer",
"scope": "instance",
"___id": "T000002R008410",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatabuffer",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * The index buffer\n * @member {WebGLBuffer} PIXI.WebGLGraphicsData#indexBuffer\n */",
"meta": {
"range": [
1383,
1494
],
"filename": "WebGLGraphicsData.js",
"lineno": 52,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "The index buffer
",
"kind": "member",
"name": "indexBuffer",
"type": {
"names": [
"WebGLBuffer"
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#indexBuffer",
"scope": "instance",
"___id": "T000002R008412",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDataindexBuffer",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n * Whether this graphics is dirty or not\n * @member {boolean} PIXI.WebGLGraphicsData#dirty\n */",
"meta": {
"range": [
1570,
1692
],
"filename": "WebGLGraphicsData.js",
"lineno": 58,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"description": "Whether this graphics is dirty or not
",
"kind": "member",
"name": "dirty",
"type": {
"names": [
"boolean"
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#dirty",
"scope": "instance",
"___id": "T000002R008414",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatadirty",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
},
{
"comment": "/**\n *\n * @member {PIXI.Shader} PIXI.WebGLGraphicsData#shader\n */",
"meta": {
"range": [
1791,
1880
],
"filename": "WebGLGraphicsData.js",
"lineno": 67,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics\\webgl",
"code": {}
},
"kind": "member",
"name": "shader",
"type": {
"names": [
"PIXI.Shader"
]
},
"memberof": "PIXI.WebGLGraphicsData",
"longname": "PIXI.WebGLGraphicsData#shader",
"scope": "instance",
"___id": "T000002R008418",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLGraphicsDatashader",
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [],
"filepath": "core\\graphics\\webgl\\WebGLGraphicsData.js"
}