Helper class to create a webGL Texture
| Public methods | |
|---|---|
| public | bindTexture(): void |
| public | getTexture(): void |
| public | updateTexture(texture: PIXI.BaseTexture, PIXI.Texture, location: number): GLTexture |
| public | destroyTexture(texture: PIXI.BaseTexture, PIXI.Texture, skipRemove: boolean): void |
| public | removeAll(): void |
| public | destroy(): void |
| public | bindTexture(): void |
| public | getTexture(): void |
| public | updateTexture(texture: PIXI.BaseTexture, PIXI.Texture, location: number): GLTexture |
| public | destroyTexture(texture: PIXI.BaseTexture, PIXI.Texture, skipRemove: boolean): void |
| public | removeAll(): void |
| public | destroy(): void |
| Name | Type | Attribute | Description |
|---|---|---|---|
| renderer | PIXI.WebGLRenderer | public | A reference to the current renderer |
| gl | WebGLRenderingContext | public | The current WebGL rendering context |
| _managedTextures | Array.<*> | private | Track textures in the renderer so we can no longer listen to them on destruction. |
| renderer | PIXI.WebGLRenderer | public | A reference to the current renderer |
| gl | WebGLRenderingContext | public | The current WebGL rendering context |
| _managedTextures | Array.<*> | private | Track textures in the renderer so we can no longer listen to them on destruction. |
Binds a texture.
void
Gets a texture.
void
Updates and/or Creates a WebGL texture for the renderer's context.
| Name | Type | Attribute | Description |
|---|---|---|---|
| texture | the texture to update |
||
| location | the location the texture will be bound to. |
Deletes the texture from WebGL
| Name | Type | Attribute | Description |
|---|---|---|---|
| texture | the texture to destroy |
||
| skipRemove | Whether to skip removing the texture from the TextureManager. |
void
Deletes all the textures from WebGL
void
Destroys this manager and removes all its textures
void
Binds a texture.
void
Gets a texture.
void
Updates and/or Creates a WebGL texture for the renderer's context.
| Name | Type | Attribute | Description |
|---|---|---|---|
| texture | the texture to update |
||
| location | the location the texture will be bound to. |
Deletes the texture from WebGL
| Name | Type | Attribute | Description |
|---|---|---|---|
| texture | the texture to destroy |
||
| skipRemove | Whether to skip removing the texture from the TextureManager. |
void
Deletes all the textures from WebGL
void
Destroys this manager and removes all its textures
void
{
"comment": "/**\n * Helper class to create a webGL Texture\n *\n * @class\n * @memberof PIXI\n */",
"meta": {
"range": [
303,
7111
],
"filename": "TextureManager.js",
"lineno": 14,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100027254",
"name": "TextureManager",
"type": "ClassDeclaration",
"paramnames": [
"renderer"
]
}
},
"classdesc": "Helper class to create a webGL Texture
",
"kind": "class",
"memberof": "PIXI",
"name": "TextureManager",
"longname": "PIXI.TextureManager",
"scope": "static",
"params": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "A reference to the current renderer
",
"name": "renderer"
}
],
"___id": "T000002R002522",
"___s": true,
"$methods": [
{
"comment": "/**\n * Binds a texture.\n *\n */",
"meta": {
"range": [
1131,
1173
],
"filename": "TextureManager.js",
"lineno": 48,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100027282",
"name": "TextureManager#bindTexture",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Binds a texture.
",
"name": "bindTexture",
"longname": "PIXI.TextureManager#bindTexture",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"params": [],
"___id": "T000002R002530",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerbindTexture",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Gets a texture.\n *\n */",
"meta": {
"range": [
1225,
1266
],
"filename": "TextureManager.js",
"lineno": 57,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100027286",
"name": "TextureManager#getTexture",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Gets a texture.
",
"name": "getTexture",
"longname": "PIXI.TextureManager#getTexture",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"params": [],
"___id": "T000002R002531",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagergetTexture",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Updates and/or Creates a WebGL texture for the renderer's context.\n *\n * @param {PIXI.BaseTexture|PIXI.Texture} texture - the texture to update\n * @param {number} location - the location the texture will be bound to.\n * @return {GLTexture} The gl texture.\n */",
"meta": {
"range": [
1567,
5098
],
"filename": "TextureManager.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100027290",
"name": "TextureManager#updateTexture",
"type": "MethodDefinition",
"paramnames": [
"texture",
"location"
]
},
"vars": {
"": null
}
},
"description": "Updates and/or Creates a WebGL texture for the renderer's context.
",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture",
"PIXI.Texture"
]
},
"description": "the texture to update
",
"name": "texture"
},
{
"type": {
"names": [
"number"
]
},
"description": "the location the texture will be bound to.
",
"name": "location"
}
],
"returns": [
{
"type": {
"names": [
"GLTexture"
]
},
"description": "The gl texture.
"
}
],
"name": "updateTexture",
"longname": "PIXI.TextureManager#updateTexture",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"___id": "T000002R002532",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerupdateTexture",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Deletes the texture from WebGL\n *\n * @param {PIXI.BaseTexture|PIXI.Texture} texture - the texture to destroy\n * @param {boolean} [skipRemove=false] - Whether to skip removing the texture from the TextureManager.\n */",
"meta": {
"range": [
5351,
6168
],
"filename": "TextureManager.js",
"lineno": 194,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100027625",
"name": "TextureManager#destroyTexture",
"type": "MethodDefinition",
"paramnames": [
"texture",
"skipRemove"
]
},
"vars": {
"": null
}
},
"description": "Deletes the texture from WebGL
",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture",
"PIXI.Texture"
]
},
"description": "the texture to destroy
",
"name": "texture"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Whether to skip removing the texture from the TextureManager.
",
"name": "skipRemove"
}
],
"name": "destroyTexture",
"longname": "PIXI.TextureManager#destroyTexture",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"___id": "T000002R002547",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerdestroyTexture",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Deletes all the textures from WebGL\n */",
"meta": {
"range": [
6233,
6622
],
"filename": "TextureManager.js",
"lineno": 228,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100027737",
"name": "TextureManager#removeAll",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Deletes all the textures from WebGL
",
"name": "removeAll",
"longname": "PIXI.TextureManager#removeAll",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"params": [],
"___id": "T000002R002550",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerremoveAll",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Destroys this manager and removes all its textures\n */",
"meta": {
"range": [
6702,
7109
],
"filename": "TextureManager.js",
"lineno": 245,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100027786",
"name": "TextureManager#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Destroys this manager and removes all its textures
",
"name": "destroy",
"longname": "PIXI.TextureManager#destroy",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"params": [],
"___id": "T000002R002553",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerdestroy",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Binds a texture.\n *\n */",
"meta": {
"range": [
1131,
1173
],
"filename": "TextureManager.js",
"lineno": 48,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100101961",
"name": "TextureManager#bindTexture",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Binds a texture.
",
"name": "bindTexture",
"longname": "PIXI.TextureManager#bindTexture",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"params": [],
"___id": "T000002R009464",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerbindTexture",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Gets a texture.\n *\n */",
"meta": {
"range": [
1225,
1266
],
"filename": "TextureManager.js",
"lineno": 57,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100101965",
"name": "TextureManager#getTexture",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Gets a texture.
",
"name": "getTexture",
"longname": "PIXI.TextureManager#getTexture",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"params": [],
"___id": "T000002R009465",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagergetTexture",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Updates and/or Creates a WebGL texture for the renderer's context.\n *\n * @param {PIXI.BaseTexture|PIXI.Texture} texture - the texture to update\n * @param {number} location - the location the texture will be bound to.\n * @return {GLTexture} The gl texture.\n */",
"meta": {
"range": [
1567,
5098
],
"filename": "TextureManager.js",
"lineno": 69,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100101969",
"name": "TextureManager#updateTexture",
"type": "MethodDefinition",
"paramnames": [
"texture",
"location"
]
},
"vars": {
"": null
}
},
"description": "Updates and/or Creates a WebGL texture for the renderer's context.
",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture",
"PIXI.Texture"
]
},
"description": "the texture to update
",
"name": "texture"
},
{
"type": {
"names": [
"number"
]
},
"description": "the location the texture will be bound to.
",
"name": "location"
}
],
"returns": [
{
"type": {
"names": [
"GLTexture"
]
},
"description": "The gl texture.
"
}
],
"name": "updateTexture",
"longname": "PIXI.TextureManager#updateTexture",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"___id": "T000002R009466",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerupdateTexture",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Deletes the texture from WebGL\n *\n * @param {PIXI.BaseTexture|PIXI.Texture} texture - the texture to destroy\n * @param {boolean} [skipRemove=false] - Whether to skip removing the texture from the TextureManager.\n */",
"meta": {
"range": [
5351,
6168
],
"filename": "TextureManager.js",
"lineno": 194,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100102304",
"name": "TextureManager#destroyTexture",
"type": "MethodDefinition",
"paramnames": [
"texture",
"skipRemove"
]
},
"vars": {
"": null
}
},
"description": "Deletes the texture from WebGL
",
"params": [
{
"type": {
"names": [
"PIXI.BaseTexture",
"PIXI.Texture"
]
},
"description": "the texture to destroy
",
"name": "texture"
},
{
"type": {
"names": [
"boolean"
]
},
"optional": true,
"defaultvalue": false,
"description": "Whether to skip removing the texture from the TextureManager.
",
"name": "skipRemove"
}
],
"name": "destroyTexture",
"longname": "PIXI.TextureManager#destroyTexture",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"___id": "T000002R009481",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerdestroyTexture",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Deletes all the textures from WebGL\n */",
"meta": {
"range": [
6233,
6622
],
"filename": "TextureManager.js",
"lineno": 228,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100102416",
"name": "TextureManager#removeAll",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Deletes all the textures from WebGL
",
"name": "removeAll",
"longname": "PIXI.TextureManager#removeAll",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"params": [],
"___id": "T000002R009484",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerremoveAll",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Destroys this manager and removes all its textures\n */",
"meta": {
"range": [
6702,
7109
],
"filename": "TextureManager.js",
"lineno": 245,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {
"id": "astnode100102465",
"name": "TextureManager#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Destroys this manager and removes all its textures
",
"name": "destroy",
"longname": "PIXI.TextureManager#destroy",
"kind": "function",
"memberof": "PIXI.TextureManager",
"scope": "instance",
"params": [],
"___id": "T000002R009487",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerdestroy",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
}
],
"$attributes": [
{
"comment": "/**\n * A reference to the current renderer\n *\n * @member {PIXI.WebGLRenderer} PIXI.TextureManager#renderer\n */",
"meta": {
"range": [
464,
606
],
"filename": "TextureManager.js",
"lineno": 21,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "A reference to the current renderer
",
"kind": "member",
"name": "renderer",
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"memberof": "PIXI.TextureManager",
"longname": "PIXI.TextureManager#renderer",
"scope": "instance",
"___id": "T000002R002524",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerrenderer",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * The current WebGL rendering context\n *\n * @member {WebGLRenderingContext} PIXI.TextureManager#gl\n */",
"meta": {
"range": [
650,
789
],
"filename": "TextureManager.js",
"lineno": 28,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "The current WebGL rendering context
",
"kind": "member",
"name": "gl",
"type": {
"names": [
"WebGLRenderingContext"
]
},
"memberof": "PIXI.TextureManager",
"longname": "PIXI.TextureManager#gl",
"scope": "instance",
"___id": "T000002R002526",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagergl",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Track textures in the renderer so we can no longer listen to them on destruction.\n *\n * @member {Array<*>} PIXI.TextureManager#_managedTextures\n * @private\n */",
"meta": {
"range": [
830,
1036
],
"filename": "TextureManager.js",
"lineno": 35,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Track textures in the renderer so we can no longer listen to them on destruction.
",
"kind": "member",
"name": "_managedTextures",
"type": {
"names": [
"Array.<*>"
]
},
"access": "private",
"memberof": "PIXI.TextureManager",
"longname": "PIXI.TextureManager#_managedTextures",
"scope": "instance",
"___id": "T000002R002528",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManager_managedTextures",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * A reference to the current renderer\n *\n * @member {PIXI.WebGLRenderer} PIXI.TextureManager#renderer\n */",
"meta": {
"range": [
464,
606
],
"filename": "TextureManager.js",
"lineno": 21,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "A reference to the current renderer
",
"kind": "member",
"name": "renderer",
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"memberof": "PIXI.TextureManager",
"longname": "PIXI.TextureManager#renderer",
"scope": "instance",
"___id": "T000002R009458",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagerrenderer",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * The current WebGL rendering context\n *\n * @member {WebGLRenderingContext} PIXI.TextureManager#gl\n */",
"meta": {
"range": [
650,
789
],
"filename": "TextureManager.js",
"lineno": 28,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "The current WebGL rendering context
",
"kind": "member",
"name": "gl",
"type": {
"names": [
"WebGLRenderingContext"
]
},
"memberof": "PIXI.TextureManager",
"longname": "PIXI.TextureManager#gl",
"scope": "instance",
"___id": "T000002R009460",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManagergl",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
},
{
"comment": "/**\n * Track textures in the renderer so we can no longer listen to them on destruction.\n *\n * @member {Array<*>} PIXI.TextureManager#_managedTextures\n * @private\n */",
"meta": {
"range": [
830,
1036
],
"filename": "TextureManager.js",
"lineno": 35,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl",
"code": {}
},
"description": "Track textures in the renderer so we can no longer listen to them on destruction.
",
"kind": "member",
"name": "_managedTextures",
"type": {
"names": [
"Array.<*>"
]
},
"access": "private",
"memberof": "PIXI.TextureManager",
"longname": "PIXI.TextureManager#_managedTextures",
"scope": "instance",
"___id": "T000002R009462",
"___s": true,
"skip": true,
"slug": "PIXI.TextureManager_managedTextures",
"filepath": "core\\renderers\\webgl\\TextureManager.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [],
"filepath": "core\\renderers\\webgl\\TextureManager.js"
}