class: CanvasMaskManager

A set of functions used to handle masking.

Methods summary

Methods

pushMask(maskData: object): void

This method adds it to the current stack of masks.

Params:

Returns:

void

renderGraphicsShape(graphics: PIXI.Graphics): void

Renders a PIXI.Graphics shape.

Params:

Returns:

void

popMask(renderer: PIXI.CanvasRenderer): void

Restores the current drawing context to the state it was before the mask was applied.

Params:

Returns:

void

destroy(): void

Destroys this canvas mask manager.

Returns:

void

pushMask(maskData: object): void

This method adds it to the current stack of masks.

Params:

Returns:

void

renderGraphicsShape(graphics: PIXI.Graphics): void

Renders a PIXI.Graphics shape.

Params:

Returns:

void

popMask(renderer: PIXI.CanvasRenderer): void

Restores the current drawing context to the state it was before the mask was applied.

Params:

Returns:

void

destroy(): void

Destroys this canvas mask manager.

Returns:

void

  {
    "comment": "/**\n * A set of functions used to handle masking.\n *\n * @class\n * @memberof PIXI\n */",
    "meta": {
        "range": [
            162,
            5479
        ],
        "filename": "CanvasMaskManager.js",
        "lineno": 11,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas\\utils",
        "code": {
            "id": "astnode100021500",
            "name": "CanvasMaskManager",
            "type": "ClassDeclaration",
            "paramnames": [
                "renderer"
            ]
        }
    },
    "classdesc": "
A set of functions used to handle masking.
",
    "kind": "class",
    "memberof": "PIXI",
    "name": "CanvasMaskManager",
    "longname": "PIXI.CanvasMaskManager",
    "scope": "static",
    "params": [
        {
            "type": {
                "names": [
                    "PIXI.CanvasRenderer"
                ]
            },
            "description": "
The canvas renderer.
",
            "name": "renderer"
        }
    ],
    "___id": "T000002R002032",
    "___s": true,
    "$methods": [
        {
            "comment": "/**\n     * This method adds it to the current stack of masks.\n     *\n     * @param {object} maskData - the maskData that will be pushed\n     */",
            "meta": {
                "range": [
                    497,
                    1323
                ],
                "filename": "CanvasMaskManager.js",
                "lineno": 26,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas\\utils",
                "code": {
                    "id": "astnode100021514",
                    "name": "CanvasMaskManager#pushMask",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "maskData"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
This method adds it to the current stack of masks.
",
            "params": [
                {
                    "type": {
                        "names": [
                            "object"
                        ]
                    },
                    "description": "
the maskData that will be pushed
",
                    "name": "maskData"
                }
            ],
            "name": "pushMask",
            "longname": "PIXI.CanvasMaskManager#pushMask",
            "kind": "function",
            "memberof": "PIXI.CanvasMaskManager",
            "scope": "instance",
            "___id": "T000002R002035",
            "___s": true,
            "skip": true,
            "slug": "PIXI.CanvasMaskManagerpushMask",
            "filepath": "core\\renderers\\canvas\\utils\\CanvasMaskManager.js"
        },
        {
            "comment": "/**\n     * Renders a PIXI.Graphics shape.\n     *\n     * @param {PIXI.Graphics} graphics - The object to render.\n     */",
            "meta": {
                "range": [
                    1453,
                    5102
                ],
                "filename": "CanvasMaskManager.js",
                "lineno": 61,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas\\utils",
                "code": {
                    "id": "astnode100021614",
                    "name": "CanvasMaskManager#renderGraphicsShape",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "graphics"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Renders a PIXI.Graphics shape.
",
            "params": [
                {
                    "type": {
                        "names": [
                            "PIXI.Graphics"
                        ]
                    },
                    "description": "
The object to render.
",
                    "name": "graphics"
                }
            ],
            "name": "renderGraphicsShape",
            "longname": "PIXI.CanvasMaskManager#renderGraphicsShape",
            "kind": "function",
            "memberof": "PIXI.CanvasMaskManager",
            "scope": "instance",
            "___id": "T000002R002041",
            "___s": true,
            "skip": true,
            "slug": "PIXI.CanvasMaskManagerrenderGraphicsShape",
            "filepath": "core\\renderers\\canvas\\utils\\CanvasMaskManager.js"
        },
        {
            "comment": "/**\n     * Restores the current drawing context to the state it was before the mask was applied.\n     *\n     * @param {PIXI.CanvasRenderer} renderer - The renderer context to use.\n     */",
            "meta": {
                "range": [
                    5300,
                    5365
                ],
                "filename": "CanvasMaskManager.js",
                "lineno": 162,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas\\utils",
                "code": {
                    "id": "astnode100022168",
                    "name": "CanvasMaskManager#popMask",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "renderer"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Restores the current drawing context to the state it was before the mask was applied.
",
            "params": [
                {
                    "type": {
                        "names": [
                            "PIXI.CanvasRenderer"
                        ]
                    },
                    "description": "
The renderer context to use.
",
                    "name": "renderer"
                }
            ],
            "name": "popMask",
            "longname": "PIXI.CanvasMaskManager#popMask",
            "kind": "function",
            "memberof": "PIXI.CanvasMaskManager",
            "scope": "instance",
            "___id": "T000002R002067",
            "___s": true,
            "skip": true,
            "slug": "PIXI.CanvasMaskManagerpopMask",
            "filepath": "core\\renderers\\canvas\\utils\\CanvasMaskManager.js"
        },
        {
            "comment": "/**\n     * Destroys this canvas mask manager.\n     *\n     */",
            "meta": {
                "range": [
                    5436,
                    5477
                ],
                "filename": "CanvasMaskManager.js",
                "lineno": 171,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas\\utils",
                "code": {
                    "id": "astnode100022180",
                    "name": "CanvasMaskManager#destroy",
                    "type": "MethodDefinition",
                    "paramnames": []
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Destroys this canvas mask manager.
",
            "name": "destroy",
            "longname": "PIXI.CanvasMaskManager#destroy",
            "kind": "function",
            "memberof": "PIXI.CanvasMaskManager",
            "scope": "instance",
            "params": [],
            "___id": "T000002R002068",
            "___s": true,
            "skip": true,
            "slug": "PIXI.CanvasMaskManagerdestroy",
            "filepath": "core\\renderers\\canvas\\utils\\CanvasMaskManager.js"
        },
        {
            "comment": "/**\n     * This method adds it to the current stack of masks.\n     *\n     * @param {object} maskData - the maskData that will be pushed\n     */",
            "meta": {
                "range": [
                    497,
                    1323
                ],
                "filename": "CanvasMaskManager.js",
                "lineno": 26,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas\\utils",
                "code": {
                    "id": "astnode100096193",
                    "name": "CanvasMaskManager#pushMask",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "maskData"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
This method adds it to the current stack of masks.
",
            "params": [
                {
                    "type": {
                        "names": [
                            "object"
                        ]
                    },
                    "description": "
the maskData that will be pushed
",
                    "name": "maskData"
                }
            ],
            "name": "pushMask",
            "longname": "PIXI.CanvasMaskManager#pushMask",
            "kind": "function",
            "memberof": "PIXI.CanvasMaskManager",
            "scope": "instance",
            "___id": "T000002R008969",
            "___s": true,
            "skip": true,
            "slug": "PIXI.CanvasMaskManagerpushMask",
            "filepath": "core\\renderers\\canvas\\utils\\CanvasMaskManager.js"
        },
        {
            "comment": "/**\n     * Renders a PIXI.Graphics shape.\n     *\n     * @param {PIXI.Graphics} graphics - The object to render.\n     */",
            "meta": {
                "range": [
                    1453,
                    5102
                ],
                "filename": "CanvasMaskManager.js",
                "lineno": 61,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas\\utils",
                "code": {
                    "id": "astnode100096293",
                    "name": "CanvasMaskManager#renderGraphicsShape",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "graphics"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Renders a PIXI.Graphics shape.
",
            "params": [
                {
                    "type": {
                        "names": [
                            "PIXI.Graphics"
                        ]
                    },
                    "description": "
The object to render.
",
                    "name": "graphics"
                }
            ],
            "name": "renderGraphicsShape",
            "longname": "PIXI.CanvasMaskManager#renderGraphicsShape",
            "kind": "function",
            "memberof": "PIXI.CanvasMaskManager",
            "scope": "instance",
            "___id": "T000002R008975",
            "___s": true,
            "skip": true,
            "slug": "PIXI.CanvasMaskManagerrenderGraphicsShape",
            "filepath": "core\\renderers\\canvas\\utils\\CanvasMaskManager.js"
        },
        {
            "comment": "/**\n     * Restores the current drawing context to the state it was before the mask was applied.\n     *\n     * @param {PIXI.CanvasRenderer} renderer - The renderer context to use.\n     */",
            "meta": {
                "range": [
                    5300,
                    5365
                ],
                "filename": "CanvasMaskManager.js",
                "lineno": 162,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas\\utils",
                "code": {
                    "id": "astnode100096847",
                    "name": "CanvasMaskManager#popMask",
                    "type": "MethodDefinition",
                    "paramnames": [
                        "renderer"
                    ]
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Restores the current drawing context to the state it was before the mask was applied.
",
            "params": [
                {
                    "type": {
                        "names": [
                            "PIXI.CanvasRenderer"
                        ]
                    },
                    "description": "
The renderer context to use.
",
                    "name": "renderer"
                }
            ],
            "name": "popMask",
            "longname": "PIXI.CanvasMaskManager#popMask",
            "kind": "function",
            "memberof": "PIXI.CanvasMaskManager",
            "scope": "instance",
            "___id": "T000002R009001",
            "___s": true,
            "skip": true,
            "slug": "PIXI.CanvasMaskManagerpopMask",
            "filepath": "core\\renderers\\canvas\\utils\\CanvasMaskManager.js"
        },
        {
            "comment": "/**\n     * Destroys this canvas mask manager.\n     *\n     */",
            "meta": {
                "range": [
                    5436,
                    5477
                ],
                "filename": "CanvasMaskManager.js",
                "lineno": 171,
                "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\renderers\\canvas\\utils",
                "code": {
                    "id": "astnode100096859",
                    "name": "CanvasMaskManager#destroy",
                    "type": "MethodDefinition",
                    "paramnames": []
                },
                "vars": {
                    "": null
                }
            },
            "description": "
Destroys this canvas mask manager.
",
            "name": "destroy",
            "longname": "PIXI.CanvasMaskManager#destroy",
            "kind": "function",
            "memberof": "PIXI.CanvasMaskManager",
            "scope": "instance",
            "params": [],
            "___id": "T000002R009002",
            "___s": true,
            "skip": true,
            "slug": "PIXI.CanvasMaskManagerdestroy",
            "filepath": "core\\renderers\\canvas\\utils\\CanvasMaskManager.js"
        }
    ],
    "$attributes": [],
    "$staticmethods": [],
    "$staticproperties": [],
    "$augments": [],
    "$augmentedBy": [],
    "filepath": "core\\renderers\\canvas\\utils\\CanvasMaskManager.js"
}