| Public methods | |
|---|---|
| public |
setMaskStack(stencilMaskStack: Array. |
| public | pushStencil(graphics: PIXI.Graphics): void |
| public | popStencil(): void |
| public | destroy(): void |
| public |
setMaskStack(stencilMaskStack: Array. |
| public | pushStencil(graphics: PIXI.Graphics): void |
| public | popStencil(): void |
| public | destroy(): void |
| public | onContextChange(): void |
| Name | Type | Attribute | Description |
|---|---|---|---|
| renderer | PIXI.WebGLRenderer | public | The renderer this manager works for. |
Changes the mask stack that is used by this manager.
| Name | Type | Attribute | Description |
|---|---|---|---|
| stencilMaskStack | The mask stack |
void
Applies the Mask and adds it to the current filter stack. @alvin
| Name | Type | Attribute | Description |
|---|---|---|---|
| graphics | The mask |
void
TODO @alvin
void
Destroys the mask stack.
void
Changes the mask stack that is used by this manager.
| Name | Type | Attribute | Description |
|---|---|---|---|
| stencilMaskStack | The mask stack |
void
Applies the Mask and adds it to the current filter stack. @alvin
| Name | Type | Attribute | Description |
|---|---|---|---|
| graphics | The mask |
void
TODO @alvin
void
Destroys the mask stack.
void
Generic method called when there is a WebGL context change.
void
{
"comment": "/**\n * @class\n * @extends PIXI.WebGLManager\n * @memberof PIXI\n */",
"meta": {
"range": [
142,
2700
],
"filename": "StencilManager.js",
"lineno": 10,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026535",
"name": "StencilManager",
"type": "ClassDeclaration",
"paramnames": [
"renderer"
]
}
},
"kind": "class",
"augments": [
"PIXI.WebGLManager"
],
"memberof": "PIXI",
"name": "StencilManager",
"longname": "PIXI.StencilManager",
"scope": "static",
"params": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "The renderer this manager works for.
",
"name": "renderer"
}
],
"___id": "T000002R002472",
"___s": true,
"$methods": [
{
"comment": "/**\n * Changes the mask stack that is used by this manager.\n *\n * @param {PIXI.Graphics[]} stencilMaskStack - The mask stack\n */",
"meta": {
"range": [
540,
848
],
"filename": "StencilManager.js",
"lineno": 26,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026554",
"name": "StencilManager#setMaskStack",
"type": "MethodDefinition",
"paramnames": [
"stencilMaskStack"
]
},
"vars": {
"": null
}
},
"description": "Changes the mask stack that is used by this manager.
",
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "The mask stack
",
"name": "stencilMaskStack"
}
],
"name": "setMaskStack",
"longname": "PIXI.StencilManager#setMaskStack",
"kind": "function",
"memberof": "PIXI.StencilManager",
"scope": "instance",
"___id": "T000002R002475",
"___s": true,
"skip": true,
"slug": "PIXI.StencilManagersetMaskStack",
"filepath": "core\\renderers\\webgl\\managers\\StencilManager.js"
},
{
"comment": "/**\n * Applies the Mask and adds it to the current filter stack. @alvin\n *\n * @param {PIXI.Graphics} graphics - The mask\n */",
"meta": {
"range": [
999,
1768
],
"filename": "StencilManager.js",
"lineno": 47,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026597",
"name": "StencilManager#pushStencil",
"type": "MethodDefinition",
"paramnames": [
"graphics"
]
},
"vars": {
"": null
}
},
"description": "Applies the Mask and adds it to the current filter stack. @alvin
",
"params": [
{
"type": {
"names": [
"PIXI.Graphics"
]
},
"description": "The mask
",
"name": "graphics"
}
],
"name": "pushStencil",
"longname": "PIXI.StencilManager#pushStencil",
"kind": "function",
"memberof": "PIXI.StencilManager",
"scope": "instance",
"___id": "T000002R002478",
"___s": true,
"skip": true,
"slug": "PIXI.StencilManagerpushStencil",
"filepath": "core\\renderers\\webgl\\managers\\StencilManager.js"
},
{
"comment": "/**\n * TODO @alvin\n */",
"meta": {
"range": [
1809,
2513
],
"filename": "StencilManager.js",
"lineno": 78,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026748",
"name": "StencilManager#popStencil",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "TODO @alvin
",
"name": "popStencil",
"longname": "PIXI.StencilManager#popStencil",
"kind": "function",
"memberof": "PIXI.StencilManager",
"scope": "instance",
"params": [],
"___id": "T000002R002481",
"___s": true,
"skip": true,
"slug": "PIXI.StencilManagerpopStencil",
"filepath": "core\\renderers\\webgl\\managers\\StencilManager.js"
},
{
"comment": "/**\n * Destroys the mask stack.\n *\n */",
"meta": {
"range": [
2574,
2698
],
"filename": "StencilManager.js",
"lineno": 109,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026873",
"name": "StencilManager#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Destroys the mask stack.
",
"name": "destroy",
"longname": "PIXI.StencilManager#destroy",
"kind": "function",
"memberof": "PIXI.StencilManager",
"scope": "instance",
"params": [],
"overrides": "PIXI.WebGLManager#destroy",
"___id": "T000002R002485",
"___s": true,
"skip": true,
"slug": "PIXI.StencilManagerdestroy",
"filepath": "core\\renderers\\webgl\\managers\\StencilManager.js"
},
{
"comment": "/**\n * Changes the mask stack that is used by this manager.\n *\n * @param {PIXI.Graphics[]} stencilMaskStack - The mask stack\n */",
"meta": {
"range": [
540,
848
],
"filename": "StencilManager.js",
"lineno": 26,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100101233",
"name": "StencilManager#setMaskStack",
"type": "MethodDefinition",
"paramnames": [
"stencilMaskStack"
]
},
"vars": {
"": null
}
},
"description": "Changes the mask stack that is used by this manager.
",
"params": [
{
"type": {
"names": [
"Array."
]
},
"description": "The mask stack
",
"name": "stencilMaskStack"
}
],
"name": "setMaskStack",
"longname": "PIXI.StencilManager#setMaskStack",
"kind": "function",
"memberof": "PIXI.StencilManager",
"scope": "instance",
"___id": "T000002R009409",
"___s": true,
"skip": true,
"slug": "PIXI.StencilManagersetMaskStack",
"filepath": "core\\renderers\\webgl\\managers\\StencilManager.js"
},
{
"comment": "/**\n * Applies the Mask and adds it to the current filter stack. @alvin\n *\n * @param {PIXI.Graphics} graphics - The mask\n */",
"meta": {
"range": [
999,
1768
],
"filename": "StencilManager.js",
"lineno": 47,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100101276",
"name": "StencilManager#pushStencil",
"type": "MethodDefinition",
"paramnames": [
"graphics"
]
},
"vars": {
"": null
}
},
"description": "Applies the Mask and adds it to the current filter stack. @alvin
",
"params": [
{
"type": {
"names": [
"PIXI.Graphics"
]
},
"description": "The mask
",
"name": "graphics"
}
],
"name": "pushStencil",
"longname": "PIXI.StencilManager#pushStencil",
"kind": "function",
"memberof": "PIXI.StencilManager",
"scope": "instance",
"___id": "T000002R009412",
"___s": true,
"skip": true,
"slug": "PIXI.StencilManagerpushStencil",
"filepath": "core\\renderers\\webgl\\managers\\StencilManager.js"
},
{
"comment": "/**\n * TODO @alvin\n */",
"meta": {
"range": [
1809,
2513
],
"filename": "StencilManager.js",
"lineno": 78,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100101427",
"name": "StencilManager#popStencil",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "TODO @alvin
",
"name": "popStencil",
"longname": "PIXI.StencilManager#popStencil",
"kind": "function",
"memberof": "PIXI.StencilManager",
"scope": "instance",
"params": [],
"___id": "T000002R009415",
"___s": true,
"skip": true,
"slug": "PIXI.StencilManagerpopStencil",
"filepath": "core\\renderers\\webgl\\managers\\StencilManager.js"
},
{
"comment": "/**\n * Destroys the mask stack.\n *\n */",
"meta": {
"range": [
2574,
2698
],
"filename": "StencilManager.js",
"lineno": 109,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100101552",
"name": "StencilManager#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Destroys the mask stack.
",
"name": "destroy",
"longname": "PIXI.StencilManager#destroy",
"kind": "function",
"memberof": "PIXI.StencilManager",
"scope": "instance",
"params": [],
"overrides": "PIXI.WebGLManager#destroy",
"___id": "T000002R009419",
"___s": true,
"skip": true,
"slug": "PIXI.StencilManagerdestroy",
"filepath": "core\\renderers\\webgl\\managers\\StencilManager.js"
},
{
"comment": "/**\n * Generic method called when there is a WebGL context change.\n *\n */",
"meta": {
"range": [
569,
629
],
"filename": "WebGLManager.js",
"lineno": 28,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026924",
"name": "WebGLManager#onContextChange",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic method called when there is a WebGL context change.
",
"name": "onContextChange",
"longname": "PIXI.StencilManager#onContextChange",
"kind": "function",
"memberof": "PIXI.StencilManager",
"scope": "instance",
"params": [],
"inherits": "PIXI.WebGLManager#onContextChange",
"inherited": true,
"overrides": "PIXI.WebGLManager#onContextChange",
"___id": "T000002R013999",
"___s": true,
"skip": true,
"slug": "PIXI.StencilManageronContextChange",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
}
],
"$attributes": [
{
"comment": "/**\n * The renderer this manager works for.\n *\n * @member {PIXI.WebGLRenderer} PIXI.WebGLManager#renderer\n */",
"meta": {
"range": [
226,
367
],
"filename": "WebGLManager.js",
"lineno": 14,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {}
},
"description": "The renderer this manager works for.
",
"kind": "member",
"name": "renderer",
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"memberof": "PIXI.StencilManager",
"longname": "PIXI.StencilManager#renderer",
"scope": "instance",
"inherits": "PIXI.WebGLManager#renderer",
"inherited": true,
"overrides": "PIXI.WebGLManager#renderer",
"___id": "T000002R013998",
"___s": true,
"skip": true,
"slug": "PIXI.StencilManagerrenderer",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [
{
"comment": "/**\n * @class\n * @memberof PIXI\n */",
"meta": {
"range": [
66,
842
],
"filename": "WebGLManager.js",
"lineno": 7,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026898",
"name": "WebGLManager",
"type": "ClassDeclaration",
"paramnames": [
"renderer"
]
}
},
"kind": "class",
"memberof": "PIXI",
"name": "WebGLManager",
"longname": "PIXI.WebGLManager",
"scope": "static",
"params": [
{
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"description": "The renderer this manager works for.
",
"name": "renderer"
}
],
"___id": "T000002R002488",
"___s": true,
"$methods": [
{
"comment": "/**\n * Generic method called when there is a WebGL context change.\n *\n */",
"meta": {
"range": [
569,
629
],
"filename": "WebGLManager.js",
"lineno": 28,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026924",
"name": "WebGLManager#onContextChange",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic method called when there is a WebGL context change.
",
"name": "onContextChange",
"longname": "PIXI.WebGLManager#onContextChange",
"kind": "function",
"memberof": "PIXI.WebGLManager",
"scope": "instance",
"params": [],
"___id": "T000002R002492",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManageronContextChange",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
},
{
"comment": "/**\n * Generic destroy methods to be overridden by the subclass\n *\n */",
"meta": {
"range": [
722,
840
],
"filename": "WebGLManager.js",
"lineno": 37,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100026928",
"name": "WebGLManager#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic destroy methods to be overridden by the subclass
",
"name": "destroy",
"longname": "PIXI.WebGLManager#destroy",
"kind": "function",
"memberof": "PIXI.WebGLManager",
"scope": "instance",
"params": [],
"___id": "T000002R002493",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManagerdestroy",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
},
{
"comment": "/**\n * Generic method called when there is a WebGL context change.\n *\n */",
"meta": {
"range": [
569,
629
],
"filename": "WebGLManager.js",
"lineno": 28,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100101603",
"name": "WebGLManager#onContextChange",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic method called when there is a WebGL context change.
",
"name": "onContextChange",
"longname": "PIXI.WebGLManager#onContextChange",
"kind": "function",
"memberof": "PIXI.WebGLManager",
"scope": "instance",
"params": [],
"___id": "T000002R009426",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManageronContextChange",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
},
{
"comment": "/**\n * Generic destroy methods to be overridden by the subclass\n *\n */",
"meta": {
"range": [
722,
840
],
"filename": "WebGLManager.js",
"lineno": 37,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {
"id": "astnode100101607",
"name": "WebGLManager#destroy",
"type": "MethodDefinition",
"paramnames": []
},
"vars": {
"": null
}
},
"description": "Generic destroy methods to be overridden by the subclass
",
"name": "destroy",
"longname": "PIXI.WebGLManager#destroy",
"kind": "function",
"memberof": "PIXI.WebGLManager",
"scope": "instance",
"params": [],
"___id": "T000002R009427",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManagerdestroy",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
}
],
"$attributes": [
{
"comment": "/**\n * The renderer this manager works for.\n *\n * @member {PIXI.WebGLRenderer} PIXI.WebGLManager#renderer\n */",
"meta": {
"range": [
226,
367
],
"filename": "WebGLManager.js",
"lineno": 14,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {}
},
"description": "The renderer this manager works for.
",
"kind": "member",
"name": "renderer",
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"memberof": "PIXI.WebGLManager",
"longname": "PIXI.WebGLManager#renderer",
"scope": "instance",
"___id": "T000002R002490",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManagerrenderer",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
},
{
"comment": "/**\n * The renderer this manager works for.\n *\n * @member {PIXI.WebGLRenderer} PIXI.WebGLManager#renderer\n */",
"meta": {
"range": [
226,
367
],
"filename": "WebGLManager.js",
"lineno": 14,
"path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\webgl\\managers",
"code": {}
},
"description": "The renderer this manager works for.
",
"kind": "member",
"name": "renderer",
"type": {
"names": [
"PIXI.WebGLRenderer"
]
},
"memberof": "PIXI.WebGLManager",
"longname": "PIXI.WebGLManager#renderer",
"scope": "instance",
"___id": "T000002R009424",
"___s": true,
"skip": true,
"slug": "PIXI.WebGLManagerrenderer",
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
}
],
"$staticmethods": [],
"$staticproperties": [],
"$augments": [],
"$augmentedBy": [
{
"name": "BlendModeManager"
},
{
"name": "FilterManager"
},
{
"name": "MaskManager"
},
{
"name": "StencilManager"
},
{
"name": "ObjectRenderer"
},
{
"name": "BlendModeManager"
},
{
"name": "FilterManager"
},
{
"name": "MaskManager"
},
{
"name": "StencilManager"
},
{
"name": "ObjectRenderer"
}
],
"filepath": "core\\renderers\\webgl\\managers\\WebGLManager.js"
}
],
"$augmentedBy": [],
"filepath": "core\\renderers\\webgl\\managers\\StencilManager.js"
}