Home

class: GraphicsData


A GraphicsData object.

Methods summary


Public methods
public clone(): PIXI.GraphicsData
public addHole(shape: PIXI.Rectangle, PIXI.Circle): void
public destroy(): void
public clone(): PIXI.GraphicsData
public addHole(shape: PIXI.Rectangle, PIXI.Circle): void
public destroy(): void

Methods


clone(): PIXI.GraphicsData

Creates a new GraphicsData object with the same values as this one.

Returns:

PIXI.GraphicsData


addHole(shape: PIXI.Rectangle, PIXI.Circle): void

Adds a hole to the shape.

Params:

Name Type Attribute Description
shape

The shape of the hole.

Returns:

void


destroy(): void

Destroys the Graphics data.

Returns:

void


clone(): PIXI.GraphicsData

Creates a new GraphicsData object with the same values as this one.

Returns:

PIXI.GraphicsData


addHole(shape: PIXI.Rectangle, PIXI.Circle): void

Adds a hole to the shape.

Params:

Name Type Attribute Description
shape

The shape of the hole.

Returns:

void


destroy(): void

Destroys the Graphics data.

Returns:

void


  {
    "comment": "/**\n * A GraphicsData object.\n *\n * @class\n * @memberof PIXI\n */",
    "meta": {
        "range": [
            95,
            3045
        ],
        "filename": "GraphicsData.js",
        "lineno": 9,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics",
        "code": {
            "id": "astnode100012225",
            "name": "GraphicsData",
            "type": "ClassDeclaration",
            "paramnames": [
                "lineWidth",
                "lineColor",
                "lineAlpha",
                "fillColor",
                "fillAlpha",
                "fill",
                "nativeLines",
                "shape"
            ]
        }
    },
    "classdesc": "

A GraphicsData object.

", "kind": "class", "memberof": "PIXI", "name": "GraphicsData", "longname": "PIXI.GraphicsData", "scope": "static", "params": [ { "type": { "names": [ "number" ] }, "description": "

the width of the line to draw

", "name": "lineWidth" }, { "type": { "names": [ "number" ] }, "description": "

the color of the line to draw

", "name": "lineColor" }, { "type": { "names": [ "number" ] }, "description": "

the alpha of the line to draw

", "name": "lineAlpha" }, { "type": { "names": [ "number" ] }, "description": "

the color of the fill

", "name": "fillColor" }, { "type": { "names": [ "number" ] }, "description": "

the alpha of the fill

", "name": "fillAlpha" }, { "type": { "names": [ "boolean" ] }, "description": "

whether or not the shape is filled with a colour

", "name": "fill" }, { "type": { "names": [ "boolean" ] }, "description": "

the method for drawing lines

", "name": "nativeLines" }, { "type": { "names": [ "PIXI.Circle", "PIXI.Rectangle", "PIXI.Ellipse", "PIXI.Polygon" ] }, "description": "

The shape object to draw.

", "name": "shape" } ], "___id": "T000002R001125", "___s": true, "$methods": [ { "comment": "/**\n * Creates a new GraphicsData object with the same values as this one.\n *\n * @return {PIXI.GraphicsData} Cloned GraphicsData object\n */", "meta": { "range": [ 2438, 2717 ], "filename": "GraphicsData.js", "lineno": 86, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100012314", "name": "GraphicsData#clone", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Creates a new GraphicsData object with the same values as this one.

", "returns": [ { "type": { "names": [ "PIXI.GraphicsData" ] }, "description": "

Cloned GraphicsData object

" } ], "name": "clone", "longname": "PIXI.GraphicsData#clone", "kind": "function", "memberof": "PIXI.GraphicsData", "scope": "instance", "params": [], "___id": "T000002R001150", "___s": true, "skip": true, "slug": "PIXI.GraphicsDataclone", "filepath": "core\\graphics\\GraphicsData.js" }, { "comment": "/**\n * Adds a hole to the shape.\n *\n * @param {PIXI.Rectangle|PIXI.Circle} shape - The shape of the hole.\n */", "meta": { "range": [ 2853, 2911 ], "filename": "GraphicsData.js", "lineno": 105, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100012345", "name": "GraphicsData#addHole", "type": "MethodDefinition", "paramnames": [ "shape" ] }, "vars": { "": null } }, "description": "

Adds a hole to the shape.

", "params": [ { "type": { "names": [ "PIXI.Rectangle", "PIXI.Circle" ] }, "description": "

The shape of the hole.

", "name": "shape" } ], "name": "addHole", "longname": "PIXI.GraphicsData#addHole", "kind": "function", "memberof": "PIXI.GraphicsData", "scope": "instance", "___id": "T000002R001151", "___s": true, "skip": true, "slug": "PIXI.GraphicsDataaddHole", "filepath": "core\\graphics\\GraphicsData.js" }, { "comment": "/**\n * Destroys the Graphics data.\n */", "meta": { "range": [ 2968, 3043 ], "filename": "GraphicsData.js", "lineno": 113, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100012358", "name": "GraphicsData#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroys the Graphics data.

", "name": "destroy", "longname": "PIXI.GraphicsData#destroy", "kind": "function", "memberof": "PIXI.GraphicsData", "scope": "instance", "params": [], "___id": "T000002R001152", "___s": true, "skip": true, "slug": "PIXI.GraphicsDatadestroy", "filepath": "core\\graphics\\GraphicsData.js" }, { "comment": "/**\n * Creates a new GraphicsData object with the same values as this one.\n *\n * @return {PIXI.GraphicsData} Cloned GraphicsData object\n */", "meta": { "range": [ 2438, 2717 ], "filename": "GraphicsData.js", "lineno": 86, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100086993", "name": "GraphicsData#clone", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Creates a new GraphicsData object with the same values as this one.

", "returns": [ { "type": { "names": [ "PIXI.GraphicsData" ] }, "description": "

Cloned GraphicsData object

" } ], "name": "clone", "longname": "PIXI.GraphicsData#clone", "kind": "function", "memberof": "PIXI.GraphicsData", "scope": "instance", "params": [], "___id": "T000002R008084", "___s": true, "skip": true, "slug": "PIXI.GraphicsDataclone", "filepath": "core\\graphics\\GraphicsData.js" }, { "comment": "/**\n * Adds a hole to the shape.\n *\n * @param {PIXI.Rectangle|PIXI.Circle} shape - The shape of the hole.\n */", "meta": { "range": [ 2853, 2911 ], "filename": "GraphicsData.js", "lineno": 105, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100087024", "name": "GraphicsData#addHole", "type": "MethodDefinition", "paramnames": [ "shape" ] }, "vars": { "": null } }, "description": "

Adds a hole to the shape.

", "params": [ { "type": { "names": [ "PIXI.Rectangle", "PIXI.Circle" ] }, "description": "

The shape of the hole.

", "name": "shape" } ], "name": "addHole", "longname": "PIXI.GraphicsData#addHole", "kind": "function", "memberof": "PIXI.GraphicsData", "scope": "instance", "___id": "T000002R008085", "___s": true, "skip": true, "slug": "PIXI.GraphicsDataaddHole", "filepath": "core\\graphics\\GraphicsData.js" }, { "comment": "/**\n * Destroys the Graphics data.\n */", "meta": { "range": [ 2968, 3043 ], "filename": "GraphicsData.js", "lineno": 113, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100087037", "name": "GraphicsData#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Destroys the Graphics data.

", "name": "destroy", "longname": "PIXI.GraphicsData#destroy", "kind": "function", "memberof": "PIXI.GraphicsData", "scope": "instance", "params": [], "___id": "T000002R008086", "___s": true, "skip": true, "slug": "PIXI.GraphicsDatadestroy", "filepath": "core\\graphics\\GraphicsData.js" } ], "$attributes": [], "$staticmethods": [], "$staticproperties": [], "$augments": [], "$augmentedBy": [], "filepath": "core\\graphics\\GraphicsData.js" }