Home

namespace: mesh

  {
    "comment": "/**\n * @namespace PIXI.mesh\n */",
    "meta": {
        "range": [
            0,
            31
        ],
        "filename": "index.js",
        "lineno": 1,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh",
        "code": {}
    },
    "kind": "namespace",
    "name": "mesh",
    "memberof": "PIXI",
    "longname": "PIXI.mesh",
    "scope": "static",
    "___id": "T000002R013109",
    "___s": true,
    "filepath": "mesh\\index.js"
}

protected _refresh(): void public _calculateBounds(): void public containsPoint(point: PIXI.Point): boolean public texture(): void public tint(): void private onChildrenChange(): void public addChild(child: PIXI.DisplayObject): PIXI.DisplayObject public addChildAt(child: PIXI.DisplayObject, index: number): PIXI.DisplayObject public swapChildren(child: PIXI.DisplayObject, child2: PIXI.DisplayObject): void public getChildIndex(child: PIXI.DisplayObject): number public setChildIndex(child: PIXI.DisplayObject, index: number): void public getChildAt(index: number): PIXI.DisplayObject public removeChild(child: PIXI.DisplayObject): PIXI.DisplayObject public removeChildAt(index: number): PIXI.DisplayObject public removeChildren(beginIndex: number, endIndex: number): Array.<DisplayObject> public updateTransform(): void public calculateBounds(): void public renderWebGL(renderer: PIXI.WebGLRenderer): void private renderAdvancedWebGL(renderer: PIXI.WebGLRenderer): void public renderCanvas(renderer: PIXI.CanvasRenderer): void public destroy(options: object, boolean): void public width(): void public height(): void private _tempDisplayObjectParent(): void public _recursivePostUpdateTransform(): void public getBounds(skipUpdate: boolean, rect: PIXI.Rectangle): PIXI.Rectangle public getLocalBounds(rect: PIXI.Rectangle): PIXI.Rectangle public toGlobal(position: PIXI.Point, point: PIXI.Point, skipUpdate: boolean): PIXI.Point public toLocal(position: PIXI.Point, from: PIXI.DisplayObject, point: PIXI.Point, skipUpdate: boolean): PIXI.Point public setParent(container: PIXI.Container): PIXI.Container public setTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, pivotX: number, pivotY: number): PIXI.DisplayObject public x(): void public y(): void public worldTransform(): void public localTransform(): void public position(): void public scale(): void public pivot(): void public skew(): void public rotation(): void public worldVisible(): void public mask(): void public filters(): void

Properties

Name	Type	Attribute	Description
_texture	PIXI.Texture	private	The texture of the Mesh
uvs	Float32Array	public	The Uvs of the Mesh
vertices	Float32Array	public	An array of vertices
dirty	number	public	Version of mesh uvs are dirty or not
indexDirty	number	public	Version of mesh indices
blendMode	number	public	The blend mode to be applied to the sprite. Set to `PIXI.BLEND_MODES.NORMAL` to remove any blend mode.
canvasPadding	number	public	Triangles in canvas mode are automatically antialiased, use this value to force triangles to overlap a bit with each other.
drawMode	number	public	The way the Mesh should be drawn, can be any of the {@link PIXI.mesh.Mesh.DRAW_MODES} consts
shader	PIXI.Shader	public	The default shader that is used if a mesh doesn't have a more specific one.
tintRgb	number	public	The tint applied to the mesh. This is a [r,g,b] value. A value of [1,1,1] will remove any tint effect.
_glDatas	object.<number, object>	private	A map of renderer IDs to webgl render data
_uvTransform	PIXI.extras.TextureTransform	private	transform that is applied to UV to get the texture coords its updated independently from texture uvTransform updates of uvs are tied to that thing
uploadUvTransform	boolean	public	whether or not upload uvTransform to shader if its false, then uvs should be pre-multiplied if you change it for generated mesh, please call 'refresh(true)'
pluginName	string	public	Plugin that is responsible for rendering this element. Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.
DRAW_MODES	object	public	Different drawing buffer modes supported
_texture	PIXI.Texture	private	The texture of the Mesh
uvs	Float32Array	public	The Uvs of the Mesh
vertices	Float32Array	public	An array of vertices
dirty	number	public	Version of mesh uvs are dirty or not
indexDirty	number	public	Version of mesh indices
blendMode	number	public	The blend mode to be applied to the sprite. Set to `PIXI.BLEND_MODES.NORMAL` to remove any blend mode.
canvasPadding	number	public	Triangles in canvas mode are automatically antialiased, use this value to force triangles to overlap a bit with each other.
drawMode	number	public	The way the Mesh should be drawn, can be any of the {@link PIXI.mesh.Mesh.DRAW_MODES} consts
shader	PIXI.Shader	public	The default shader that is used if a mesh doesn't have a more specific one.
tintRgb	number	public	The tint applied to the mesh. This is a [r,g,b] value. A value of [1,1,1] will remove any tint effect.
_glDatas	object.<number, object>	private	A map of renderer IDs to webgl render data
_uvTransform	PIXI.extras.TextureTransform	private	transform that is applied to UV to get the texture coords its updated independently from texture uvTransform updates of uvs are tied to that thing
uploadUvTransform	boolean	public	whether or not upload uvTransform to shader if its false, then uvs should be pre-multiplied if you change it for generated mesh, please call 'refresh(true)'
pluginName	string	public	Plugin that is responsible for rendering this element. Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.
DRAW_MODES	object	public	Different drawing buffer modes supported
children	Array.	public	The array of children of this container.
transform	PIXI.TransformBase	public	World transform and local transform of this object. This will become read-only later, please do not assign anything there unless you know what are you doing
alpha	number	public	The opacity of the object.
visible	boolean	public	The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called. Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually
renderable	boolean	public	Can this object be rendered, if false the object will not be drawn but the updateTransform methods will still be called. Only affects recursive calls from parent. You can ask for bounds manually
parent	PIXI.Container	public	The display object container that contains this display object.
worldAlpha	number	public	The multiplied alpha of the displayObject
filterArea	PIXI.Rectangle	public	The area the filter is applied to. This is used as more of an optimisation rather than figuring out the dimensions of the displayObject each frame you can set this rectangle Also works as an interaction mask
_bounds	PIXI.Rectangle	private	The bounds object, this is used to calculate and store the bounds of the displayObject
_mask	PIXI.Graphics PIXI.Sprite	private	The original, cached mask of the object
_destroyed	boolean	private	If the object has been destroyed via destroy(). If true, it should not be used.
cacheAsBitmap	boolean	public	Set this to true if you want this display object to be cached as a bitmap. This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects. To remove simply set this property to 'false' IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

Methods

_renderWebGL(renderer: PIXI.WebGLRenderer): void

mesh\Mesh.js, line 161

Renders the object using the WebGL renderer

Params:

Name	Type	Attribute	Description
renderer			a reference to the WebGL renderer

Returns:

void

_renderCanvas(renderer: PIXI.CanvasRenderer): void

mesh\Mesh.js, line 174

Renders the object using the Canvas renderer

Params:

Name	Type	Attribute	Description
renderer			The canvas renderer.

Returns:

void

_onTextureUpdate(): void

mesh\Mesh.js, line 185

When the texture is updated, this event will fire to update the scale and frame

Returns:

void

multiplyUvs(): void

mesh\Mesh.js, line 196

multiplies uvs only if uploadUvTransform is false
call it after you change uvs manually
make sure that texture is valid

Returns:

void

refresh(forceUpdate: boolean): void

mesh\Mesh.js, line 210

Refreshes uvs for generated meshes (rope, plane)
sometimes refreshes vertices too

Params:

Name	Type	Attribute	Description
forceUpdate			if true, matrices will be updated any case

Returns:

void

_refresh(): void

mesh\Mesh.js, line 222

re-calculates mesh coords

Returns:

void

_calculateBounds(): void

mesh\Mesh.js, line 231

Returns the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account.

Returns:

void

containsPoint(point: PIXI.Point): boolean

mesh\Mesh.js, line 243

Tests if a point is inside this mesh. Works only for TRIANGLE_MESH

Params:

Name	Type	Attribute	Description
point			the point to test

Returns:

boolean

texture(): void

mesh\Mesh.js, line 285

The texture that the mesh uses.

Returns:

void

tint(): void

mesh\Mesh.js, line 319

The tint applied to the mesh. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

Returns:

void

_renderWebGL(renderer: PIXI.WebGLRenderer): void

mesh\Mesh.js, line 161

Renders the object using the WebGL renderer

Params:

Name	Type	Attribute	Description
renderer			a reference to the WebGL renderer

Returns:

void

_renderCanvas(renderer: PIXI.CanvasRenderer): void

mesh\Mesh.js, line 174

Renders the object using the Canvas renderer

Params:

Name	Type	Attribute	Description
renderer			The canvas renderer.

Returns:

void

_onTextureUpdate(): void

mesh\Mesh.js, line 185

When the texture is updated, this event will fire to update the scale and frame

Returns:

void

multiplyUvs(): void

mesh\Mesh.js, line 196

multiplies uvs only if uploadUvTransform is false
call it after you change uvs manually
make sure that texture is valid

Returns:

void

refresh(forceUpdate: boolean): void

mesh\Mesh.js, line 210

Refreshes uvs for generated meshes (rope, plane)
sometimes refreshes vertices too

Params:

Name	Type	Attribute	Description
forceUpdate			if true, matrices will be updated any case

Returns:

void

_refresh(): void

mesh\Mesh.js, line 222

re-calculates mesh coords

Returns:

void

_calculateBounds(): void

mesh\Mesh.js, line 231

Returns the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account.

Returns:

void

containsPoint(point: PIXI.Point): boolean

mesh\Mesh.js, line 243

Tests if a point is inside this mesh. Works only for TRIANGLE_MESH

Params:

Name	Type	Attribute	Description
point			the point to test

Returns:

boolean

texture(): void

mesh\Mesh.js, line 285

The texture that the mesh uses.

Returns:

void

tint(): void

mesh\Mesh.js, line 319

The tint applied to the mesh. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

Returns:

void

onChildrenChange(): void

core\display\Container.js, line 42

Overridable method that can be used by Container subclasses whenever the children array is modified

Returns:

void

addChild(child: PIXI.DisplayObject): PIXI.DisplayObject

core\display\Container.js, line 55

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

Params:

Name	Type	Attribute	Description
child			The DisplayObject(s) to add to the container

Returns:

PIXI.DisplayObject

addChildAt(child: PIXI.DisplayObject, index: number): PIXI.DisplayObject

core\display\Container.js, line 101

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Params:

Name	Type	Attribute	Description
child			The child to add
index			The index to place the child in

Returns:

PIXI.DisplayObject

swapChildren(child: PIXI.DisplayObject, child2: PIXI.DisplayObject): void

core\display\Container.js, line 135

Swaps the position of 2 Display Objects within this container.

Params:

Name	Type	Attribute	Description
child			First display object to swap
child2			Second display object to swap

Returns:

void

getChildIndex(child: PIXI.DisplayObject): number

core\display\Container.js, line 156

Returns the index position of a child DisplayObject instance

Params:

Name	Type	Attribute	Description
child			The DisplayObject instance to identify

Returns:

number

setChildIndex(child: PIXI.DisplayObject, index: number): void

core\display\Container.js, line 174

Changes the position of an existing child in the display object container

Params:

Name	Type	Attribute	Description
child			The child DisplayObject instance for which you want to change the index number
index			The resulting index number for the child display object

Returns:

void

getChildAt(index: number): PIXI.DisplayObject

core\display\Container.js, line 195

Returns the child at the specified index

Params:

Name	Type	Attribute	Description
index			The index to get the child at

Returns:

PIXI.DisplayObject

removeChild(child: PIXI.DisplayObject): PIXI.DisplayObject

core\display\Container.js, line 211

Removes one or more children from the container.

Params:

Name	Type	Attribute	Description
child			The DisplayObject(s) to remove

Returns:

PIXI.DisplayObject

removeChildAt(index: number): PIXI.DisplayObject

core\display\Container.js, line 253

Removes a child from the specified index position.

Params:

Name	Type	Attribute	Description
index			The index to get the child from

Returns:

PIXI.DisplayObject

removeChildren(beginIndex: number, endIndex: number): Array.<DisplayObject>

core\display\Container.js, line 279

Removes all children from this container that are within the begin and end indexes.

Params:

Name	Type	Attribute	Description
beginIndex			The beginning position.
endIndex			The ending position. Default value is size of the container.

Returns:

Array.<DisplayObject>

updateTransform(): void

core\display\Container.js, line 321

Updates the transform on all children of this container for rendering

Returns:

void

calculateBounds(): void

core\display\Container.js, line 345

Recalculates the bounds of the container.

Returns:

void

renderWebGL(renderer: PIXI.WebGLRenderer): void

core\display\Container.js, line 396

Renders the object using the WebGL renderer

Params:

Name	Type	Attribute	Description
renderer			The renderer

Returns:

void

renderAdvancedWebGL(renderer: PIXI.WebGLRenderer): void

core\display\Container.js, line 427

Render the object using the WebGL renderer and advanced features.

Params:

Name	Type	Attribute	Description
renderer			The renderer

Returns:

void

renderCanvas(renderer: PIXI.CanvasRenderer): void

core\display\Container.js, line 512

Renders the object using the Canvas renderer

Params:

Name	Type	Attribute	Description
renderer			The renderer

Returns:

void

destroy(options: object, boolean): void

core\display\Container.js, line 550

Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling destroy.

Params:

Name	Type	Attribute	Description
options			Options parameter. A boolean will act as if all options have been set to that value
options.children			if set to true, all the children will have their destroy method called as well. 'options' will be passed on to those calls.
options.texture			Only used for child Sprites if options.children is set to true Should it destroy the texture of the child sprite
options.baseTexture			Only used for child Sprites if options.children is set to true Should it destroy the base texture of the child sprite

Returns:

void

width(): void

core\display\Container.js, line 572

The width of the Container, setting this will actually modify the scale to achieve the value set

Returns:

void

height(): void

core\display\Container.js, line 598

The height of the Container, setting this will actually modify the scale to achieve the value set

Returns:

void

_tempDisplayObjectParent(): void

core\display\DisplayObject.js, line 133

Returns:

void

_recursivePostUpdateTransform(): void

core\display\DisplayObject.js, line 161

recursively updates transform of all objects from the root to this one
internal function for toLocal()

Returns:

void

getBounds(skipUpdate: boolean, rect: PIXI.Rectangle): PIXI.Rectangle

core\display\DisplayObject.js, line 183

Retrieves the bounds of the displayObject as a rectangle object.

Params:

Name	Type	Attribute	Description
skipUpdate			setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost
rect			Optional rectangle to store the result of the bounds calculation

Returns:

PIXI.Rectangle

getLocalBounds(rect: PIXI.Rectangle): PIXI.Rectangle

core\display\DisplayObject.js, line 224

Retrieves the local bounds of the displayObject as a rectangle object

Params:

Name	Type	Attribute	Description
rect			Optional rectangle to store the result of the bounds calculation

Returns:

PIXI.Rectangle

toGlobal(position: PIXI.Point, point: PIXI.Point, skipUpdate: boolean): PIXI.Point

core\display\DisplayObject.js, line 259

Calculates the global position of the display object

Params:

Name	Type	Attribute	Description
position			The world origin to calculate from
point			A Point object in which to store the value, optional (otherwise will create a new Point)
skipUpdate			Should we skip the update transform.

Returns:

PIXI.Point

toLocal(position: PIXI.Point, from: PIXI.DisplayObject, point: PIXI.Point, skipUpdate: boolean): PIXI.Point

core\display\DisplayObject.js, line 294

Calculates the local position of the display object relative to another point

Params:

Name	Type	Attribute	Description
position			The world origin to calculate from
from			The DisplayObject to calculate the global position from
point			A Point object in which to store the value, optional (otherwise will create a new Point)
skipUpdate			Should we skip the update transform

Returns:

PIXI.Point

setParent(container: PIXI.Container): PIXI.Container

core\display\DisplayObject.js, line 350

Set the parent Container of this DisplayObject

Params:

Name	Type	Attribute	Description
container			The Container to add this DisplayObject to

Returns:

PIXI.Container

setTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, pivotX: number, pivotY: number): PIXI.DisplayObject

core\display\DisplayObject.js, line 376

Convenience function to set the position, scale, skew and pivot at once.

Params:

Name	Type	Attribute	Description
x			The X position
y			The Y position
scaleX			The X scale value
scaleY			The Y scale value
rotation			The rotation
skewX			The X skew value
skewY			The Y skew value
pivotX			The X pivot value
pivotY			The Y pivot value

Returns:

PIXI.DisplayObject

x(): void

core\display\DisplayObject.js, line 427

The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x

Returns:

void

y(): void

core\display\DisplayObject.js, line 443

The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y

Returns:

void

worldTransform(): void

core\display\DisplayObject.js, line 459

Current transform of the object based on world (parent) factors

Returns:

void

localTransform(): void

core\display\DisplayObject.js, line 470

Current transform of the object based on local factors: position, scale, other stuff

Returns:

void

position(): void

core\display\DisplayObject.js, line 481

The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4.

Returns:

void

scale(): void

core\display\DisplayObject.js, line 497

The scale factor of the object.
Assignment by value since pixi-v4.

Returns:

void

pivot(): void

core\display\DisplayObject.js, line 513

The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4.

Returns:

void

skew(): void

core\display\DisplayObject.js, line 529

The skew factor for the object in radians.
Assignment by value since pixi-v4.

Returns:

void

rotation(): void

core\display\DisplayObject.js, line 544

The rotation of the object in radians.

Returns:

void

worldVisible(): void

core\display\DisplayObject.js, line 560

Indicates if the object is globally visible.

Returns:

void

mask(): void

core\display\DisplayObject.js, line 587

Sets a mask for the displayObject. A mask is an object that limits the visibility of an
object to the shape of the mask applied to it. In PIXI a regular mask must be a
PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it
utilises shape clipping. To remove a mask, set this property to null.

Returns:

void

filters(): void

core\display\DisplayObject.js, line 614

Sets the filters for the displayObject.

IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
To remove filters simply set this property to 'null'

Returns:

void

{ "comment": "/**\n * Base mesh class\n * @class\n * @extends PIXI.Container\n * @memberof PIXI.mesh\n */", "meta": { "range": [ 294, 8913 ], "filename": "Mesh.js", "lineno": 15, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067132", "name": "Mesh", "type": "ClassDeclaration", "paramnames": [ "texture", "vertices", "uvs", "indices", "drawMode" ] } }, "classdesc": "

Base mesh class

", "kind": "class", "augments": [ "PIXI.Container" ], "memberof": "PIXI.mesh", "name": "Mesh", "longname": "PIXI.mesh.Mesh", "scope": "static", "params": [ { "type": { "names": [ "PIXI.Texture" ] }, "description": "

The texture to use

", "name": "texture" }, { "type": { "names": [ "Float32Array" ] }, "optional": true, "description": "

if you want to specify the vertices

", "name": "vertices" }, { "type": { "names": [ "Float32Array" ] }, "optional": true, "description": "

if you want to specify the uvs

", "name": "uvs" }, { "type": { "names": [ "Uint16Array" ] }, "optional": true, "description": "

if you want to specify the indices

", "name": "indices" }, { "type": { "names": [ "number" ] }, "optional": true, "description": "

the drawMode, can be any of the Mesh.DRAW_MODES consts

", "name": "drawMode" } ], "___id": "T000002R006185", "___s": true, "$methods": [ { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - a reference to the WebGL renderer\n */", "meta": { "range": [ 4825, 5010 ], "filename": "Mesh.js", "lineno": 161, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067289", "name": "Mesh#_renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the WebGL renderer

", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "

a reference to the WebGL renderer

", "name": "renderer" } ], "name": "_renderWebGL", "longname": "PIXI.mesh.Mesh#_renderWebGL", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "overrides": "PIXI.Container#_renderWebGL", "___id": "T000002R006216", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_renderWebGL", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The canvas renderer.\n */", "meta": { "range": [ 5175, 5290 ], "filename": "Mesh.js", "lineno": 174, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067323", "name": "Mesh#_renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the Canvas renderer

", "access": "private", "params": [ { "type": { "names": [ "PIXI.CanvasRenderer" ] }, "description": "

The canvas renderer.

", "name": "renderer" } ], "name": "_renderCanvas", "longname": "PIXI.mesh.Mesh#_renderCanvas", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "overrides": "PIXI.Container#_renderCanvas", "___id": "T000002R006217", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_renderCanvas", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * When the texture is updated, this event will fire to update the scale and frame\n *\n * @private\n */", "meta": { "range": [ 5422, 5527 ], "filename": "Mesh.js", "lineno": 185, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067345", "name": "Mesh#_onTextureUpdate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

When the texture is updated, this event will fire to update the scale and frame

", "access": "private", "name": "_onTextureUpdate", "longname": "PIXI.mesh.Mesh#_onTextureUpdate", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "___id": "T000002R006218", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_onTextureUpdate", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * multiplies uvs only if uploadUvTransform is false\n * call it after you change uvs manually\n * make sure that texture is valid\n */", "meta": { "range": [ 5690, 5825 ], "filename": "Mesh.js", "lineno": 196, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067364", "name": "Mesh#multiplyUvs", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

multiplies uvs only if uploadUvTransform is false
call it after you change uvs manually
make sure that texture is valid

", "name": "multiplyUvs", "longname": "PIXI.mesh.Mesh#multiplyUvs", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "___id": "T000002R006220", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshmultiplyUvs", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Refreshes uvs for generated meshes (rope, plane)\n * sometimes refreshes vertices too\n *\n * @param {boolean} [forceUpdate=false] if true, matrices will be updated any case\n */", "meta": { "range": [ 6037, 6169 ], "filename": "Mesh.js", "lineno": 210, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067384", "name": "Mesh#refresh", "type": "MethodDefinition", "paramnames": [ "forceUpdate" ] }, "vars": { "": null } }, "description": "

Refreshes uvs for generated meshes (rope, plane)
sometimes refreshes vertices too

", "params": [ { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

if true, matrices will be updated any case

", "name": "forceUpdate" } ], "name": "refresh", "longname": "PIXI.mesh.Mesh#refresh", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "___id": "T000002R006221", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshrefresh", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * re-calculates mesh coords\n * @protected\n */", "meta": { "range": [ 6242, 6284 ], "filename": "Mesh.js", "lineno": 222, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067403", "name": "Mesh#_refresh", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

re-calculates mesh coords

", "access": "protected", "name": "_refresh", "longname": "PIXI.mesh.Mesh#_refresh", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "___id": "T000002R006222", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_refresh", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Returns the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account.\n *\n */", "meta": { "range": [ 6429, 6640 ], "filename": "Mesh.js", "lineno": 231, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067407", "name": "Mesh#_calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Returns the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account.

", "name": "_calculateBounds", "longname": "PIXI.mesh.Mesh#_calculateBounds", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "overrides": "PIXI.Container#_calculateBounds", "___id": "T000002R006223", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_calculateBounds", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Tests if a point is inside this mesh. Works only for TRIANGLE_MESH\n *\n * @param {PIXI.Point} point - the point to test\n * @return {boolean} the result of the test\n */", "meta": { "range": [ 6844, 7876 ], "filename": "Mesh.js", "lineno": 243, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067430", "name": "Mesh#containsPoint", "type": "MethodDefinition", "paramnames": [ "point" ] }, "vars": { "": null } }, "description": "

Tests if a point is inside this mesh. Works only for TRIANGLE_MESH

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

the point to test

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

the result of the test

" } ], "name": "containsPoint", "longname": "PIXI.mesh.Mesh#containsPoint", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "___id": "T000002R006224", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshcontainsPoint", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The texture that the mesh uses.\n *\n * @member {PIXI.Texture}\n */", "meta": { "range": [ 7974, 8029 ], "filename": "Mesh.js", "lineno": 285, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067615", "name": "Mesh#texture", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The texture that the mesh uses.

", "kind": "member", "type": { "names": [ "PIXI.Texture" ] }, "name": "texture", "longname": "PIXI.mesh.Mesh#texture", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "___id": "T000002R006241", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshtexture", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The tint applied to the mesh. This is a hex value. A value of 0xFFFFFF will remove any tint effect.\n *\n * @member {number}\n * @default 0xFFFFFF\n */", "meta": { "range": [ 8706, 8777 ], "filename": "Mesh.js", "lineno": 319, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067668", "name": "Mesh#tint", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The tint applied to the mesh. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

", "kind": "member", "type": { "names": [ "number" ] }, "defaultvalue": "0xFFFFFF", "name": "tint", "longname": "PIXI.mesh.Mesh#tint", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "___id": "T000002R006244", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshtint", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - a reference to the WebGL renderer\n */", "meta": { "range": [ 4825, 5010 ], "filename": "Mesh.js", "lineno": 161, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100141968", "name": "Mesh#_renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the WebGL renderer

", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "

a reference to the WebGL renderer

", "name": "renderer" } ], "name": "_renderWebGL", "longname": "PIXI.mesh.Mesh#_renderWebGL", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "overrides": "PIXI.Container#_renderWebGL", "___id": "T000002R013150", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_renderWebGL", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The canvas renderer.\n */", "meta": { "range": [ 5175, 5290 ], "filename": "Mesh.js", "lineno": 174, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100142002", "name": "Mesh#_renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the Canvas renderer

", "access": "private", "params": [ { "type": { "names": [ "PIXI.CanvasRenderer" ] }, "description": "

The canvas renderer.

", "name": "renderer" } ], "name": "_renderCanvas", "longname": "PIXI.mesh.Mesh#_renderCanvas", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "overrides": "PIXI.Container#_renderCanvas", "___id": "T000002R013151", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_renderCanvas", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * When the texture is updated, this event will fire to update the scale and frame\n *\n * @private\n */", "meta": { "range": [ 5422, 5527 ], "filename": "Mesh.js", "lineno": 185, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100142024", "name": "Mesh#_onTextureUpdate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

When the texture is updated, this event will fire to update the scale and frame

", "access": "private", "name": "_onTextureUpdate", "longname": "PIXI.mesh.Mesh#_onTextureUpdate", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "___id": "T000002R013152", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_onTextureUpdate", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * multiplies uvs only if uploadUvTransform is false\n * call it after you change uvs manually\n * make sure that texture is valid\n */", "meta": { "range": [ 5690, 5825 ], "filename": "Mesh.js", "lineno": 196, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100142043", "name": "Mesh#multiplyUvs", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

multiplies uvs only if uploadUvTransform is false
call it after you change uvs manually
make sure that texture is valid

", "name": "multiplyUvs", "longname": "PIXI.mesh.Mesh#multiplyUvs", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "___id": "T000002R013154", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshmultiplyUvs", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Refreshes uvs for generated meshes (rope, plane)\n * sometimes refreshes vertices too\n *\n * @param {boolean} [forceUpdate=false] if true, matrices will be updated any case\n */", "meta": { "range": [ 6037, 6169 ], "filename": "Mesh.js", "lineno": 210, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100142063", "name": "Mesh#refresh", "type": "MethodDefinition", "paramnames": [ "forceUpdate" ] }, "vars": { "": null } }, "description": "

Refreshes uvs for generated meshes (rope, plane)
sometimes refreshes vertices too

", "params": [ { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

if true, matrices will be updated any case

", "name": "forceUpdate" } ], "name": "refresh", "longname": "PIXI.mesh.Mesh#refresh", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "___id": "T000002R013155", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshrefresh", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * re-calculates mesh coords\n * @protected\n */", "meta": { "range": [ 6242, 6284 ], "filename": "Mesh.js", "lineno": 222, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100142082", "name": "Mesh#_refresh", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

re-calculates mesh coords

", "access": "protected", "name": "_refresh", "longname": "PIXI.mesh.Mesh#_refresh", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "___id": "T000002R013156", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_refresh", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Returns the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account.\n *\n */", "meta": { "range": [ 6429, 6640 ], "filename": "Mesh.js", "lineno": 231, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100142086", "name": "Mesh#_calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Returns the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account.

", "name": "_calculateBounds", "longname": "PIXI.mesh.Mesh#_calculateBounds", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "overrides": "PIXI.Container#_calculateBounds", "___id": "T000002R013157", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_calculateBounds", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Tests if a point is inside this mesh. Works only for TRIANGLE_MESH\n *\n * @param {PIXI.Point} point - the point to test\n * @return {boolean} the result of the test\n */", "meta": { "range": [ 6844, 7876 ], "filename": "Mesh.js", "lineno": 243, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100142109", "name": "Mesh#containsPoint", "type": "MethodDefinition", "paramnames": [ "point" ] }, "vars": { "": null } }, "description": "

Tests if a point is inside this mesh. Works only for TRIANGLE_MESH

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

the point to test

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

the result of the test

" } ], "name": "containsPoint", "longname": "PIXI.mesh.Mesh#containsPoint", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "___id": "T000002R013158", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshcontainsPoint", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The texture that the mesh uses.\n *\n * @member {PIXI.Texture}\n */", "meta": { "range": [ 7974, 8029 ], "filename": "Mesh.js", "lineno": 285, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100142294", "name": "Mesh#texture", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The texture that the mesh uses.

", "kind": "member", "type": { "names": [ "PIXI.Texture" ] }, "name": "texture", "longname": "PIXI.mesh.Mesh#texture", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "___id": "T000002R013175", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshtexture", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The tint applied to the mesh. This is a hex value. A value of 0xFFFFFF will remove any tint effect.\n *\n * @member {number}\n * @default 0xFFFFFF\n */", "meta": { "range": [ 8706, 8777 ], "filename": "Mesh.js", "lineno": 319, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100142347", "name": "Mesh#tint", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The tint applied to the mesh. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

", "kind": "member", "type": { "names": [ "number" ] }, "defaultvalue": "0xFFFFFF", "name": "tint", "longname": "PIXI.mesh.Mesh#tint", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "___id": "T000002R013178", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshtint", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Overridable method that can be used by Container subclasses whenever the children array is modified\n *\n * @private\n */", "meta": { "range": [ 886, 936 ], "filename": "Container.js", "lineno": 42, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003526", "name": "Container#onChildrenChange", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Overridable method that can be used by Container subclasses whenever the children array is modified

", "access": "private", "name": "onChildrenChange", "longname": "PIXI.mesh.Mesh#onChildrenChange", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.Container#onChildrenChange", "inherited": true, "overrides": "PIXI.Container#onChildrenChange", "___id": "T000002R014466", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshonChildrenChange", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Adds one or more children to the container.\n *\n * Multiple items can be added like so: `myContainer.addChild(thingOne, thingTwo, thingThree)`\n *\n * @param {...PIXI.DisplayObject} child - The DisplayObject(s) to add to the container\n * @return {PIXI.DisplayObject} The first child that was added.\n */", "meta": { "range": [ 1281, 2509 ], "filename": "Container.js", "lineno": 55, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003530", "name": "Container#addChild", "type": "MethodDefinition", "paramnames": [ "child" ] }, "vars": { "": null } }, "description": "

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

", "params": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "variable": true, "description": "

The DisplayObject(s) to add to the container

", "name": "child" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The first child that was added.

" } ], "name": "addChild", "longname": "PIXI.mesh.Mesh#addChild", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#addChild", "inherited": true, "overrides": "PIXI.Container#addChild", "___id": "T000002R014467", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshaddChild", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown\n *\n * @param {PIXI.DisplayObject} child - The child to add\n * @param {number} index - The index to place the child in\n * @return {PIXI.DisplayObject} The child that was added.\n */", "meta": { "range": [ 2836, 3576 ], "filename": "Container.js", "lineno": 101, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003628", "name": "Container#addChildAt", "type": "MethodDefinition", "paramnames": [ "child", "index" ] }, "vars": { "": null } }, "description": "

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

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

The child to add

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

The index to place the child in

", "name": "index" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The child that was added.

" } ], "name": "addChildAt", "longname": "PIXI.mesh.Mesh#addChildAt", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#addChildAt", "inherited": true, "overrides": "PIXI.Container#addChildAt", "___id": "T000002R014468", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshaddChildAt", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Swaps the position of 2 Display Objects within this container.\n *\n * @param {PIXI.DisplayObject} child - First display object to swap\n * @param {PIXI.DisplayObject} child2 - Second display object to swap\n */", "meta": { "range": [ 3821, 4178 ], "filename": "Container.js", "lineno": 135, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003720", "name": "Container#swapChildren", "type": "MethodDefinition", "paramnames": [ "child", "child2" ] }, "vars": { "": null } }, "description": "

Swaps the position of 2 Display Objects within this container.

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

First display object to swap

", "name": "child" }, { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

Second display object to swap

", "name": "child2" } ], "name": "swapChildren", "longname": "PIXI.mesh.Mesh#swapChildren", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#swapChildren", "inherited": true, "overrides": "PIXI.Container#swapChildren", "___id": "T000002R014469", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshswapChildren", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Returns the index position of a child DisplayObject instance\n *\n * @param {PIXI.DisplayObject} child - The DisplayObject instance to identify\n * @return {number} The index position of the child display object to identify\n */", "meta": { "range": [ 4440, 4683 ], "filename": "Container.js", "lineno": 156, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003775", "name": "Container#getChildIndex", "type": "MethodDefinition", "paramnames": [ "child" ] }, "vars": { "": null } }, "description": "

Returns the index position of a child DisplayObject instance

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

The DisplayObject instance to identify

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

The index position of the child display object to identify

" } ], "name": "getChildIndex", "longname": "PIXI.mesh.Mesh#getChildIndex", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#getChildIndex", "inherited": true, "overrides": "PIXI.Container#getChildIndex", "___id": "T000002R014470", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshgetChildIndex", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Changes the position of an existing child in the display object container\n *\n * @param {PIXI.DisplayObject} child - The child DisplayObject instance for which you want to change the index number\n * @param {number} index - The resulting index number for the child display object\n */", "meta": { "range": [ 5002, 5433 ], "filename": "Container.js", "lineno": 174, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003802", "name": "Container#setChildIndex", "type": "MethodDefinition", "paramnames": [ "child", "index" ] }, "vars": { "": null } }, "description": "

Changes the position of an existing child in the display object container

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

The child DisplayObject instance for which you want to change the index number

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

The resulting index number for the child display object

", "name": "index" } ], "name": "setChildIndex", "longname": "PIXI.mesh.Mesh#setChildIndex", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#setChildIndex", "inherited": true, "overrides": "PIXI.Container#setChildIndex", "___id": "T000002R014471", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshsetChildIndex", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Returns the child at the specified index\n *\n * @param {number} index - The index to get the child at\n * @return {PIXI.DisplayObject} The child at the given index, if any.\n */", "meta": { "range": [ 5645, 5865 ], "filename": "Container.js", "lineno": 195, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003857", "name": "Container#getChildAt", "type": "MethodDefinition", "paramnames": [ "index" ] }, "vars": { "": null } }, "description": "

Returns the child at the specified index

", "params": [ { "type": { "names": [ "number" ] }, "description": "

The index to get the child at

", "name": "index" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The child at the given index, if any.

" } ], "name": "getChildAt", "longname": "PIXI.mesh.Mesh#getChildAt", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#getChildAt", "inherited": true, "overrides": "PIXI.Container#getChildAt", "___id": "T000002R014472", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshgetChildAt", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Removes one or more children from the container.\n *\n * @param {...PIXI.DisplayObject} child - The DisplayObject(s) to remove\n * @return {PIXI.DisplayObject} The first child that was removed.\n */", "meta": { "range": [ 6097, 7212 ], "filename": "Container.js", "lineno": 211, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003888", "name": "Container#removeChild", "type": "MethodDefinition", "paramnames": [ "child" ] }, "vars": { "": null } }, "description": "

Removes one or more children from the container.

", "params": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "variable": true, "description": "

The DisplayObject(s) to remove

", "name": "child" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The first child that was removed.

" } ], "name": "removeChild", "longname": "PIXI.mesh.Mesh#removeChild", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#removeChild", "inherited": true, "overrides": "PIXI.Container#removeChild", "___id": "T000002R014473", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshremoveChild", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Removes a child from the specified index position.\n *\n * @param {number} index - The index to get the child from\n * @return {PIXI.DisplayObject} The child that was removed.\n */", "meta": { "range": [ 7426, 7922 ], "filename": "Container.js", "lineno": 253, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003984", "name": "Container#removeChildAt", "type": "MethodDefinition", "paramnames": [ "index" ] }, "vars": { "": null } }, "description": "

Removes a child from the specified index position.

", "params": [ { "type": { "names": [ "number" ] }, "description": "

The index to get the child from

", "name": "index" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The child that was removed.

" } ], "name": "removeChildAt", "longname": "PIXI.mesh.Mesh#removeChildAt", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#removeChildAt", "inherited": true, "overrides": "PIXI.Container#removeChildAt", "___id": "T000002R014474", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshremoveChildAt", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Removes all children from this container that are within the begin and end indexes.\n *\n * @param {number} [beginIndex=0] - The beginning position.\n * @param {number} [endIndex=this.children.length] - The ending position. Default value is size of the container.\n * @returns {DisplayObject[]} List of removed children\n */", "meta": { "range": [ 8283, 9328 ], "filename": "Container.js", "lineno": 279, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004040", "name": "Container#removeChildren", "type": "MethodDefinition", "paramnames": [ "beginIndex", "endIndex" ] }, "vars": { "": null } }, "description": "

Removes all children from this container that are within the begin and end indexes.

", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

The beginning position.

", "name": "beginIndex" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "this.children.length", "description": "

The ending position. Default value is size of the container.

", "name": "endIndex" } ], "returns": [ { "type": { "names": [ "Array." ] }, "description": "

List of removed children

" } ], "name": "removeChildren", "longname": "PIXI.mesh.Mesh#removeChildren", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#removeChildren", "inherited": true, "overrides": "PIXI.Container#removeChildren", "___id": "T000002R014475", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshremoveChildren", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Updates the transform on all children of this container for rendering\n */", "meta": { "range": [ 9427, 9901 ], "filename": "Container.js", "lineno": 321, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004188", "name": "Container#updateTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Updates the transform on all children of this container for rendering

", "name": "updateTransform", "longname": "PIXI.mesh.Mesh#updateTransform", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.Container#updateTransform", "inherited": true, "overrides": "PIXI.Container#updateTransform", "___id": "T000002R014476", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshupdateTransform", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Recalculates the bounds of the container.\n *\n */", "meta": { "range": [ 9979, 10873 ], "filename": "Container.js", "lineno": 345, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004259", "name": "Container#calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Recalculates the bounds of the container.

", "name": "calculateBounds", "longname": "PIXI.mesh.Mesh#calculateBounds", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.Container#calculateBounds", "inherited": true, "overrides": "PIXI.Container#calculateBounds", "___id": "T000002R014477", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshcalculateBounds", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 11232, 11919 ], "filename": "Container.js", "lineno": 396, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004383", "name": "Container#renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the WebGL renderer

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

The renderer

", "name": "renderer" } ], "name": "renderWebGL", "longname": "PIXI.mesh.Mesh#renderWebGL", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#renderWebGL", "inherited": true, "overrides": "PIXI.Container#renderWebGL", "___id": "T000002R014478", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshrenderWebGL", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Render the object using the WebGL renderer and advanced features.\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 12096, 13593 ], "filename": "Container.js", "lineno": 427, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004456", "name": "Container#renderAdvancedWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Render the object using the WebGL renderer and advanced features.

", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "

The renderer

", "name": "renderer" } ], "name": "renderAdvancedWebGL", "longname": "PIXI.mesh.Mesh#renderAdvancedWebGL", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#renderAdvancedWebGL", "inherited": true, "overrides": "PIXI.Container#renderAdvancedWebGL", "___id": "T000002R014479", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshrenderAdvancedWebGL", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 14285, 14873 ], "filename": "Container.js", "lineno": 512, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004646", "name": "Container#renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the Canvas renderer

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

The renderer

", "name": "renderer" } ], "name": "renderCanvas", "longname": "PIXI.mesh.Mesh#renderCanvas", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#renderCanvas", "inherited": true, "overrides": "PIXI.Container#renderCanvas", "___id": "T000002R014480", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshrenderCanvas", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Removes all internal references and listeners as well as removes children from the display list.\n * Do not use a Container after calling `destroy`.\n *\n * @param {object|boolean} [options] - Options parameter. A boolean will act as if all options\n * have been set to that value\n * @param {boolean} [options.children=false] - if set to true, all the children will have their destroy\n * method called as well. 'options' will be passed on to those calls.\n * @param {boolean} [options.texture=false] - Only used for child Sprites if options.children is set to true\n * Should it destroy the texture of the child sprite\n * @param {boolean} [options.baseTexture=false] - Only used for child Sprites if options.children is set to true\n * Should it destroy the base texture of the child sprite\n */", "meta": { "range": [ 15730, 16145 ], "filename": "Container.js", "lineno": 550, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004731", "name": "Container#destroy", "type": "MethodDefinition", "paramnames": [ "options" ] }, "vars": { "": null } }, "description": "

Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling destroy.

", "params": [ { "type": { "names": [ "object", "boolean" ] }, "optional": true, "description": "

Options parameter. A boolean will act as if all options
have been set to that value

", "name": "options" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

if set to true, all the children will have their destroy
method called as well. 'options' will be passed on to those calls.

", "name": "options.children" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

Only used for child Sprites if options.children is set to true
Should it destroy the texture of the child sprite

", "name": "options.texture" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

Only used for child Sprites if options.children is set to true
Should it destroy the base texture of the child sprite

", "name": "options.baseTexture" } ], "name": "destroy", "longname": "PIXI.mesh.Mesh#destroy", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.Container#destroy", "inherited": true, "overrides": "PIXI.Container#destroy", "___id": "T000002R014481", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshdestroy", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * The width of the Container, setting this will actually modify the scale to achieve the value set\n *\n * @member {number}\n */", "meta": { "range": [ 16302, 16384 ], "filename": "Container.js", "lineno": 572, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004792", "name": "Container#width", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The width of the Container, setting this will actually modify the scale to achieve the value set

", "kind": "member", "type": { "names": [ "number" ] }, "name": "width", "longname": "PIXI.mesh.Mesh#width", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.Container#width", "inherited": true, "overrides": "PIXI.Container#width", "___id": "T000002R014482", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshwidth", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * The height of the Container, setting this will actually modify the scale to achieve the value set\n *\n * @member {number}\n */", "meta": { "range": [ 16845, 16929 ], "filename": "Container.js", "lineno": 598, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004853", "name": "Container#height", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The height of the Container, setting this will actually modify the scale to achieve the value set

", "kind": "member", "type": { "names": [ "number" ] }, "name": "height", "longname": "PIXI.mesh.Mesh#height", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.Container#height", "inherited": true, "overrides": "PIXI.Container#height", "___id": "T000002R014483", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshheight", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * @private\n * @member {PIXI.DisplayObject}\n */", "meta": { "range": [ 3985, 4208 ], "filename": "DisplayObject.js", "lineno": 133, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005086", "name": "DisplayObject#_tempDisplayObjectParent", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "access": "private", "kind": "member", "type": { "names": [ "PIXI.DisplayObject" ] }, "name": "_tempDisplayObjectParent", "longname": "PIXI.mesh.Mesh#_tempDisplayObjectParent", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#_tempDisplayObjectParent", "inherited": true, "overrides": "PIXI.Container#_tempDisplayObjectParent", "___id": "T000002R014494", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_tempDisplayObjectParent", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * recursively updates transform of all objects from the root to this one\n * internal function for toLocal()\n */", "meta": { "range": [ 4681, 5011 ], "filename": "DisplayObject.js", "lineno": 161, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005145", "name": "DisplayObject#_recursivePostUpdateTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

recursively updates transform of all objects from the root to this one
internal function for toLocal()

", "name": "_recursivePostUpdateTransform", "longname": "PIXI.mesh.Mesh#_recursivePostUpdateTransform", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#_recursivePostUpdateTransform", "inherited": true, "overrides": "PIXI.Container#_recursivePostUpdateTransform", "___id": "T000002R014495", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_recursivePostUpdateTransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Retrieves the bounds of the displayObject as a rectangle object.\n *\n * @param {boolean} skipUpdate - setting to true will stop the transforms of the scene graph from\n * being updated. This means the calculation returned MAY be out of date BUT will give you a\n * nice performance boost\n * @param {PIXI.Rectangle} rect - Optional rectangle to store the result of the bounds calculation\n * @return {PIXI.Rectangle} the rectangular bounding area\n */", "meta": { "range": [ 5508, 6276 ], "filename": "DisplayObject.js", "lineno": 183, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005186", "name": "DisplayObject#getBounds", "type": "MethodDefinition", "paramnames": [ "skipUpdate", "rect" ] }, "vars": { "": null } }, "description": "

Retrieves the bounds of the displayObject as a rectangle object.

", "params": [ { "type": { "names": [ "boolean" ] }, "description": "

setting to true will stop the transforms of the scene graph from
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boost

", "name": "skipUpdate" }, { "type": { "names": [ "PIXI.Rectangle" ] }, "description": "

Optional rectangle to store the result of the bounds calculation

", "name": "rect" } ], "returns": [ { "type": { "names": [ "PIXI.Rectangle" ] }, "description": "

the rectangular bounding area

" } ], "name": "getBounds", "longname": "PIXI.mesh.Mesh#getBounds", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.DisplayObject#getBounds", "inherited": true, "overrides": "PIXI.Container#getBounds", "___id": "T000002R014496", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshgetBounds", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Retrieves the local bounds of the displayObject as a rectangle object\n *\n * @param {PIXI.Rectangle} [rect] - Optional rectangle to store the result of the bounds calculation\n * @return {PIXI.Rectangle} the rectangular bounding area\n */", "meta": { "range": [ 6549, 7118 ], "filename": "DisplayObject.js", "lineno": 224, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005277", "name": "DisplayObject#getLocalBounds", "type": "MethodDefinition", "paramnames": [ "rect" ] }, "vars": { "": null } }, "description": "

Retrieves the local bounds of the displayObject as a rectangle object

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

Optional rectangle to store the result of the bounds calculation

", "name": "rect" } ], "returns": [ { "type": { "names": [ "PIXI.Rectangle" ] }, "description": "

the rectangular bounding area

" } ], "name": "getLocalBounds", "longname": "PIXI.mesh.Mesh#getLocalBounds", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.DisplayObject#getLocalBounds", "inherited": true, "overrides": "PIXI.Container#getLocalBounds", "___id": "T000002R014497", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshgetLocalBounds", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Calculates the global position of the display object\n *\n * @param {PIXI.Point} position - The world origin to calculate from\n * @param {PIXI.Point} [point] - A Point object in which to store the value, optional\n * (otherwise will create a new Point)\n * @param {boolean} [skipUpdate=false] - Should we skip the update transform.\n * @return {PIXI.Point} A point object representing the position of this object\n */", "meta": { "range": [ 7580, 8444 ], "filename": "DisplayObject.js", "lineno": 259, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005356", "name": "DisplayObject#toGlobal", "type": "MethodDefinition", "paramnames": [ "position", "point", "skipUpdate" ] }, "vars": { "": null } }, "description": "

Calculates the global position of the display object

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

The world origin to calculate from

", "name": "position" }, { "type": { "names": [ "PIXI.Point" ] }, "optional": true, "description": "

A Point object in which to store the value, optional
(otherwise will create a new Point)

", "name": "point" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

Should we skip the update transform.

", "name": "skipUpdate" } ], "returns": [ { "type": { "names": [ "PIXI.Point" ] }, "description": "

A point object representing the position of this object

" } ], "name": "toGlobal", "longname": "PIXI.mesh.Mesh#toGlobal", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.DisplayObject#toGlobal", "inherited": true, "overrides": "PIXI.Container#toGlobal", "___id": "T000002R014498", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshtoGlobal", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Calculates the local position of the display object relative to another point\n *\n * @param {PIXI.Point} position - The world origin to calculate from\n * @param {PIXI.DisplayObject} [from] - The DisplayObject to calculate the global position from\n * @param {PIXI.Point} [point] - A Point object in which to store the value, optional\n * (otherwise will create a new Point)\n * @param {boolean} [skipUpdate=false] - Should we skip the update transform\n * @return {PIXI.Point} A point object representing the position of this object\n */", "meta": { "range": [ 9030, 10001 ], "filename": "DisplayObject.js", "lineno": 294, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005414", "name": "DisplayObject#toLocal", "type": "MethodDefinition", "paramnames": [ "position", "from", "point", "skipUpdate" ] }, "vars": { "": null } }, "description": "

Calculates the local position of the display object relative to another point

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

The world origin to calculate from

", "name": "position" }, { "type": { "names": [ "PIXI.DisplayObject" ] }, "optional": true, "description": "

The DisplayObject to calculate the global position from

", "name": "from" }, { "type": { "names": [ "PIXI.Point" ] }, "optional": true, "description": "

A Point object in which to store the value, optional
(otherwise will create a new Point)

", "name": "point" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "

Should we skip the update transform

", "name": "skipUpdate" } ], "returns": [ { "type": { "names": [ "PIXI.Point" ] }, "description": "

A point object representing the position of this object

" } ], "name": "toLocal", "longname": "PIXI.mesh.Mesh#toLocal", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.DisplayObject#toLocal", "inherited": true, "overrides": "PIXI.Container#toLocal", "___id": "T000002R014499", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshtoLocal", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Set the parent Container of this DisplayObject\n *\n * @param {PIXI.Container} container - The Container to add this DisplayObject to\n * @return {PIXI.Container} The Container that this DisplayObject was added to\n */", "meta": { "range": [ 10720, 10953 ], "filename": "DisplayObject.js", "lineno": 350, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005494", "name": "DisplayObject#setParent", "type": "MethodDefinition", "paramnames": [ "container" ] }, "vars": { "": null } }, "description": "

Set the parent Container of this DisplayObject

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

The Container to add this DisplayObject to

", "name": "container" } ], "returns": [ { "type": { "names": [ "PIXI.Container" ] }, "description": "

The Container that this DisplayObject was added to

" } ], "name": "setParent", "longname": "PIXI.mesh.Mesh#setParent", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.DisplayObject#setParent", "inherited": true, "overrides": "PIXI.Container#setParent", "___id": "T000002R014500", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshsetParent", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Convenience function to set the position, scale, skew and pivot at once.\n *\n * @param {number} [x=0] - The X position\n * @param {number} [y=0] - The Y position\n * @param {number} [scaleX=1] - The X scale value\n * @param {number} [scaleY=1] - The Y scale value\n * @param {number} [rotation=0] - The rotation\n * @param {number} [skewX=0] - The X skew value\n * @param {number} [skewY=0] - The Y skew value\n * @param {number} [pivotX=0] - The X pivot value\n * @param {number} [pivotY=0] - The Y pivot value\n * @return {PIXI.DisplayObject} The DisplayObject instance\n */", "meta": { "range": [ 11588, 12034 ], "filename": "DisplayObject.js", "lineno": 376, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005520", "name": "DisplayObject#setTransform", "type": "MethodDefinition", "paramnames": [ "x", "y", "scaleX", "scaleY", "rotation", "skewX", "skewY", "pivotX", "pivotY" ] }, "vars": { "": null } }, "description": "

Convenience function to set the position, scale, skew and pivot at once.

", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

The X position

", "name": "x" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

The Y position

", "name": "y" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 1, "description": "

The X scale value

", "name": "scaleX" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 1, "description": "

The Y scale value

", "name": "scaleY" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

The rotation

", "name": "rotation" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

The X skew value

", "name": "skewX" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

The Y skew value

", "name": "skewY" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

The X pivot value

", "name": "pivotX" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

The Y pivot value

", "name": "pivotY" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The DisplayObject instance

" } ], "name": "setTransform", "longname": "PIXI.mesh.Mesh#setTransform", "kind": "function", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "inherits": "PIXI.DisplayObject#setTransform", "inherited": true, "overrides": "PIXI.Container#setTransform", "___id": "T000002R014501", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshsetTransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The position of the displayObject on the x axis relative to the local coordinates of the parent.\n * An alias to position.x\n *\n * @member {number}\n */", "meta": { "range": [ 12966, 13017 ], "filename": "DisplayObject.js", "lineno": 427, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005707", "name": "DisplayObject#x", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x

", "kind": "member", "type": { "names": [ "number" ] }, "name": "x", "longname": "PIXI.mesh.Mesh#x", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#x", "inherited": true, "overrides": "PIXI.Container#x", "___id": "T000002R014502", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshx", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The position of the displayObject on the y axis relative to the local coordinates of the parent.\n * An alias to position.y\n *\n * @member {number}\n */", "meta": { "range": [ 13314, 13365 ], "filename": "DisplayObject.js", "lineno": 443, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005732", "name": "DisplayObject#y", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y

", "kind": "member", "type": { "names": [ "number" ] }, "name": "y", "longname": "PIXI.mesh.Mesh#y", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#y", "inherited": true, "overrides": "PIXI.Container#y", "___id": "T000002R014503", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshy", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Current transform of the object based on world (parent) factors\n *\n * @member {PIXI.Matrix}\n * @readonly\n */", "meta": { "range": [ 13621, 13699 ], "filename": "DisplayObject.js", "lineno": 459, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005757", "name": "DisplayObject#worldTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Current transform of the object based on world (parent) factors

", "kind": "member", "type": { "names": [ "PIXI.Matrix" ] }, "readonly": true, "name": "worldTransform", "longname": "PIXI.mesh.Mesh#worldTransform", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#worldTransform", "inherited": true, "overrides": "PIXI.Container#worldTransform", "___id": "T000002R014504", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshworldTransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Current transform of the object based on local factors: position, scale, other stuff\n *\n * @member {PIXI.Matrix}\n * @readonly\n */", "meta": { "range": [ 13866, 13944 ], "filename": "DisplayObject.js", "lineno": 470, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005767", "name": "DisplayObject#localTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Current transform of the object based on local factors: position, scale, other stuff

", "kind": "member", "type": { "names": [ "PIXI.Matrix" ] }, "readonly": true, "name": "localTransform", "longname": "PIXI.mesh.Mesh#localTransform", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#localTransform", "inherited": true, "overrides": "PIXI.Container#localTransform", "___id": "T000002R014505", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshlocalTransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The coordinate of the object relative to the local coordinates of the parent.\n * Assignment by value since pixi-v4.\n *\n * @member {PIXI.Point|PIXI.ObservablePoint}\n */", "meta": { "range": [ 14149, 14215 ], "filename": "DisplayObject.js", "lineno": 481, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005777", "name": "DisplayObject#position", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4.

", "kind": "member", "type": { "names": [ "PIXI.Point", "PIXI.ObservablePoint" ] }, "name": "position", "longname": "PIXI.mesh.Mesh#position", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#position", "inherited": true, "overrides": "PIXI.Container#position", "___id": "T000002R014506", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshposition", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The scale factor of the object.\n * Assignment by value since pixi-v4.\n *\n * @member {PIXI.Point|PIXI.ObservablePoint}\n */", "meta": { "range": [ 14493, 14553 ], "filename": "DisplayObject.js", "lineno": 497, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005802", "name": "DisplayObject#scale", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The scale factor of the object.
Assignment by value since pixi-v4.

", "kind": "member", "type": { "names": [ "PIXI.Point", "PIXI.ObservablePoint" ] }, "name": "scale", "longname": "PIXI.mesh.Mesh#scale", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#scale", "inherited": true, "overrides": "PIXI.Container#scale", "___id": "T000002R014507", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshscale", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The pivot point of the displayObject that it rotates around\n * Assignment by value since pixi-v4.\n *\n * @member {PIXI.Point|PIXI.ObservablePoint}\n */", "meta": { "range": [ 14853, 14913 ], "filename": "DisplayObject.js", "lineno": 513, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005827", "name": "DisplayObject#pivot", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4.

", "kind": "member", "type": { "names": [ "PIXI.Point", "PIXI.ObservablePoint" ] }, "name": "pivot", "longname": "PIXI.mesh.Mesh#pivot", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#pivot", "inherited": true, "overrides": "PIXI.Container#pivot", "___id": "T000002R014508", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshpivot", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The skew factor for the object in radians.\n * Assignment by value since pixi-v4.\n *\n * @member {PIXI.ObservablePoint}\n */", "meta": { "range": [ 15185, 15243 ], "filename": "DisplayObject.js", "lineno": 529, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005852", "name": "DisplayObject#skew", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The skew factor for the object in radians.
Assignment by value since pixi-v4.

", "kind": "member", "type": { "names": [ "PIXI.ObservablePoint" ] }, "name": "skew", "longname": "PIXI.mesh.Mesh#skew", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#skew", "inherited": true, "overrides": "PIXI.Container#skew", "___id": "T000002R014509", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshskew", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The rotation of the object in radians.\n *\n * @member {number}\n */", "meta": { "range": [ 15453, 15519 ], "filename": "DisplayObject.js", "lineno": 544, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005877", "name": "DisplayObject#rotation", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The rotation of the object in radians.

", "kind": "member", "type": { "names": [ "number" ] }, "name": "rotation", "longname": "PIXI.mesh.Mesh#rotation", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#rotation", "inherited": true, "overrides": "PIXI.Container#rotation", "___id": "T000002R014510", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshrotation", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Indicates if the object is globally visible.\n *\n * @member {boolean}\n * @readonly\n */", "meta": { "range": [ 15757, 16002 ], "filename": "DisplayObject.js", "lineno": 560, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005900", "name": "DisplayObject#worldVisible", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Indicates if the object is globally visible.

", "kind": "member", "type": { "names": [ "boolean" ] }, "readonly": true, "name": "worldVisible", "longname": "PIXI.mesh.Mesh#worldVisible", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#worldVisible", "inherited": true, "overrides": "PIXI.Container#worldVisible", "___id": "T000002R014511", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshworldVisible", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Sets a mask for the displayObject. A mask is an object that limits the visibility of an\n * object to the shape of the mask applied to it. In PIXI a regular mask must be a\n * PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it\n * utilises shape clipping. To remove a mask, set this property to null.\n *\n * @todo For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.\n *\n * @member {PIXI.Graphics|PIXI.Sprite}\n */", "meta": { "range": [ 16524, 16573 ], "filename": "DisplayObject.js", "lineno": 587, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005927", "name": "DisplayObject#mask", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

", "todo": [ "For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask." ], "kind": "member", "type": { "names": [ "PIXI.Graphics", "PIXI.Sprite" ] }, "name": "mask", "longname": "PIXI.mesh.Mesh#mask", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#mask", "inherited": true, "overrides": "PIXI.Container#mask", "___id": "T000002R014512", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshmask", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Sets the filters for the displayObject.\n * * IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.\n * To remove filters simply set this property to 'null'\n *\n * @member {PIXI.Filter[]}\n */", "meta": { "range": [ 17106, 17186 ], "filename": "DisplayObject.js", "lineno": 614, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005972", "name": "DisplayObject#filters", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Sets the filters for the displayObject.

IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
To remove filters simply set this property to 'null'

", "kind": "member", "type": { "names": [ "Array." ] }, "name": "filters", "longname": "PIXI.mesh.Mesh#filters", "memberof": "PIXI.mesh.Mesh", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#filters", "inherited": true, "overrides": "PIXI.Container#filters", "___id": "T000002R014513", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshfilters", "filepath": "core\\display\\DisplayObject.js" } ], "$attributes": [ { "comment": "/**\n * The texture of the Mesh\n *\n * @member {PIXI.Texture} PIXI.mesh.Mesh#_texture\n * @private\n */", "meta": { "range": [ 807, 946 ], "filename": "Mesh.js", "lineno": 28, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The texture of the Mesh

", "kind": "member", "name": "_texture", "type": { "names": [ "PIXI.Texture" ] }, "access": "private", "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#_texture", "scope": "instance", "___id": "T000002R006187", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_texture", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The Uvs of the Mesh\n *\n * @member {Float32Array} PIXI.mesh.Mesh#uvs\n */", "meta": { "range": [ 989, 1099 ], "filename": "Mesh.js", "lineno": 36, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The Uvs of the Mesh

", "kind": "member", "name": "uvs", "type": { "names": [ "Float32Array" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#uvs", "scope": "instance", "___id": "T000002R006189", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshuvs", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * An array of vertices\n *\n * @member {Float32Array} PIXI.mesh.Mesh#vertices\n */", "meta": { "range": [ 1228, 1344 ], "filename": "Mesh.js", "lineno": 47, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

An array of vertices

", "kind": "member", "name": "vertices", "type": { "names": [ "Float32Array" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#vertices", "scope": "instance", "___id": "T000002R006191", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshvertices", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Version of mesh uvs are dirty or not\n *\n * @member {number} PIXI.mesh.Mesh#dirty\n */", "meta": { "range": [ 1717, 1840 ], "filename": "Mesh.js", "lineno": 64, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

Version of mesh uvs are dirty or not

", "kind": "member", "name": "dirty", "type": { "names": [ "number" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#dirty", "scope": "instance", "___id": "T000002R006194", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshdirty", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Version of mesh indices\n *\n * @member {number} PIXI.mesh.Mesh#indexDirty\n */", "meta": { "range": [ 1874, 1989 ], "filename": "Mesh.js", "lineno": 71, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

Version of mesh indices

", "kind": "member", "name": "indexDirty", "type": { "names": [ "number" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#indexDirty", "scope": "instance", "___id": "T000002R006196", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshindexDirty", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The blend mode to be applied to the sprite. Set to `PIXI.BLEND_MODES.NORMAL` to remove\n * any blend mode.\n *\n * @member {number} PIXI.mesh.Mesh#blendMode\n * @default PIXI.BLEND_MODES.NORMAL\n * @see PIXI.BLEND_MODES\n */", "meta": { "range": [ 2028, 2309 ], "filename": "Mesh.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The blend mode to be applied to the sprite. Set to PIXI.BLEND_MODES.NORMAL to remove
any blend mode.

", "kind": "member", "name": "blendMode", "type": { "names": [ "number" ] }, "defaultvalue": "PIXI.BLEND_MODES.NORMAL", "see": [ "PIXI.BLEND_MODES" ], "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#blendMode", "scope": "instance", "___id": "T000002R006198", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshblendMode", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Triangles in canvas mode are automatically antialiased, use this value to force triangles\n * to overlap a bit with each other.\n *\n * @member {number} PIXI.mesh.Mesh#canvasPadding\n */", "meta": { "range": [ 2369, 2598 ], "filename": "Mesh.js", "lineno": 88, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

Triangles in canvas mode are automatically antialiased, use this value to force triangles
to overlap a bit with each other.

", "kind": "member", "name": "canvasPadding", "type": { "names": [ "number" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#canvasPadding", "scope": "instance", "___id": "T000002R006200", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshcanvasPadding", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The way the Mesh should be drawn, can be any of the {@link PIXI.mesh.Mesh.DRAW_MODES} consts\n *\n * @member {number} PIXI.mesh.Mesh#drawMode\n * @see PIXI.mesh.Mesh.DRAW_MODES\n */", "meta": { "range": [ 2640, 2864 ], "filename": "Mesh.js", "lineno": 96, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The way the Mesh should be drawn, can be any of the {@link PIXI.mesh.Mesh.DRAW_MODES} consts

", "kind": "member", "name": "drawMode", "type": { "names": [ "number" ] }, "see": [ "PIXI.mesh.Mesh.DRAW_MODES" ], "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#drawMode", "scope": "instance", "___id": "T000002R006202", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshdrawMode", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The default shader that is used if a mesh doesn't have a more specific one.\n *\n * @member {PIXI.Shader} PIXI.mesh.Mesh#shader\n */", "meta": { "range": [ 2941, 3109 ], "filename": "Mesh.js", "lineno": 104, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The default shader that is used if a mesh doesn't have a more specific one.

", "kind": "member", "name": "shader", "type": { "names": [ "PIXI.Shader" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#shader", "scope": "instance", "___id": "T000002R006204", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshshader", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The tint applied to the mesh. This is a [r,g,b] value. A value of [1,1,1] will remove any\n * tint effect.\n *\n * @member {number} PIXI.mesh.Mesh#tintRgb\n */", "meta": { "range": [ 3147, 3349 ], "filename": "Mesh.js", "lineno": 111, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The tint applied to the mesh. This is a [r,g,b] value. A value of [1,1,1] will remove any
tint effect.

", "kind": "member", "name": "tintRgb", "type": { "names": [ "number" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#tintRgb", "scope": "instance", "___id": "T000002R006206", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshtintRgb", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * A map of renderer IDs to webgl render data\n *\n * @private\n * @member {object} PIXI.mesh.Mesh#_glDatas\n */", "meta": { "range": [ 3411, 3579 ], "filename": "Mesh.js", "lineno": 119, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

A map of renderer IDs to webgl render data

", "access": "private", "kind": "member", "name": "_glDatas", "type": { "names": [ "object." ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#_glDatas", "scope": "instance", "___id": "T000002R006208", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_glDatas", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * transform that is applied to UV to get the texture coords\n * its updated independently from texture uvTransform\n * updates of uvs are tied to that thing\n *\n * @member {PIXI.extras.TextureTransform} PIXI.mesh.Mesh#_uvTransform\n * @private\n */", "meta": { "range": [ 3617, 3921 ], "filename": "Mesh.js", "lineno": 127, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

transform that is applied to UV to get the texture coords
its updated independently from texture uvTransform
updates of uvs are tied to that thing

", "kind": "member", "name": "_uvTransform", "type": { "names": [ "PIXI.extras.TextureTransform" ] }, "access": "private", "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#_uvTransform", "scope": "instance", "___id": "T000002R006210", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_uvTransform", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * whether or not upload uvTransform to shader\n * if its false, then uvs should be pre-multiplied\n * if you change it for generated mesh, please call 'refresh(true)'\n * @member {boolean} PIXI.mesh.Mesh#uploadUvTransform\n * @default false\n */", "meta": { "range": [ 3990, 4283 ], "filename": "Mesh.js", "lineno": 137, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

whether or not upload uvTransform to shader
if its false, then uvs should be pre-multiplied
if you change it for generated mesh, please call 'refresh(true)'

", "kind": "member", "name": "uploadUvTransform", "type": { "names": [ "boolean" ] }, "defaultvalue": "false", "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#uploadUvTransform", "scope": "instance", "___id": "T000002R006212", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshuploadUvTransform", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Plugin that is responsible for rendering this element.\n * Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.\n * @member {string} PIXI.mesh.Mesh#pluginName\n * @default 'mesh'\n */", "meta": { "range": [ 4333, 4609 ], "filename": "Mesh.js", "lineno": 146, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

Plugin that is responsible for rendering this element.
Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.

", "kind": "member", "name": "pluginName", "type": { "names": [ "string" ] }, "defaultvalue": "'mesh'", "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#pluginName", "scope": "instance", "___id": "T000002R006214", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshpluginName", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Different drawing buffer modes supported\n *\n * @static\n * @constant\n * @type {object}\n * @property {number} TRIANGLE_MESH\n * @property {number} TRIANGLES\n */", "meta": { "range": [ 9080, 9141 ], "filename": "Mesh.js", "lineno": 339, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100067703", "name": "Mesh.DRAW_MODES", "type": "ObjectExpression", "value": "{\"TRIANGLE_MESH\":0,\"TRIANGLES\":1}", "paramnames": [] } }, "description": "

Different drawing buffer modes supported

", "scope": "static", "kind": "constant", "type": { "names": [ "object" ] }, "properties": [ { "type": { "names": [ "number" ] }, "name": "TRIANGLE_MESH" }, { "type": { "names": [ "number" ] }, "name": "TRIANGLES" } ], "name": "DRAW_MODES", "longname": "PIXI.mesh.Mesh.DRAW_MODES", "memberof": "PIXI.mesh.Mesh", "___id": "T000002R006247", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh.DRAW_MODES", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The texture of the Mesh\n *\n * @member {PIXI.Texture} PIXI.mesh.Mesh#_texture\n * @private\n */", "meta": { "range": [ 807, 946 ], "filename": "Mesh.js", "lineno": 28, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The texture of the Mesh

", "kind": "member", "name": "_texture", "type": { "names": [ "PIXI.Texture" ] }, "access": "private", "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#_texture", "scope": "instance", "___id": "T000002R013121", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_texture", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The Uvs of the Mesh\n *\n * @member {Float32Array} PIXI.mesh.Mesh#uvs\n */", "meta": { "range": [ 989, 1099 ], "filename": "Mesh.js", "lineno": 36, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The Uvs of the Mesh

", "kind": "member", "name": "uvs", "type": { "names": [ "Float32Array" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#uvs", "scope": "instance", "___id": "T000002R013123", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshuvs", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * An array of vertices\n *\n * @member {Float32Array} PIXI.mesh.Mesh#vertices\n */", "meta": { "range": [ 1228, 1344 ], "filename": "Mesh.js", "lineno": 47, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

An array of vertices

", "kind": "member", "name": "vertices", "type": { "names": [ "Float32Array" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#vertices", "scope": "instance", "___id": "T000002R013125", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshvertices", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Version of mesh uvs are dirty or not\n *\n * @member {number} PIXI.mesh.Mesh#dirty\n */", "meta": { "range": [ 1717, 1840 ], "filename": "Mesh.js", "lineno": 64, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

Version of mesh uvs are dirty or not

", "kind": "member", "name": "dirty", "type": { "names": [ "number" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#dirty", "scope": "instance", "___id": "T000002R013128", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshdirty", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Version of mesh indices\n *\n * @member {number} PIXI.mesh.Mesh#indexDirty\n */", "meta": { "range": [ 1874, 1989 ], "filename": "Mesh.js", "lineno": 71, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

Version of mesh indices

", "kind": "member", "name": "indexDirty", "type": { "names": [ "number" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#indexDirty", "scope": "instance", "___id": "T000002R013130", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshindexDirty", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The blend mode to be applied to the sprite. Set to `PIXI.BLEND_MODES.NORMAL` to remove\n * any blend mode.\n *\n * @member {number} PIXI.mesh.Mesh#blendMode\n * @default PIXI.BLEND_MODES.NORMAL\n * @see PIXI.BLEND_MODES\n */", "meta": { "range": [ 2028, 2309 ], "filename": "Mesh.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The blend mode to be applied to the sprite. Set to PIXI.BLEND_MODES.NORMAL to remove
any blend mode.

", "kind": "member", "name": "blendMode", "type": { "names": [ "number" ] }, "defaultvalue": "PIXI.BLEND_MODES.NORMAL", "see": [ "PIXI.BLEND_MODES" ], "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#blendMode", "scope": "instance", "___id": "T000002R013132", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshblendMode", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Triangles in canvas mode are automatically antialiased, use this value to force triangles\n * to overlap a bit with each other.\n *\n * @member {number} PIXI.mesh.Mesh#canvasPadding\n */", "meta": { "range": [ 2369, 2598 ], "filename": "Mesh.js", "lineno": 88, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

Triangles in canvas mode are automatically antialiased, use this value to force triangles
to overlap a bit with each other.

", "kind": "member", "name": "canvasPadding", "type": { "names": [ "number" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#canvasPadding", "scope": "instance", "___id": "T000002R013134", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshcanvasPadding", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The way the Mesh should be drawn, can be any of the {@link PIXI.mesh.Mesh.DRAW_MODES} consts\n *\n * @member {number} PIXI.mesh.Mesh#drawMode\n * @see PIXI.mesh.Mesh.DRAW_MODES\n */", "meta": { "range": [ 2640, 2864 ], "filename": "Mesh.js", "lineno": 96, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The way the Mesh should be drawn, can be any of the {@link PIXI.mesh.Mesh.DRAW_MODES} consts

", "kind": "member", "name": "drawMode", "type": { "names": [ "number" ] }, "see": [ "PIXI.mesh.Mesh.DRAW_MODES" ], "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#drawMode", "scope": "instance", "___id": "T000002R013136", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshdrawMode", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The default shader that is used if a mesh doesn't have a more specific one.\n *\n * @member {PIXI.Shader} PIXI.mesh.Mesh#shader\n */", "meta": { "range": [ 2941, 3109 ], "filename": "Mesh.js", "lineno": 104, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The default shader that is used if a mesh doesn't have a more specific one.

", "kind": "member", "name": "shader", "type": { "names": [ "PIXI.Shader" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#shader", "scope": "instance", "___id": "T000002R013138", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshshader", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The tint applied to the mesh. This is a [r,g,b] value. A value of [1,1,1] will remove any\n * tint effect.\n *\n * @member {number} PIXI.mesh.Mesh#tintRgb\n */", "meta": { "range": [ 3147, 3349 ], "filename": "Mesh.js", "lineno": 111, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

The tint applied to the mesh. This is a [r,g,b] value. A value of [1,1,1] will remove any
tint effect.

", "kind": "member", "name": "tintRgb", "type": { "names": [ "number" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#tintRgb", "scope": "instance", "___id": "T000002R013140", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshtintRgb", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * A map of renderer IDs to webgl render data\n *\n * @private\n * @member {object} PIXI.mesh.Mesh#_glDatas\n */", "meta": { "range": [ 3411, 3579 ], "filename": "Mesh.js", "lineno": 119, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

A map of renderer IDs to webgl render data

", "access": "private", "kind": "member", "name": "_glDatas", "type": { "names": [ "object." ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#_glDatas", "scope": "instance", "___id": "T000002R013142", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_glDatas", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * transform that is applied to UV to get the texture coords\n * its updated independently from texture uvTransform\n * updates of uvs are tied to that thing\n *\n * @member {PIXI.extras.TextureTransform} PIXI.mesh.Mesh#_uvTransform\n * @private\n */", "meta": { "range": [ 3617, 3921 ], "filename": "Mesh.js", "lineno": 127, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

transform that is applied to UV to get the texture coords
its updated independently from texture uvTransform
updates of uvs are tied to that thing

", "kind": "member", "name": "_uvTransform", "type": { "names": [ "PIXI.extras.TextureTransform" ] }, "access": "private", "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#_uvTransform", "scope": "instance", "___id": "T000002R013144", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_uvTransform", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * whether or not upload uvTransform to shader\n * if its false, then uvs should be pre-multiplied\n * if you change it for generated mesh, please call 'refresh(true)'\n * @member {boolean} PIXI.mesh.Mesh#uploadUvTransform\n * @default false\n */", "meta": { "range": [ 3990, 4283 ], "filename": "Mesh.js", "lineno": 137, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

whether or not upload uvTransform to shader
if its false, then uvs should be pre-multiplied
if you change it for generated mesh, please call 'refresh(true)'

", "kind": "member", "name": "uploadUvTransform", "type": { "names": [ "boolean" ] }, "defaultvalue": "false", "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#uploadUvTransform", "scope": "instance", "___id": "T000002R013146", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshuploadUvTransform", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Plugin that is responsible for rendering this element.\n * Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.\n * @member {string} PIXI.mesh.Mesh#pluginName\n * @default 'mesh'\n */", "meta": { "range": [ 4333, 4609 ], "filename": "Mesh.js", "lineno": 146, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": {} }, "description": "

Plugin that is responsible for rendering this element.
Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.

", "kind": "member", "name": "pluginName", "type": { "names": [ "string" ] }, "defaultvalue": "'mesh'", "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#pluginName", "scope": "instance", "___id": "T000002R013148", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshpluginName", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * Different drawing buffer modes supported\n *\n * @static\n * @constant\n * @type {object}\n * @property {number} TRIANGLE_MESH\n * @property {number} TRIANGLES\n */", "meta": { "range": [ 9080, 9141 ], "filename": "Mesh.js", "lineno": 339, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\mesh", "code": { "id": "astnode100142382", "name": "Mesh.DRAW_MODES", "type": "ObjectExpression", "value": "{\"TRIANGLE_MESH\":0,\"TRIANGLES\":1}", "paramnames": [] } }, "description": "

Different drawing buffer modes supported

", "scope": "static", "kind": "constant", "type": { "names": [ "object" ] }, "properties": [ { "type": { "names": [ "number" ] }, "name": "TRIANGLE_MESH" }, { "type": { "names": [ "number" ] }, "name": "TRIANGLES" } ], "name": "DRAW_MODES", "longname": "PIXI.mesh.Mesh.DRAW_MODES", "memberof": "PIXI.mesh.Mesh", "___id": "T000002R013181", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh.DRAW_MODES", "filepath": "mesh\\Mesh.js" }, { "comment": "/**\n * The array of children of this container.\n *\n * @member {PIXI.DisplayObject[]} PIXI.Container#children\n * @readonly\n */", "meta": { "range": [ 535, 700 ], "filename": "Container.js", "lineno": 28, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

The array of children of this container.

", "kind": "member", "name": "children", "type": { "names": [ "Array." ] }, "readonly": true, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#children", "scope": "instance", "inherits": "PIXI.Container#children", "inherited": true, "overrides": "PIXI.Container#children", "___id": "T000002R014465", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshchildren", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * World transform and local transform of this object.\n * This will become read-only later, please do not assign anything there unless you know what are you doing\n *\n * @member {PIXI.TransformBase} PIXI.DisplayObject#transform\n */", "meta": { "range": [ 957, 1231 ], "filename": "DisplayObject.js", "lineno": 35, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

World transform and local transform of this object.
This will become read-only later, please do not assign anything there unless you know what are you doing

", "kind": "member", "name": "transform", "type": { "names": [ "PIXI.TransformBase" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#transform", "scope": "instance", "inherits": "PIXI.DisplayObject#transform", "inherited": true, "overrides": "PIXI.Container#transform", "___id": "T000002R014484", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshtransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The opacity of the object.\n *\n * @member {number} PIXI.DisplayObject#alpha\n */", "meta": { "range": [ 1288, 1405 ], "filename": "DisplayObject.js", "lineno": 43, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

The opacity of the object.

", "kind": "member", "name": "alpha", "type": { "names": [ "number" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#alpha", "scope": "instance", "inherits": "PIXI.DisplayObject#alpha", "inherited": true, "overrides": "PIXI.Container#alpha", "___id": "T000002R014485", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshalpha", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The visibility of the object. If false the object will not be drawn, and\n * the updateTransform function will not be called.\n *\n * Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually\n *\n * @member {boolean} PIXI.DisplayObject#visible\n */", "meta": { "range": [ 1439, 1785 ], "filename": "DisplayObject.js", "lineno": 50, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

The visibility of the object. If false the object will not be drawn, and
the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually

", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#visible", "scope": "instance", "inherits": "PIXI.DisplayObject#visible", "inherited": true, "overrides": "PIXI.Container#visible", "___id": "T000002R014486", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshvisible", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Can this object be rendered, if false the object will not be drawn but the updateTransform\n * methods will still be called.\n *\n * Only affects recursive calls from parent. You can ask for bounds manually\n *\n * @member {boolean} PIXI.DisplayObject#renderable\n */", "meta": { "range": [ 1824, 2148 ], "filename": "DisplayObject.js", "lineno": 60, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

Can this object be rendered, if false the object will not be drawn but the updateTransform
methods will still be called.

Only affects recursive calls from parent. You can ask for bounds manually

", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#renderable", "scope": "instance", "inherits": "PIXI.DisplayObject#renderable", "inherited": true, "overrides": "PIXI.Container#renderable", "___id": "T000002R014487", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshrenderable", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The display object container that contains this display object.\n *\n * @member {PIXI.Container} PIXI.DisplayObject#parent\n * @readonly\n */", "meta": { "range": [ 2190, 2374 ], "filename": "DisplayObject.js", "lineno": 70, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

The display object container that contains this display object.

", "kind": "member", "name": "parent", "type": { "names": [ "PIXI.Container" ] }, "readonly": true, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#parent", "scope": "instance", "inherits": "PIXI.DisplayObject#parent", "inherited": true, "overrides": "PIXI.Container#parent", "___id": "T000002R014488", "___s": true, "skip": true, "slug": "PIXI.mesh.Meshparent", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The multiplied alpha of the displayObject\n *\n * @member {number} PIXI.DisplayObject#worldAlpha\n * @readonly\n */", "meta": { "range": [ 2412, 2570 ], "filename": "DisplayObject.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

The multiplied alpha of the displayObject

", "kind": "member", "name": "worldAlpha", "type": { "names": [ "number" ] }, "readonly": true, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#worldAlpha", "scope": "instance", "inherits": "PIXI.DisplayObject#worldAlpha", "inherited": true, "overrides": "PIXI.Container#worldAlpha", "___id": "T000002R014489", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshworldAlpha", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The area the filter is applied to. This is used as more of an optimisation\n * rather than figuring out the dimensions of the displayObject each frame you can set this rectangle\n *\n * Also works as an interaction mask\n *\n * @member {PIXI.Rectangle} PIXI.DisplayObject#filterArea\n */", "meta": { "range": [ 2609, 2953 ], "filename": "DisplayObject.js", "lineno": 86, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

The area the filter is applied to. This is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

Also works as an interaction mask

", "kind": "member", "name": "filterArea", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#filterArea", "scope": "instance", "inherits": "PIXI.DisplayObject#filterArea", "inherited": true, "overrides": "PIXI.Container#filterArea", "___id": "T000002R014490", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshfilterArea", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The bounds object, this is used to calculate and store the bounds of the displayObject\n *\n * @member {PIXI.Rectangle} PIXI.DisplayObject#_bounds\n * @private\n */", "meta": { "range": [ 3063, 3270 ], "filename": "DisplayObject.js", "lineno": 99, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

The bounds object, this is used to calculate and store the bounds of the displayObject

", "kind": "member", "name": "_bounds", "type": { "names": [ "PIXI.Rectangle" ] }, "access": "private", "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#_bounds", "scope": "instance", "inherits": "PIXI.DisplayObject#_bounds", "inherited": true, "overrides": "PIXI.Container#_bounds", "___id": "T000002R014491", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_bounds", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * The original, cached mask of the object\n *\n * @member {PIXI.Graphics|PIXI.Sprite} PIXI.DisplayObject#_mask\n * @private\n */", "meta": { "range": [ 3449, 3618 ], "filename": "DisplayObject.js", "lineno": 111, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

The original, cached mask of the object

", "kind": "member", "name": "_mask", "type": { "names": [ "PIXI.Graphics", "PIXI.Sprite" ] }, "access": "private", "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#_mask", "scope": "instance", "inherits": "PIXI.DisplayObject#_mask", "inherited": true, "overrides": "PIXI.Container#_mask", "___id": "T000002R014492", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_mask", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * If the object has been destroyed via destroy(). If true, it should not be used.\n *\n * @member {boolean} PIXI.DisplayObject#_destroyed\n * @private\n * @readonly\n */", "meta": { "range": [ 3655, 3872 ], "filename": "DisplayObject.js", "lineno": 119, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": {} }, "description": "

If the object has been destroyed via destroy(). If true, it should not be used.

", "kind": "member", "name": "_destroyed", "type": { "names": [ "boolean" ] }, "access": "private", "readonly": true, "memberof": "PIXI.mesh.Mesh", "longname": "PIXI.mesh.Mesh#_destroyed", "scope": "instance", "inherits": "PIXI.DisplayObject#_destroyed", "inherited": true, "overrides": "PIXI.Container#_destroyed", "___id": "T000002R014493", "___s": true, "skip": true, "slug": "PIXI.mesh.Mesh_destroyed", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Set this to true if you want this display object to be cached as a bitmap.\n * This basically takes a snap shot of the display object as it is at that moment. It can\n * provide a performance benefit for complex static displayObjects.\n * To remove simply set this property to 'false'\n *\n * IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true\n * as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.\n *\n * @member {boolean}\n * @memberof PIXI.DisplayObject#\n */", "meta": { "range": [ 1587, 3623 ], "filename": "cacheAsBitmap.js", "lineno": 50, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\extras", "code": { "id": "astnode100053521", "name": "cacheAsBitmap", "type": "ObjectExpression", "value": "{\"get\":\"\",\"set\":\"\"}" } }, "description": "

Set this to true if you want this display object to be cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can
provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'false'

IMPORTANT GOTCHA - make sure that all your textures are preloaded BEFORE setting this property to true
as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.

", "kind": "member", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.mesh.Mesh", "name": "cacheAsBitmap", "longname": "PIXI.mesh.Mesh#cacheAsBitmap", "scope": "instance", "inherits": "PIXI.DisplayObject#cacheAsBitmap", "inherited": true, "overrides": "PIXI.Container#cacheAsBitmap", "___id": "T000002R014514", "___s": true, "skip": true, "slug": "PIXI.mesh.MeshcacheAsBitmap", "filepath": "extras\\cacheAsBitmap.js" } ], "$staticmethods": [], "$staticproperties": [], "$augments": [ { "comment": "/**\n * A Container represents a collection of display objects.\n * It is the base class of all display objects that act as a container for other objects.\n *\n *```js\n * let container = new PIXI.Container();\n * container.addChild(sprite);\n * ```\n *\n * @class\n * @extends PIXI.DisplayObject\n * @memberof PIXI\n */", "meta": { "range": [ 422, 17240 ], "filename": "Container.js", "lineno": 19, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003509", "name": "Container", "type": "ClassDeclaration", "paramnames": [] } }, "classdesc": "

A Container represents a collection of display objects.
It is the base class of all display objects that act as a container for other objects.

let container = new PIXI.Container();\ncontainer.addChild(sprite);

", "kind": "class", "augments": [ "PIXI.DisplayObject" ], "memberof": "PIXI", "name": "Container", "longname": "PIXI.Container", "scope": "static", "params": [], "___id": "T000002R000428", "___s": true, "$methods": [ { "comment": "/**\n * Overridable method that can be used by Container subclasses whenever the children array is modified\n *\n * @private\n */", "meta": { "range": [ 886, 936 ], "filename": "Container.js", "lineno": 42, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003526", "name": "Container#onChildrenChange", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Overridable method that can be used by Container subclasses whenever the children array is modified

", "access": "private", "name": "onChildrenChange", "longname": "PIXI.Container#onChildrenChange", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "params": [], "___id": "T000002R000432", "___s": true, "skip": true, "slug": "PIXI.ContaineronChildrenChange", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Adds one or more children to the container.\n *\n * Multiple items can be added like so: `myContainer.addChild(thingOne, thingTwo, thingThree)`\n *\n * @param {...PIXI.DisplayObject} child - The DisplayObject(s) to add to the container\n * @return {PIXI.DisplayObject} The first child that was added.\n */", "meta": { "range": [ 1281, 2509 ], "filename": "Container.js", "lineno": 55, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003530", "name": "Container#addChild", "type": "MethodDefinition", "paramnames": [ "child" ] }, "vars": { "": null } }, "description": "

Adds one or more children to the container.

Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

", "params": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "variable": true, "description": "

The DisplayObject(s) to add to the container

", "name": "child" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The first child that was added.

" } ], "name": "addChild", "longname": "PIXI.Container#addChild", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000433", "___s": true, "skip": true, "slug": "PIXI.ContaineraddChild", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown\n *\n * @param {PIXI.DisplayObject} child - The child to add\n * @param {number} index - The index to place the child in\n * @return {PIXI.DisplayObject} The child that was added.\n */", "meta": { "range": [ 2836, 3576 ], "filename": "Container.js", "lineno": 101, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003628", "name": "Container#addChildAt", "type": "MethodDefinition", "paramnames": [ "child", "index" ] }, "vars": { "": null } }, "description": "

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

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

The child to add

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

The index to place the child in

", "name": "index" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The child that was added.

" } ], "name": "addChildAt", "longname": "PIXI.Container#addChildAt", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000438", "___s": true, "skip": true, "slug": "PIXI.ContaineraddChildAt", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Swaps the position of 2 Display Objects within this container.\n *\n * @param {PIXI.DisplayObject} child - First display object to swap\n * @param {PIXI.DisplayObject} child2 - Second display object to swap\n */", "meta": { "range": [ 3821, 4178 ], "filename": "Container.js", "lineno": 135, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003720", "name": "Container#swapChildren", "type": "MethodDefinition", "paramnames": [ "child", "child2" ] }, "vars": { "": null } }, "description": "

Swaps the position of 2 Display Objects within this container.

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

First display object to swap

", "name": "child" }, { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

Second display object to swap

", "name": "child2" } ], "name": "swapChildren", "longname": "PIXI.Container#swapChildren", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000441", "___s": true, "skip": true, "slug": "PIXI.ContainerswapChildren", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Returns the index position of a child DisplayObject instance\n *\n * @param {PIXI.DisplayObject} child - The DisplayObject instance to identify\n * @return {number} The index position of the child display object to identify\n */", "meta": { "range": [ 4440, 4683 ], "filename": "Container.js", "lineno": 156, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003775", "name": "Container#getChildIndex", "type": "MethodDefinition", "paramnames": [ "child" ] }, "vars": { "": null } }, "description": "

Returns the index position of a child DisplayObject instance

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

The DisplayObject instance to identify

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

The index position of the child display object to identify

" } ], "name": "getChildIndex", "longname": "PIXI.Container#getChildIndex", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000446", "___s": true, "skip": true, "slug": "PIXI.ContainergetChildIndex", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Changes the position of an existing child in the display object container\n *\n * @param {PIXI.DisplayObject} child - The child DisplayObject instance for which you want to change the index number\n * @param {number} index - The resulting index number for the child display object\n */", "meta": { "range": [ 5002, 5433 ], "filename": "Container.js", "lineno": 174, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003802", "name": "Container#setChildIndex", "type": "MethodDefinition", "paramnames": [ "child", "index" ] }, "vars": { "": null } }, "description": "

Changes the position of an existing child in the display object container

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

The child DisplayObject instance for which you want to change the index number

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

The resulting index number for the child display object

", "name": "index" } ], "name": "setChildIndex", "longname": "PIXI.Container#setChildIndex", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000448", "___s": true, "skip": true, "slug": "PIXI.ContainersetChildIndex", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Returns the child at the specified index\n *\n * @param {number} index - The index to get the child at\n * @return {PIXI.DisplayObject} The child at the given index, if any.\n */", "meta": { "range": [ 5645, 5865 ], "filename": "Container.js", "lineno": 195, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003857", "name": "Container#getChildAt", "type": "MethodDefinition", "paramnames": [ "index" ] }, "vars": { "": null } }, "description": "

Returns the child at the specified index

", "params": [ { "type": { "names": [ "number" ] }, "description": "

The index to get the child at

", "name": "index" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The child at the given index, if any.

" } ], "name": "getChildAt", "longname": "PIXI.Container#getChildAt", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000450", "___s": true, "skip": true, "slug": "PIXI.ContainergetChildAt", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Removes one or more children from the container.\n *\n * @param {...PIXI.DisplayObject} child - The DisplayObject(s) to remove\n * @return {PIXI.DisplayObject} The first child that was removed.\n */", "meta": { "range": [ 6097, 7212 ], "filename": "Container.js", "lineno": 211, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003888", "name": "Container#removeChild", "type": "MethodDefinition", "paramnames": [ "child" ] }, "vars": { "": null } }, "description": "

Removes one or more children from the container.

", "params": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "variable": true, "description": "

The DisplayObject(s) to remove

", "name": "child" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The first child that was removed.

" } ], "name": "removeChild", "longname": "PIXI.Container#removeChild", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000451", "___s": true, "skip": true, "slug": "PIXI.ContainerremoveChild", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Removes a child from the specified index position.\n *\n * @param {number} index - The index to get the child from\n * @return {PIXI.DisplayObject} The child that was removed.\n */", "meta": { "range": [ 7426, 7922 ], "filename": "Container.js", "lineno": 253, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100003984", "name": "Container#removeChildAt", "type": "MethodDefinition", "paramnames": [ "index" ] }, "vars": { "": null } }, "description": "

Removes a child from the specified index position.

", "params": [ { "type": { "names": [ "number" ] }, "description": "

The index to get the child from

", "name": "index" } ], "returns": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "description": "

The child that was removed.

" } ], "name": "removeChildAt", "longname": "PIXI.Container#removeChildAt", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000457", "___s": true, "skip": true, "slug": "PIXI.ContainerremoveChildAt", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Removes all children from this container that are within the begin and end indexes.\n *\n * @param {number} [beginIndex=0] - The beginning position.\n * @param {number} [endIndex=this.children.length] - The ending position. Default value is size of the container.\n * @returns {DisplayObject[]} List of removed children\n */", "meta": { "range": [ 8283, 9328 ], "filename": "Container.js", "lineno": 279, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004040", "name": "Container#removeChildren", "type": "MethodDefinition", "paramnames": [ "beginIndex", "endIndex" ] }, "vars": { "": null } }, "description": "

Removes all children from this container that are within the begin and end indexes.

", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "

The beginning position.

", "name": "beginIndex" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "this.children.length", "description": "

The ending position. Default value is size of the container.

", "name": "endIndex" } ], "returns": [ { "type": { "names": [ "Array." ] }, "description": "

List of removed children

" } ], "name": "removeChildren", "longname": "PIXI.Container#removeChildren", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000461", "___s": true, "skip": true, "slug": "PIXI.ContainerremoveChildren", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Updates the transform on all children of this container for rendering\n */", "meta": { "range": [ 9427, 9901 ], "filename": "Container.js", "lineno": 321, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004188", "name": "Container#updateTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Updates the transform on all children of this container for rendering

", "name": "updateTransform", "longname": "PIXI.Container#updateTransform", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "params": [], "overrides": "PIXI.DisplayObject#updateTransform", "___id": "T000002R000471", "___s": true, "skip": true, "slug": "PIXI.ContainerupdateTransform", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Recalculates the bounds of the container.\n *\n */", "meta": { "range": [ 9979, 10873 ], "filename": "Container.js", "lineno": 345, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004259", "name": "Container#calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Recalculates the bounds of the container.

", "name": "calculateBounds", "longname": "PIXI.Container#calculateBounds", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "params": [], "___id": "T000002R000476", "___s": true, "skip": true, "slug": "PIXI.ContainercalculateBounds", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Recalculates the bounds of the object. Override this to\n * calculate the bounds of the specific object (not including children).\n *\n */", "meta": { "range": [ 11042, 11093 ], "filename": "Container.js", "lineno": 386, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004379", "name": "Container#_calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Recalculates the bounds of the object. Override this to
calculate the bounds of the specific object (not including children).

", "name": "_calculateBounds", "longname": "PIXI.Container#_calculateBounds", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "params": [], "___id": "T000002R000480", "___s": true, "skip": true, "slug": "PIXI.Container_calculateBounds", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 11232, 11919 ], "filename": "Container.js", "lineno": 396, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004383", "name": "Container#renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the WebGL renderer

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

The renderer

", "name": "renderer" } ], "name": "renderWebGL", "longname": "PIXI.Container#renderWebGL", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "overrides": "PIXI.DisplayObject#renderWebGL", "___id": "T000002R000481", "___s": true, "skip": true, "slug": "PIXI.ContainerrenderWebGL", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Render the object using the WebGL renderer and advanced features.\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 12096, 13593 ], "filename": "Container.js", "lineno": 427, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004456", "name": "Container#renderAdvancedWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Render the object using the WebGL renderer and advanced features.

", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "

The renderer

", "name": "renderer" } ], "name": "renderAdvancedWebGL", "longname": "PIXI.Container#renderAdvancedWebGL", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000484", "___s": true, "skip": true, "slug": "PIXI.ContainerrenderAdvancedWebGL", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * To be overridden by the subclasses.\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 13740, 13869 ], "filename": "Container.js", "lineno": 491, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004636", "name": "Container#_renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

To be overridden by the subclasses.

", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "

The renderer

", "name": "renderer" } ], "name": "_renderWebGL", "longname": "PIXI.Container#_renderWebGL", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000492", "___s": true, "skip": true, "slug": "PIXI.Container_renderWebGL", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * To be overridden by the subclass\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 14014, 14144 ], "filename": "Container.js", "lineno": 502, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004641", "name": "Container#_renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

To be overridden by the subclass

", "access": "private", "params": [ { "type": { "names": [ "PIXI.CanvasRenderer" ] }, "description": "

The renderer

", "name": "renderer" } ], "name": "_renderCanvas", "longname": "PIXI.Container#_renderCanvas", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "___id": "T000002R000493", "___s": true, "skip": true, "slug": "PIXI.Container_renderCanvas", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 14285, 14873 ], "filename": "Container.js", "lineno": 512, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004646", "name": "Container#renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the Canvas renderer

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

The renderer

", "name": "renderer" } ], "name": "renderCanvas", "longname": "PIXI.Container#renderCanvas", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "overrides": "PIXI.DisplayObject#renderCanvas", "___id": "T000002R000494", "___s": true, "skip": true, "slug": "PIXI.ContainerrenderCanvas", "filepath": "core\\display\\Container.js" }, { "comment": "/**\n * Removes all internal references and listeners as well as removes children from the display list.\n * Do not use a Container after calling `destroy`.\n *\n * @param {object|boolean} [options] - Options parameter. A boolean will act as if all options\n * have been set to that value\n * @param {boolean} [options.children=false] - if set to true, all the children will have their destroy\n * method called as well. 'options' will be passed on to those calls.\n * @param {boolean} [options.texture=false] - Only used for child Sprites if options.children is set to true\n * Should it destroy the texture of the child sprite\n * @param {boolean} [options.baseTexture=false] - Only used for child Sprites if options.children is set to true\n * Should it destroy the base texture of the child sprite\n */", "meta": { "range": [ 15730, 16145 ], "filename": "Container.js", "lineno": 550, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004731", "name": "Container#destroy", "type": "MethodDefinition", "paramnames": [ "options" ] }, "vars": { "": null } }, "description": "