Home

class: Text


A Text Object will create a line or multiple lines of text. To split a line you can use '\n' in your text string,
or add a wordWrap property set to true and and wordWrapWidth property with a value in the style object.

A Text can be created directly from a string and a style object

let text = new PIXI.Text('This is a pixi text',{fontFamily : 'Arial', fontSize: 24, fill : 0xff1010, align : 'center'});

Extends:

EventEmitterDisplayObjectContainerSprite → Text

Methods summary


Public methods
private updateText(respectDirty: boolean): void
private drawLetterSpacing(text: string, x: number, y: number, isStroke: boolean): void
private updateTexture(): void
public renderWebGL(renderer: PIXI.WebGLRenderer): void
private _renderCanvas(renderer: PIXI.CanvasRenderer): void
private wordWrap(text: string): string
public getLocalBounds(rect: Rectangle): Rectangle
public _calculateBounds(): void
private _onStyleChange(): void
private _generateFillStyle(style: object, lines: Array.<string>): string, number, CanvasGradient
public destroy(options: object, boolean): void
public width(): void
public height(): void
public style(): void
public text(): void
public static getFontStyle(style: object, TextStyle): string
public static calculateFontProperties(fontStyle: string): Object
private updateText(respectDirty: boolean): void
private drawLetterSpacing(text: string, x: number, y: number, isStroke: boolean): void
private updateTexture(): void
public renderWebGL(renderer: PIXI.WebGLRenderer): void
private _renderCanvas(renderer: PIXI.CanvasRenderer): void
private wordWrap(text: string): string
public getLocalBounds(rect: Rectangle): Rectangle
public _calculateBounds(): void
private _onStyleChange(): void
private _generateFillStyle(style: object, lines: Array.<string>): string, number, CanvasGradient
public destroy(options: object, boolean): void
public width(): void
public height(): void
public style(): void
public text(): void
public static getFontStyle(style: object, TextStyle): string
public static calculateFontProperties(fontStyle: string): Object
private _onTextureUpdate(): void
private _onAnchorUpdate(): void
public calculateVertices(): void
public calculateTrimmedVertices(): void
private _renderWebGL(renderer: PIXI.WebGLRenderer): void
public containsPoint(point: PIXI.Point): boolean
public anchor(): void
public tint(): void
public texture(): 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
private renderAdvancedWebGL(renderer: PIXI.WebGLRenderer): void
public renderCanvas(renderer: PIXI.CanvasRenderer): void
private _tempDisplayObjectParent(): void
public _recursivePostUpdateTransform(): void
public getBounds(skipUpdate: boolean, 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
canvas HTMLCanvasElement public

The canvas element that everything is drawn to

context CanvasRenderingContext2D public

The canvas 2d context that everything is drawn with

resolution number public

The resolution / device pixel ratio of the canvas. This is set automatically by the renderer.

_text string private

Private tracker for the current text.

_style object private

Private tracker for the current style.

_styleListener function private

Private listener to track style changes.

_font string private

Private tracker for the current font.

setText public
setStyle public
determineFontProperties private
canvas HTMLCanvasElement public

The canvas element that everything is drawn to

context CanvasRenderingContext2D public

The canvas 2d context that everything is drawn with

resolution number public

The resolution / device pixel ratio of the canvas. This is set automatically by the renderer.

_text string private

Private tracker for the current text.

_style object private

Private tracker for the current style.

_styleListener function private

Private listener to track style changes.

_font string private

Private tracker for the current font.

setText public
setStyle public
determineFontProperties private
_anchor PIXI.ObservablePoint private

The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting the anchor to 0.5,0.5 means the texture's origin is centered
Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

_texture PIXI.Texture private

The texture that the sprite is using

_width number private

The width of the sprite (this is initially set by the texture)

_height number private

The height of the sprite (this is initially set by the texture)

_tint number private

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

blendMode number public

The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

shader PIXI.Filter PIXI.Shader public

The shader that will be used to render the sprite. Set to null to remove a current shader.

cachedTint number private

An internal cached value of the tint.

vertexData Float32Array private

this is used to store the vertex data of the sprite (basically a quad)

vertexTrimmedData Float32Array private

This is used to calculate the bounds of the object IF it is a trimmed sprite

pluginName string public

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

setTexture private
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


updateText(respectDirty: boolean): void

Renders text and updates it when needed.

Params:

Name Type Attribute Description
respectDirty

Whether to abort updating the text if the Text isn't dirty and the function is called.

Returns:

void


drawLetterSpacing(text: string, x: number, y: number, isStroke: boolean): void

Render the text with letter-spacing.

Params:

Name Type Attribute Description
text

The text to draw

x

Horizontal position to draw the text

y

Vertical position to draw the text

isStroke

Is this drawing for the outside stroke of the
text? If not, it's for the inside fill

Returns:

void


updateTexture(): void

Updates texture size based on canvas size

Returns:

void


renderWebGL(renderer: PIXI.WebGLRenderer): void

Renders the object using the WebGL renderer

Params:

Name Type Attribute Description
renderer

The renderer

Returns:

void


_renderCanvas(renderer: PIXI.CanvasRenderer): void

Renders the object using the Canvas renderer

Params:

Name Type Attribute Description
renderer

The renderer

Returns:

void


wordWrap(text: string): string

Applies newlines to a string to have it optimally fit into the horizontal
bounds set by the Text object's wordWrapWidth property.

Params:

Name Type Attribute Description
text

String to apply word wrapping to

Returns:

string


getLocalBounds(rect: Rectangle): Rectangle

Gets the local bounds of the text object.

Params:

Name Type Attribute Description
rect

The output rectangle.

Returns:

Rectangle


_calculateBounds(): void

calculates the bounds of the Text as a rectangle. The bounds calculation takes the worldTransform into account.

Returns:

void


_onStyleChange(): void

Method to be called upon a TextStyle change.

Returns:

void


_generateFillStyle(style: object, lines: Array.<string>): string, number, CanvasGradient

Generates the fill style. Can automatically generate a gradient based on the fill style being an array

Params:

Name Type Attribute Description
style

The style.

lines

The lines of text.

Returns:

string, number, CanvasGradient


destroy(options: object, boolean): void

Destroys this text object.
Note* Unlike a Sprite, a Text object will automatically destroy its baseTexture and texture as
the majority of the time the texture will not be shared with any other Sprites.

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

Should it destroy the current texture of the sprite as well

options.baseTexture

Should it destroy the base texture of the sprite as well

Returns:

void


width(): void

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

Returns:

void


height(): void

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

Returns:

void


style(): void

Set the style of the text. Set up an event listener to listen for changes on the style
object and mark the text as dirty.

Returns:

void


text(): void

Set the copy for the text object. To split a line you can use '\n'.

Returns:

void


getFontStyle(style: object, TextStyle): string

Generates a font style string to use for Text.calculateFontProperties(). Takes the same parameter
as Text.style.

Params:

Name Type Attribute Description
style

String representing the style of the font

Returns:

string


calculateFontProperties(fontStyle: string): Object

Calculates the ascent, descent and fontSize of a given fontStyle

Params:

Name Type Attribute Description
fontStyle

String representing the style of the font

Returns:

Object


updateText(respectDirty: boolean): void

Renders text and updates it when needed.

Params:

Name Type Attribute Description
respectDirty

Whether to abort updating the text if the Text isn't dirty and the function is called.

Returns:

void


drawLetterSpacing(text: string, x: number, y: number, isStroke: boolean): void

Render the text with letter-spacing.

Params:

Name Type Attribute Description
text

The text to draw

x

Horizontal position to draw the text

y

Vertical position to draw the text

isStroke

Is this drawing for the outside stroke of the
text? If not, it's for the inside fill

Returns:

void


updateTexture(): void

Updates texture size based on canvas size

Returns:

void


renderWebGL(renderer: PIXI.WebGLRenderer): void

Renders the object using the WebGL renderer

Params:

Name Type Attribute Description
renderer

The renderer

Returns:

void


_renderCanvas(renderer: PIXI.CanvasRenderer): void

Renders the object using the Canvas renderer

Params:

Name Type Attribute Description
renderer

The renderer

Returns:

void


wordWrap(text: string): string

Applies newlines to a string to have it optimally fit into the horizontal
bounds set by the Text object's wordWrapWidth property.

Params:

Name Type Attribute Description
text

String to apply word wrapping to

Returns:

string


getLocalBounds(rect: Rectangle): Rectangle

Gets the local bounds of the text object.

Params:

Name Type Attribute Description
rect

The output rectangle.

Returns:

Rectangle


_calculateBounds(): void

calculates the bounds of the Text as a rectangle. The bounds calculation takes the worldTransform into account.

Returns:

void


_onStyleChange(): void

Method to be called upon a TextStyle change.

Returns:

void


_generateFillStyle(style: object, lines: Array.<string>): string, number, CanvasGradient

Generates the fill style. Can automatically generate a gradient based on the fill style being an array

Params:

Name Type Attribute Description
style

The style.

lines

The lines of text.

Returns:

string, number, CanvasGradient


destroy(options: object, boolean): void

Destroys this text object.
Note* Unlike a Sprite, a Text object will automatically destroy its baseTexture and texture as
the majority of the time the texture will not be shared with any other Sprites.

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

Should it destroy the current texture of the sprite as well

options.baseTexture

Should it destroy the base texture of the sprite as well

Returns:

void


width(): void

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

Returns:

void


height(): void

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

Returns:

void


style(): void

Set the style of the text. Set up an event listener to listen for changes on the style
object and mark the text as dirty.

Returns:

void


text(): void

Set the copy for the text object. To split a line you can use '\n'.

Returns:

void


getFontStyle(style: object, TextStyle): string

Generates a font style string to use for Text.calculateFontProperties(). Takes the same parameter
as Text.style.

Params:

Name Type Attribute Description
style

String representing the style of the font

Returns:

string


calculateFontProperties(fontStyle: string): Object

Calculates the ascent, descent and fontSize of a given fontStyle

Params:

Name Type Attribute Description
fontStyle

String representing the style of the font

Returns:

Object


_onTextureUpdate(): void

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

Returns:

void


_onAnchorUpdate(): void

Called when the anchor position updates.

Returns:

void


calculateVertices(): void

calculates worldTransform * vertices, store it in vertexData

Returns:

void


calculateTrimmedVertices(): void

calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData
This is used to ensure that the true width and height of a trimmed texture is respected

Returns:

void


_renderWebGL(renderer: PIXI.WebGLRenderer): void

Renders the object using the WebGL renderer

Params:

Name Type Attribute Description
renderer

The webgl renderer to use.

Returns:

void


containsPoint(point: PIXI.Point): boolean

Tests if a point is inside this sprite

Params:

Name Type Attribute Description
point

the point to test

Returns:

boolean


anchor(): void

The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting the anchor to 0.5,0.5 means the texture's origin is centered
Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

Returns:

void


tint(): void

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

Returns:

void


texture(): void

The texture that the sprite is using

Returns:

void


onChildrenChange(): void

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

Returns:

void


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

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

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

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

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

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

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

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

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>

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

Updates the transform on all children of this container for rendering

Returns:

void


calculateBounds(): void

Recalculates the bounds of the container.

Returns:

void


renderAdvancedWebGL(renderer: PIXI.WebGLRenderer): void

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

Renders the object using the Canvas renderer

Params:

Name Type Attribute Description
renderer

The renderer

Returns:

void


_tempDisplayObjectParent(): void

Returns:

void


_recursivePostUpdateTransform(): void

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

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


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

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

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

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

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

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

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

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

Returns:

void


localTransform(): void

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

Returns:

void


position(): void

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

Returns:

void


scale(): void

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

Returns:

void


pivot(): void

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

Returns:

void


skew(): void

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

Returns:

void


rotation(): void

The rotation of the object in radians.

Returns:

void


worldVisible(): void

Indicates if the object is globally visible.

Returns:

void


mask(): void

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

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 * A Text Object will create a line or multiple lines of text. To split a line you can use '\\n' in your text string,\n * or add a wordWrap property set to true and and wordWrapWidth property with a value in the style object.\n *\n * A Text can be created directly from a string and a style object\n *\n * ```js\n * let text = new PIXI.Text('This is a pixi text',{fontFamily : 'Arial', fontSize: 24, fill : 0xff1010, align : 'center'});\n * ```\n *\n * @class\n * @extends PIXI.Sprite\n * @memberof PIXI\n */",
    "meta": {
        "range": [
            967,
            27853
        ],
        "filename": "Text.js",
        "lineno": 33,
        "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text",
        "code": {
            "id": "astnode100037312",
            "name": "Text",
            "type": "ClassDeclaration",
            "paramnames": [
                "text",
                "style",
                "canvas"
            ]
        }
    },
    "classdesc": "

A Text Object will create a line or multiple lines of text. To split a line you can use '\\n' in your text string,
or add a wordWrap property set to true and and wordWrapWidth property with a value in the style object.

\n

A Text can be created directly from a string and a style object

\n
let text = new PIXI.Text('This is a pixi text',{fontFamily : 'Arial', fontSize: 24, fill : 0xff1010, align : 'center'});
", "kind": "class", "augments": [ "PIXI.Sprite" ], "memberof": "PIXI", "name": "Text", "longname": "PIXI.Text", "scope": "static", "params": [ { "type": { "names": [ "string" ] }, "description": "

The string that you would like the text to display

", "name": "text" }, { "type": { "names": [ "object", "PIXI.TextStyle" ] }, "optional": true, "description": "

The style parameters

", "name": "style" }, { "type": { "names": [ "HTMLCanvasElement" ] }, "optional": true, "description": "

The canvas element for drawing text

", "name": "canvas" } ], "___id": "T000002R003409", "___s": true, "$methods": [ { "comment": "/**\n * Renders text and updates it when needed.\n *\n * @private\n * @param {boolean} respectDirty - Whether to abort updating the text if the Text isn't dirty and the function is called.\n */", "meta": { "range": [ 3231, 8759 ], "filename": "Text.js", "lineno": 117, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100037440", "name": "Text#updateText", "type": "MethodDefinition", "paramnames": [ "respectDirty" ] }, "vars": { "": null } }, "description": "

Renders text and updates it when needed.

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

Whether to abort updating the text if the Text isn't dirty and the function is called.

", "name": "respectDirty" } ], "name": "updateText", "longname": "PIXI.Text#updateText", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "___id": "T000002R003434", "___s": true, "skip": true, "slug": "PIXI.TextupdateText", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Render the text with letter-spacing.\n * @param {string} text - The text to draw\n * @param {number} x - Horizontal position to draw the text\n * @param {number} y - Vertical position to draw the text\n * @param {boolean} [isStroke=false] - Is this drawing for the outside stroke of the\n * text? If not, it's for the inside fill\n * @private\n */", "meta": { "range": [ 9150, 10191 ], "filename": "Text.js", "lineno": 290, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100038196", "name": "Text#drawLetterSpacing", "type": "MethodDefinition", "paramnames": [ "text", "x", "y", "isStroke" ] }, "vars": { "": null } }, "description": "

Render the text with letter-spacing.

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

The text to draw

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

Horizontal position to draw the text

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

Vertical position to draw the text

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

Is this drawing for the outside stroke of the
text? If not, it's for the inside fill

", "name": "isStroke" } ], "access": "private", "name": "drawLetterSpacing", "longname": "PIXI.Text#drawLetterSpacing", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "___id": "T000002R003485", "___s": true, "skip": true, "slug": "PIXI.TextdrawLetterSpacing", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Updates texture size based on canvas size\n *\n * @private\n */", "meta": { "range": [ 10285, 11679 ], "filename": "Text.js", "lineno": 336, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100038325", "name": "Text#updateTexture", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Updates texture size based on canvas size

", "access": "private", "name": "updateTexture", "longname": "PIXI.Text#updateTexture", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "___id": "T000002R003494", "___s": true, "skip": true, "slug": "PIXI.TextupdateTexture", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 11818, 12076 ], "filename": "Text.js", "lineno": 380, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100038589", "name": "Text#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.Text#renderWebGL", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "overrides": "PIXI.Sprite#renderWebGL", "___id": "T000002R003516", "___s": true, "skip": true, "slug": "PIXI.TextrenderWebGL", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 12233, 12495 ], "filename": "Text.js", "lineno": 399, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100038629", "name": "Text#_renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the Canvas renderer

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

The renderer

", "name": "renderer" } ], "name": "_renderCanvas", "longname": "PIXI.Text#_renderCanvas", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "overrides": "PIXI.Sprite#_renderCanvas", "___id": "T000002R003519", "___s": true, "skip": true, "slug": "PIXI.Text_renderCanvas", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Applies newlines to a string to have it optimally fit into the horizontal\n * bounds set by the Text object's wordWrapWidth property.\n *\n * @private\n * @param {string} text - String to apply word wrapping to\n * @return {string} New string with new lines applied where required\n */", "meta": { "range": [ 12820, 15397 ], "filename": "Text.js", "lineno": 420, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100038669", "name": "Text#wordWrap", "type": "MethodDefinition", "paramnames": [ "text" ] }, "vars": { "": null } }, "description": "

Applies newlines to a string to have it optimally fit into the horizontal
bounds set by the Text object's wordWrapWidth property.

", "access": "private", "params": [ { "type": { "names": [ "string" ] }, "description": "

String to apply word wrapping to

", "name": "text" } ], "returns": [ { "type": { "names": [ "string" ] }, "description": "

New string with new lines applied where required

" } ], "name": "wordWrap", "longname": "PIXI.Text#wordWrap", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "___id": "T000002R003522", "___s": true, "skip": true, "slug": "PIXI.TextwordWrap", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Gets the local bounds of the text object.\n *\n * @param {Rectangle} rect - The output rectangle.\n * @return {Rectangle} The bounds.\n */", "meta": { "range": [ 15569, 15687 ], "filename": "Text.js", "lineno": 502, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100038912", "name": "Text#getLocalBounds", "type": "MethodDefinition", "paramnames": [ "rect" ] }, "vars": { "": null } }, "description": "

Gets the local bounds of the text object.

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

The output rectangle.

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

The bounds.

" } ], "name": "getLocalBounds", "longname": "PIXI.Text#getLocalBounds", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "overrides": "PIXI.Sprite#getLocalBounds", "___id": "T000002R003547", "___s": true, "skip": true, "slug": "PIXI.TextgetLocalBounds", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * calculates the bounds of the Text as a rectangle. The bounds calculation takes the worldTransform into account.\n */", "meta": { "range": [ 15828, 16025 ], "filename": "Text.js", "lineno": 512, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100038932", "name": "Text#_calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

calculates the bounds of the Text as a rectangle. The bounds calculation takes the worldTransform into account.

", "name": "_calculateBounds", "longname": "PIXI.Text#_calculateBounds", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "overrides": "PIXI.Sprite#_calculateBounds", "___id": "T000002R003548", "___s": true, "skip": true, "slug": "PIXI.Text_calculateBounds", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Method to be called upon a TextStyle change.\n * @private\n */", "meta": { "range": [ 16115, 16170 ], "filename": "Text.js", "lineno": 524, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100038957", "name": "Text#_onStyleChange", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Method to be called upon a TextStyle change.

", "access": "private", "name": "_onStyleChange", "longname": "PIXI.Text#_onStyleChange", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "___id": "T000002R003549", "___s": true, "skip": true, "slug": "PIXI.Text_onStyleChange", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Generates the fill style. Can automatically generate a gradient based on the fill style being an array\n *\n * @private\n * @param {object} style - The style.\n * @param {string[]} lines - The lines of text.\n * @return {string|number|CanvasGradient} The fill style\n */", "meta": { "range": [ 16480, 20280 ], "filename": "Text.js", "lineno": 537, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100038967", "name": "Text#_generateFillStyle", "type": "MethodDefinition", "paramnames": [ "style", "lines" ] }, "vars": { "": null } }, "description": "

Generates the fill style. Can automatically generate a gradient based on the fill style being an array

", "access": "private", "params": [ { "type": { "names": [ "object" ] }, "description": "

The style.

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

The lines of text.

", "name": "lines" } ], "returns": [ { "type": { "names": [ "string", "number", "CanvasGradient" ] }, "description": "

The fill style

" } ], "name": "_generateFillStyle", "longname": "PIXI.Text#_generateFillStyle", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "___id": "T000002R003551", "___s": true, "skip": true, "slug": "PIXI.Text_generateFillStyle", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Destroys this text object.\n * Note* Unlike a Sprite, a Text object will automatically destroy its baseTexture and texture as\n * the majority of the time the texture will not be shared with any other Sprites.\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\n * destroy method called as well. 'options' will be passed on to those calls.\n * @param {boolean} [options.texture=true] - Should it destroy the current texture of the sprite as well\n * @param {boolean} [options.baseTexture=true] - Should it destroy the base texture of the sprite as well\n */", "meta": { "range": [ 21069, 21494 ], "filename": "Text.js", "lineno": 650, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100039310", "name": "Text#destroy", "type": "MethodDefinition", "paramnames": [ "options" ] }, "vars": { "": null } }, "description": "

Destroys this text object.
Note* Unlike a Sprite, a Text object will automatically destroy its baseTexture and texture as
the majority of the time the texture will not be shared with any other Sprites.

", "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": true, "description": "

Should it destroy the current texture of the sprite as well

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

Should it destroy the base texture of the sprite as well

", "name": "options.baseTexture" } ], "name": "destroy", "longname": "PIXI.Text#destroy", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "overrides": "PIXI.Sprite#destroy", "___id": "T000002R003576", "___s": true, "skip": true, "slug": "PIXI.Textdestroy", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * The width of the Text, setting this will actually modify the scale to achieve the value set\n *\n * @member {number}\n */", "meta": { "range": [ 21646, 21767 ], "filename": "Text.js", "lineno": 673, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100039361", "name": "Text#width", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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

", "kind": "member", "type": { "names": [ "number" ] }, "name": "width", "longname": "PIXI.Text#width", "memberof": "PIXI.Text", "scope": "instance", "params": [], "overrides": "PIXI.Sprite#width", "___id": "T000002R003583", "___s": true, "skip": true, "slug": "PIXI.Textwidth", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * The height of the Text, setting this will actually modify the scale to achieve the value set\n *\n * @member {number}\n */", "meta": { "range": [ 22157, 22280 ], "filename": "Text.js", "lineno": 695, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100039436", "name": "Text#height", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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

", "kind": "member", "type": { "names": [ "number" ] }, "name": "height", "longname": "PIXI.Text#height", "memberof": "PIXI.Text", "scope": "instance", "params": [], "overrides": "PIXI.Sprite#height", "___id": "T000002R003588", "___s": true, "skip": true, "slug": "PIXI.Textheight", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Set the style of the text. Set up an event listener to listen for changes on the style\n * object and mark the text as dirty.\n *\n * @member {object|PIXI.TextStyle}\n */", "meta": { "range": [ 22724, 22775 ], "filename": "Text.js", "lineno": 718, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100039511", "name": "Text#style", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Set the style of the text. Set up an event listener to listen for changes on the style
object and mark the text as dirty.

", "kind": "member", "type": { "names": [ "object", "PIXI.TextStyle" ] }, "name": "style", "longname": "PIXI.Text#style", "memberof": "PIXI.Text", "scope": "instance", "params": [], "___id": "T000002R003593", "___s": true, "skip": true, "slug": "PIXI.Textstyle", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Set the copy for the text object. To split a line you can use '\\n'.\n *\n * @member {string}\n */", "meta": { "range": [ 23238, 23287 ], "filename": "Text.js", "lineno": 745, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100039563", "name": "Text#text", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Set the copy for the text object. To split a line you can use '\\n'.

", "kind": "member", "type": { "names": [ "string" ] }, "name": "text", "longname": "PIXI.Text#text", "memberof": "PIXI.Text", "scope": "instance", "params": [], "___id": "T000002R003600", "___s": true, "skip": true, "slug": "PIXI.Texttext", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Generates a font style string to use for Text.calculateFontProperties(). Takes the same parameter\n * as Text.style.\n *\n * @static\n * @param {object|TextStyle} style - String representing the style of the font\n * @return {string} Font style string, for passing to Text.calculateFontProperties()\n */", "meta": { "range": [ 23915, 25123 ], "filename": "Text.js", "lineno": 770, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100039615", "name": "Text.getFontStyle", "type": "MethodDefinition", "paramnames": [ "style" ] }, "vars": { "": null } }, "description": "

Generates a font style string to use for Text.calculateFontProperties(). Takes the same parameter
as Text.style.

", "scope": "static", "params": [ { "type": { "names": [ "object", "TextStyle" ] }, "description": "

String representing the style of the font

", "name": "style" } ], "returns": [ { "type": { "names": [ "string" ] }, "description": "

Font style string, for passing to Text.calculateFontProperties()

" } ], "name": "getFontStyle", "longname": "PIXI.Text.getFontStyle", "kind": "function", "memberof": "PIXI.Text", "___id": "T000002R003605", "___s": true, "skip": true, "slug": "PIXI.Text.getFontStyle", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Calculates the ascent, descent and fontSize of a given fontStyle\n *\n * @static\n * @param {string} fontStyle - String representing the style of the font\n * @return {Object} Font properties object\n */", "meta": { "range": [ 25363, 27851 ], "filename": "Text.js", "lineno": 814, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100039751", "name": "Text.calculateFontProperties", "type": "MethodDefinition", "paramnames": [ "fontStyle" ] }, "vars": { "": null } }, "description": "

Calculates the ascent, descent and fontSize of a given fontStyle

", "scope": "static", "params": [ { "type": { "names": [ "string" ] }, "description": "

String representing the style of the font

", "name": "fontStyle" } ], "returns": [ { "type": { "names": [ "Object" ] }, "description": "

Font properties object

" } ], "name": "calculateFontProperties", "longname": "PIXI.Text.calculateFontProperties", "kind": "function", "memberof": "PIXI.Text", "___id": "T000002R003615", "___s": true, "skip": true, "slug": "PIXI.Text.calculateFontProperties", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Renders text and updates it when needed.\n *\n * @private\n * @param {boolean} respectDirty - Whether to abort updating the text if the Text isn't dirty and the function is called.\n */", "meta": { "range": [ 3231, 8759 ], "filename": "Text.js", "lineno": 117, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100112119", "name": "Text#updateText", "type": "MethodDefinition", "paramnames": [ "respectDirty" ] }, "vars": { "": null } }, "description": "

Renders text and updates it when needed.

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

Whether to abort updating the text if the Text isn't dirty and the function is called.

", "name": "respectDirty" } ], "name": "updateText", "longname": "PIXI.Text#updateText", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "___id": "T000002R010368", "___s": true, "skip": true, "slug": "PIXI.TextupdateText", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Render the text with letter-spacing.\n * @param {string} text - The text to draw\n * @param {number} x - Horizontal position to draw the text\n * @param {number} y - Vertical position to draw the text\n * @param {boolean} [isStroke=false] - Is this drawing for the outside stroke of the\n * text? If not, it's for the inside fill\n * @private\n */", "meta": { "range": [ 9150, 10191 ], "filename": "Text.js", "lineno": 290, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100112875", "name": "Text#drawLetterSpacing", "type": "MethodDefinition", "paramnames": [ "text", "x", "y", "isStroke" ] }, "vars": { "": null } }, "description": "

Render the text with letter-spacing.

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

The text to draw

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

Horizontal position to draw the text

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

Vertical position to draw the text

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

Is this drawing for the outside stroke of the
text? If not, it's for the inside fill

", "name": "isStroke" } ], "access": "private", "name": "drawLetterSpacing", "longname": "PIXI.Text#drawLetterSpacing", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "___id": "T000002R010419", "___s": true, "skip": true, "slug": "PIXI.TextdrawLetterSpacing", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Updates texture size based on canvas size\n *\n * @private\n */", "meta": { "range": [ 10285, 11679 ], "filename": "Text.js", "lineno": 336, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100113004", "name": "Text#updateTexture", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Updates texture size based on canvas size

", "access": "private", "name": "updateTexture", "longname": "PIXI.Text#updateTexture", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "___id": "T000002R010428", "___s": true, "skip": true, "slug": "PIXI.TextupdateTexture", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 11818, 12076 ], "filename": "Text.js", "lineno": 380, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100113268", "name": "Text#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.Text#renderWebGL", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "overrides": "PIXI.Sprite#renderWebGL", "___id": "T000002R010450", "___s": true, "skip": true, "slug": "PIXI.TextrenderWebGL", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 12233, 12495 ], "filename": "Text.js", "lineno": 399, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100113308", "name": "Text#_renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the Canvas renderer

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

The renderer

", "name": "renderer" } ], "name": "_renderCanvas", "longname": "PIXI.Text#_renderCanvas", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "overrides": "PIXI.Sprite#_renderCanvas", "___id": "T000002R010453", "___s": true, "skip": true, "slug": "PIXI.Text_renderCanvas", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Applies newlines to a string to have it optimally fit into the horizontal\n * bounds set by the Text object's wordWrapWidth property.\n *\n * @private\n * @param {string} text - String to apply word wrapping to\n * @return {string} New string with new lines applied where required\n */", "meta": { "range": [ 12820, 15397 ], "filename": "Text.js", "lineno": 420, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100113348", "name": "Text#wordWrap", "type": "MethodDefinition", "paramnames": [ "text" ] }, "vars": { "": null } }, "description": "

Applies newlines to a string to have it optimally fit into the horizontal
bounds set by the Text object's wordWrapWidth property.

", "access": "private", "params": [ { "type": { "names": [ "string" ] }, "description": "

String to apply word wrapping to

", "name": "text" } ], "returns": [ { "type": { "names": [ "string" ] }, "description": "

New string with new lines applied where required

" } ], "name": "wordWrap", "longname": "PIXI.Text#wordWrap", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "___id": "T000002R010456", "___s": true, "skip": true, "slug": "PIXI.TextwordWrap", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Gets the local bounds of the text object.\n *\n * @param {Rectangle} rect - The output rectangle.\n * @return {Rectangle} The bounds.\n */", "meta": { "range": [ 15569, 15687 ], "filename": "Text.js", "lineno": 502, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100113591", "name": "Text#getLocalBounds", "type": "MethodDefinition", "paramnames": [ "rect" ] }, "vars": { "": null } }, "description": "

Gets the local bounds of the text object.

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

The output rectangle.

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

The bounds.

" } ], "name": "getLocalBounds", "longname": "PIXI.Text#getLocalBounds", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "overrides": "PIXI.Sprite#getLocalBounds", "___id": "T000002R010481", "___s": true, "skip": true, "slug": "PIXI.TextgetLocalBounds", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * calculates the bounds of the Text as a rectangle. The bounds calculation takes the worldTransform into account.\n */", "meta": { "range": [ 15828, 16025 ], "filename": "Text.js", "lineno": 512, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100113611", "name": "Text#_calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

calculates the bounds of the Text as a rectangle. The bounds calculation takes the worldTransform into account.

", "name": "_calculateBounds", "longname": "PIXI.Text#_calculateBounds", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "overrides": "PIXI.Sprite#_calculateBounds", "___id": "T000002R010482", "___s": true, "skip": true, "slug": "PIXI.Text_calculateBounds", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Method to be called upon a TextStyle change.\n * @private\n */", "meta": { "range": [ 16115, 16170 ], "filename": "Text.js", "lineno": 524, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100113636", "name": "Text#_onStyleChange", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Method to be called upon a TextStyle change.

", "access": "private", "name": "_onStyleChange", "longname": "PIXI.Text#_onStyleChange", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "___id": "T000002R010483", "___s": true, "skip": true, "slug": "PIXI.Text_onStyleChange", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Generates the fill style. Can automatically generate a gradient based on the fill style being an array\n *\n * @private\n * @param {object} style - The style.\n * @param {string[]} lines - The lines of text.\n * @return {string|number|CanvasGradient} The fill style\n */", "meta": { "range": [ 16480, 20280 ], "filename": "Text.js", "lineno": 537, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100113646", "name": "Text#_generateFillStyle", "type": "MethodDefinition", "paramnames": [ "style", "lines" ] }, "vars": { "": null } }, "description": "

Generates the fill style. Can automatically generate a gradient based on the fill style being an array

", "access": "private", "params": [ { "type": { "names": [ "object" ] }, "description": "

The style.

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

The lines of text.

", "name": "lines" } ], "returns": [ { "type": { "names": [ "string", "number", "CanvasGradient" ] }, "description": "

The fill style

" } ], "name": "_generateFillStyle", "longname": "PIXI.Text#_generateFillStyle", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "___id": "T000002R010485", "___s": true, "skip": true, "slug": "PIXI.Text_generateFillStyle", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Destroys this text object.\n * Note* Unlike a Sprite, a Text object will automatically destroy its baseTexture and texture as\n * the majority of the time the texture will not be shared with any other Sprites.\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\n * destroy method called as well. 'options' will be passed on to those calls.\n * @param {boolean} [options.texture=true] - Should it destroy the current texture of the sprite as well\n * @param {boolean} [options.baseTexture=true] - Should it destroy the base texture of the sprite as well\n */", "meta": { "range": [ 21069, 21494 ], "filename": "Text.js", "lineno": 650, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100113989", "name": "Text#destroy", "type": "MethodDefinition", "paramnames": [ "options" ] }, "vars": { "": null } }, "description": "

Destroys this text object.
Note* Unlike a Sprite, a Text object will automatically destroy its baseTexture and texture as
the majority of the time the texture will not be shared with any other Sprites.

", "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": true, "description": "

Should it destroy the current texture of the sprite as well

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

Should it destroy the base texture of the sprite as well

", "name": "options.baseTexture" } ], "name": "destroy", "longname": "PIXI.Text#destroy", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "overrides": "PIXI.Sprite#destroy", "___id": "T000002R010510", "___s": true, "skip": true, "slug": "PIXI.Textdestroy", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * The width of the Text, setting this will actually modify the scale to achieve the value set\n *\n * @member {number}\n */", "meta": { "range": [ 21646, 21767 ], "filename": "Text.js", "lineno": 673, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100114040", "name": "Text#width", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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

", "kind": "member", "type": { "names": [ "number" ] }, "name": "width", "longname": "PIXI.Text#width", "memberof": "PIXI.Text", "scope": "instance", "params": [], "overrides": "PIXI.Sprite#width", "___id": "T000002R010517", "___s": true, "skip": true, "slug": "PIXI.Textwidth", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * The height of the Text, setting this will actually modify the scale to achieve the value set\n *\n * @member {number}\n */", "meta": { "range": [ 22157, 22280 ], "filename": "Text.js", "lineno": 695, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100114115", "name": "Text#height", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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

", "kind": "member", "type": { "names": [ "number" ] }, "name": "height", "longname": "PIXI.Text#height", "memberof": "PIXI.Text", "scope": "instance", "params": [], "overrides": "PIXI.Sprite#height", "___id": "T000002R010522", "___s": true, "skip": true, "slug": "PIXI.Textheight", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Set the style of the text. Set up an event listener to listen for changes on the style\n * object and mark the text as dirty.\n *\n * @member {object|PIXI.TextStyle}\n */", "meta": { "range": [ 22724, 22775 ], "filename": "Text.js", "lineno": 718, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100114190", "name": "Text#style", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Set the style of the text. Set up an event listener to listen for changes on the style
object and mark the text as dirty.

", "kind": "member", "type": { "names": [ "object", "PIXI.TextStyle" ] }, "name": "style", "longname": "PIXI.Text#style", "memberof": "PIXI.Text", "scope": "instance", "params": [], "___id": "T000002R010527", "___s": true, "skip": true, "slug": "PIXI.Textstyle", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Set the copy for the text object. To split a line you can use '\\n'.\n *\n * @member {string}\n */", "meta": { "range": [ 23238, 23287 ], "filename": "Text.js", "lineno": 745, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100114242", "name": "Text#text", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Set the copy for the text object. To split a line you can use '\\n'.

", "kind": "member", "type": { "names": [ "string" ] }, "name": "text", "longname": "PIXI.Text#text", "memberof": "PIXI.Text", "scope": "instance", "params": [], "___id": "T000002R010534", "___s": true, "skip": true, "slug": "PIXI.Texttext", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Generates a font style string to use for Text.calculateFontProperties(). Takes the same parameter\n * as Text.style.\n *\n * @static\n * @param {object|TextStyle} style - String representing the style of the font\n * @return {string} Font style string, for passing to Text.calculateFontProperties()\n */", "meta": { "range": [ 23915, 25123 ], "filename": "Text.js", "lineno": 770, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100114294", "name": "Text.getFontStyle", "type": "MethodDefinition", "paramnames": [ "style" ] }, "vars": { "": null } }, "description": "

Generates a font style string to use for Text.calculateFontProperties(). Takes the same parameter
as Text.style.

", "scope": "static", "params": [ { "type": { "names": [ "object", "TextStyle" ] }, "description": "

String representing the style of the font

", "name": "style" } ], "returns": [ { "type": { "names": [ "string" ] }, "description": "

Font style string, for passing to Text.calculateFontProperties()

" } ], "name": "getFontStyle", "longname": "PIXI.Text.getFontStyle", "kind": "function", "memberof": "PIXI.Text", "___id": "T000002R010539", "___s": true, "skip": true, "slug": "PIXI.Text.getFontStyle", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Calculates the ascent, descent and fontSize of a given fontStyle\n *\n * @static\n * @param {string} fontStyle - String representing the style of the font\n * @return {Object} Font properties object\n */", "meta": { "range": [ 25363, 27851 ], "filename": "Text.js", "lineno": 814, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": { "id": "astnode100114430", "name": "Text.calculateFontProperties", "type": "MethodDefinition", "paramnames": [ "fontStyle" ] }, "vars": { "": null } }, "description": "

Calculates the ascent, descent and fontSize of a given fontStyle

", "scope": "static", "params": [ { "type": { "names": [ "string" ] }, "description": "

String representing the style of the font

", "name": "fontStyle" } ], "returns": [ { "type": { "names": [ "Object" ] }, "description": "

Font properties object

" } ], "name": "calculateFontProperties", "longname": "PIXI.Text.calculateFontProperties", "kind": "function", "memberof": "PIXI.Text", "___id": "T000002R010549", "___s": true, "skip": true, "slug": "PIXI.Text.calculateFontProperties", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * When the texture is updated, this event will fire to update the scale and frame\n *\n * @private\n */", "meta": { "range": [ 4163, 4585 ], "filename": "Sprite.js", "lineno": 144, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100033727", "name": "Sprite#_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.Text#_onTextureUpdate", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.Sprite#_onTextureUpdate", "inherited": true, "overrides": "PIXI.Sprite#_onTextureUpdate", "___id": "T000002R014077", "___s": true, "skip": true, "slug": "PIXI.Text_onTextureUpdate", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Called when the anchor position updates.\n *\n * @private\n */", "meta": { "range": [ 4678, 4778 ], "filename": "Sprite.js", "lineno": 166, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100033807", "name": "Sprite#_onAnchorUpdate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Called when the anchor position updates.

", "access": "private", "name": "_onAnchorUpdate", "longname": "PIXI.Text#_onAnchorUpdate", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.Sprite#_onAnchorUpdate", "inherited": true, "overrides": "PIXI.Sprite#_onAnchorUpdate", "___id": "T000002R014078", "___s": true, "skip": true, "slug": "PIXI.Text_onAnchorUpdate", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * calculates worldTransform * vertices, store it in vertexData\n */", "meta": { "range": [ 4868, 6671 ], "filename": "Sprite.js", "lineno": 175, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100033825", "name": "Sprite#calculateVertices", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

calculates worldTransform * vertices, store it in vertexData

", "name": "calculateVertices", "longname": "PIXI.Text#calculateVertices", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.Sprite#calculateVertices", "inherited": true, "overrides": "PIXI.Sprite#calculateVertices", "___id": "T000002R014079", "___s": true, "skip": true, "slug": "PIXI.TextcalculateVertices", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData\n * This is used to ensure that the true width and height of a trimmed texture is respected\n */", "meta": { "range": [ 6893, 8412 ], "filename": "Sprite.js", "lineno": 245, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034159", "name": "Sprite#calculateTrimmedVertices", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData
This is used to ensure that the true width and height of a trimmed texture is respected

", "name": "calculateTrimmedVertices", "longname": "PIXI.Text#calculateTrimmedVertices", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.Sprite#calculateTrimmedVertices", "inherited": true, "overrides": "PIXI.Sprite#calculateTrimmedVertices", "___id": "T000002R014080", "___s": true, "skip": true, "slug": "PIXI.TextcalculateTrimmedVertices", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n *\n * Renders the object using the WebGL renderer\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The webgl renderer to use.\n */", "meta": { "range": [ 8582, 8778 ], "filename": "Sprite.js", "lineno": 304, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034437", "name": "Sprite#_renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the WebGL renderer

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

The webgl renderer to use.

", "name": "renderer" } ], "name": "_renderWebGL", "longname": "PIXI.Text#_renderWebGL", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Sprite#_renderWebGL", "inherited": true, "overrides": "PIXI.Sprite#_renderWebGL", "___id": "T000002R014081", "___s": true, "skip": true, "slug": "PIXI.Text_renderWebGL", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Tests if a point is inside this sprite\n *\n * @param {PIXI.Point} point - the point to test\n * @return {boolean} the result of the test\n */", "meta": { "range": [ 10925, 11444 ], "filename": "Sprite.js", "lineno": 386, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034699", "name": "Sprite#containsPoint", "type": "MethodDefinition", "paramnames": [ "point" ] }, "vars": { "": null } }, "description": "

Tests if a point is inside this sprite

", "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.Text#containsPoint", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Sprite#containsPoint", "inherited": true, "overrides": "PIXI.Sprite#containsPoint", "___id": "T000002R014082", "___s": true, "skip": true, "slug": "PIXI.TextcontainsPoint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The anchor sets the origin point of the texture.\n * The default is 0,0 this means the texture's origin is the top left\n * Setting the anchor to 0.5,0.5 means the texture's origin is centered\n * Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner\n *\n * @member {PIXI.ObservablePoint}\n */", "meta": { "range": [ 15779, 15832 ], "filename": "Sprite.js", "lineno": 532, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100035045", "name": "Sprite#anchor", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting the anchor to 0.5,0.5 means the texture's origin is centered
Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

", "kind": "member", "type": { "names": [ "PIXI.ObservablePoint" ] }, "name": "anchor", "longname": "PIXI.Text#anchor", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.Sprite#anchor", "inherited": true, "overrides": "PIXI.Sprite#anchor", "___id": "T000002R014083", "___s": true, "skip": true, "slug": "PIXI.Textanchor", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The tint applied to the sprite. This is a hex value.\n * A value of 0xFFFFFF will remove any tint effect.\n *\n * @member {number}\n * @default 0xFFFFFF\n */", "meta": { "range": [ 16132, 16181 ], "filename": "Sprite.js", "lineno": 549, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100035066", "name": "Sprite#tint", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The tint applied to the sprite. 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.Text#tint", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.Sprite#tint", "inherited": true, "overrides": "PIXI.Sprite#tint", "___id": "T000002R014084", "___s": true, "skip": true, "slug": "PIXI.Texttint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The texture that the sprite is using\n *\n * @member {PIXI.Texture}\n */", "meta": { "range": [ 16465, 16520 ], "filename": "Sprite.js", "lineno": 565, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100035103", "name": "Sprite#texture", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The texture that the sprite is using

", "kind": "member", "type": { "names": [ "PIXI.Texture" ] }, "name": "texture", "longname": "PIXI.Text#texture", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.Sprite#texture", "inherited": true, "overrides": "PIXI.Sprite#texture", "___id": "T000002R014085", "___s": true, "skip": true, "slug": "PIXI.Texttexture", "filepath": "core\\sprites\\Sprite.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.Text#onChildrenChange", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.Container#onChildrenChange", "inherited": true, "overrides": "PIXI.Sprite#onChildrenChange", "___id": "T000002R014088", "___s": true, "skip": true, "slug": "PIXI.TextonChildrenChange", "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.

\n

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.Text#addChild", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#addChild", "inherited": true, "overrides": "PIXI.Sprite#addChild", "___id": "T000002R014089", "___s": true, "skip": true, "slug": "PIXI.TextaddChild", "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.Text#addChildAt", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#addChildAt", "inherited": true, "overrides": "PIXI.Sprite#addChildAt", "___id": "T000002R014090", "___s": true, "skip": true, "slug": "PIXI.TextaddChildAt", "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.Text#swapChildren", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#swapChildren", "inherited": true, "overrides": "PIXI.Sprite#swapChildren", "___id": "T000002R014091", "___s": true, "skip": true, "slug": "PIXI.TextswapChildren", "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.Text#getChildIndex", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#getChildIndex", "inherited": true, "overrides": "PIXI.Sprite#getChildIndex", "___id": "T000002R014092", "___s": true, "skip": true, "slug": "PIXI.TextgetChildIndex", "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.Text#setChildIndex", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#setChildIndex", "inherited": true, "overrides": "PIXI.Sprite#setChildIndex", "___id": "T000002R014093", "___s": true, "skip": true, "slug": "PIXI.TextsetChildIndex", "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.Text#getChildAt", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#getChildAt", "inherited": true, "overrides": "PIXI.Sprite#getChildAt", "___id": "T000002R014094", "___s": true, "skip": true, "slug": "PIXI.TextgetChildAt", "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.Text#removeChild", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#removeChild", "inherited": true, "overrides": "PIXI.Sprite#removeChild", "___id": "T000002R014095", "___s": true, "skip": true, "slug": "PIXI.TextremoveChild", "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.Text#removeChildAt", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#removeChildAt", "inherited": true, "overrides": "PIXI.Sprite#removeChildAt", "___id": "T000002R014096", "___s": true, "skip": true, "slug": "PIXI.TextremoveChildAt", "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.Text#removeChildren", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#removeChildren", "inherited": true, "overrides": "PIXI.Sprite#removeChildren", "___id": "T000002R014097", "___s": true, "skip": true, "slug": "PIXI.TextremoveChildren", "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.Text#updateTransform", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.Container#updateTransform", "inherited": true, "overrides": "PIXI.Sprite#updateTransform", "___id": "T000002R014098", "___s": true, "skip": true, "slug": "PIXI.TextupdateTransform", "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.Text#calculateBounds", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.Container#calculateBounds", "inherited": true, "overrides": "PIXI.Sprite#calculateBounds", "___id": "T000002R014099", "___s": true, "skip": true, "slug": "PIXI.TextcalculateBounds", "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.Text#renderAdvancedWebGL", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#renderAdvancedWebGL", "inherited": true, "overrides": "PIXI.Sprite#renderAdvancedWebGL", "___id": "T000002R014100", "___s": true, "skip": true, "slug": "PIXI.TextrenderAdvancedWebGL", "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.Text#renderCanvas", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.Container#renderCanvas", "inherited": true, "overrides": "PIXI.Sprite#renderCanvas", "___id": "T000002R014101", "___s": true, "skip": true, "slug": "PIXI.TextrenderCanvas", "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.Text#_tempDisplayObjectParent", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#_tempDisplayObjectParent", "inherited": true, "overrides": "PIXI.Sprite#_tempDisplayObjectParent", "___id": "T000002R014112", "___s": true, "skip": true, "slug": "PIXI.Text_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.Text#_recursivePostUpdateTransform", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#_recursivePostUpdateTransform", "inherited": true, "overrides": "PIXI.Sprite#_recursivePostUpdateTransform", "___id": "T000002R014113", "___s": true, "skip": true, "slug": "PIXI.Text_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.Text#getBounds", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.DisplayObject#getBounds", "inherited": true, "overrides": "PIXI.Sprite#getBounds", "___id": "T000002R014114", "___s": true, "skip": true, "slug": "PIXI.TextgetBounds", "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.Text#toGlobal", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.DisplayObject#toGlobal", "inherited": true, "overrides": "PIXI.Sprite#toGlobal", "___id": "T000002R014115", "___s": true, "skip": true, "slug": "PIXI.TexttoGlobal", "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.Text#toLocal", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.DisplayObject#toLocal", "inherited": true, "overrides": "PIXI.Sprite#toLocal", "___id": "T000002R014116", "___s": true, "skip": true, "slug": "PIXI.TexttoLocal", "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.Text#setParent", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.DisplayObject#setParent", "inherited": true, "overrides": "PIXI.Sprite#setParent", "___id": "T000002R014117", "___s": true, "skip": true, "slug": "PIXI.TextsetParent", "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.Text#setTransform", "kind": "function", "memberof": "PIXI.Text", "scope": "instance", "inherits": "PIXI.DisplayObject#setTransform", "inherited": true, "overrides": "PIXI.Sprite#setTransform", "___id": "T000002R014118", "___s": true, "skip": true, "slug": "PIXI.TextsetTransform", "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.Text#x", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#x", "inherited": true, "overrides": "PIXI.Sprite#x", "___id": "T000002R014119", "___s": true, "skip": true, "slug": "PIXI.Textx", "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.Text#y", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#y", "inherited": true, "overrides": "PIXI.Sprite#y", "___id": "T000002R014120", "___s": true, "skip": true, "slug": "PIXI.Texty", "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.Text#worldTransform", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#worldTransform", "inherited": true, "overrides": "PIXI.Sprite#worldTransform", "___id": "T000002R014121", "___s": true, "skip": true, "slug": "PIXI.TextworldTransform", "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.Text#localTransform", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#localTransform", "inherited": true, "overrides": "PIXI.Sprite#localTransform", "___id": "T000002R014122", "___s": true, "skip": true, "slug": "PIXI.TextlocalTransform", "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.Text#position", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#position", "inherited": true, "overrides": "PIXI.Sprite#position", "___id": "T000002R014123", "___s": true, "skip": true, "slug": "PIXI.Textposition", "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.Text#scale", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#scale", "inherited": true, "overrides": "PIXI.Sprite#scale", "___id": "T000002R014124", "___s": true, "skip": true, "slug": "PIXI.Textscale", "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.Text#pivot", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#pivot", "inherited": true, "overrides": "PIXI.Sprite#pivot", "___id": "T000002R014125", "___s": true, "skip": true, "slug": "PIXI.Textpivot", "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.Text#skew", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#skew", "inherited": true, "overrides": "PIXI.Sprite#skew", "___id": "T000002R014126", "___s": true, "skip": true, "slug": "PIXI.Textskew", "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.Text#rotation", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#rotation", "inherited": true, "overrides": "PIXI.Sprite#rotation", "___id": "T000002R014127", "___s": true, "skip": true, "slug": "PIXI.Textrotation", "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.Text#worldVisible", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#worldVisible", "inherited": true, "overrides": "PIXI.Sprite#worldVisible", "___id": "T000002R014128", "___s": true, "skip": true, "slug": "PIXI.TextworldVisible", "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": "

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.

", "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.Text#mask", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#mask", "inherited": true, "overrides": "PIXI.Sprite#mask", "___id": "T000002R014129", "___s": true, "skip": true, "slug": "PIXI.Textmask", "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.

\n
    \n
  • IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
    To remove filters simply set this property to 'null'
  • \n
", "kind": "member", "type": { "names": [ "Array." ] }, "name": "filters", "longname": "PIXI.Text#filters", "memberof": "PIXI.Text", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#filters", "inherited": true, "overrides": "PIXI.Sprite#filters", "___id": "T000002R014130", "___s": true, "skip": true, "slug": "PIXI.Textfilters", "filepath": "core\\display\\DisplayObject.js" } ], "$attributes": [ { "comment": "/**\n * The canvas element that everything is drawn to\n *\n * @member {HTMLCanvasElement} PIXI.Text#canvas\n */", "meta": { "range": [ 1568, 1708 ], "filename": "Text.js", "lineno": 54, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

The canvas element that everything is drawn to

", "kind": "member", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#canvas", "scope": "instance", "___id": "T000002R003417", "___s": true, "skip": true, "slug": "PIXI.Textcanvas", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * The canvas 2d context that everything is drawn with\n * @member {CanvasRenderingContext2D} PIXI.Text#context\n */", "meta": { "range": [ 1748, 1890 ], "filename": "Text.js", "lineno": 61, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

The canvas 2d context that everything is drawn with

", "kind": "member", "name": "context", "type": { "names": [ "CanvasRenderingContext2D" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#context", "scope": "instance", "___id": "T000002R003419", "___s": true, "skip": true, "slug": "PIXI.Textcontext", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * The resolution / device pixel ratio of the canvas. This is set automatically by the renderer.\n * @member {number} PIXI.Text#resolution\n * @default 1\n */", "meta": { "range": [ 1953, 2144 ], "filename": "Text.js", "lineno": 67, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

The resolution / device pixel ratio of the canvas. This is set automatically by the renderer.

", "kind": "member", "name": "resolution", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.Text", "longname": "PIXI.Text#resolution", "scope": "instance", "___id": "T000002R003421", "___s": true, "skip": true, "slug": "PIXI.Textresolution", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Private tracker for the current text.\n *\n * @member {string} PIXI.Text#_text\n * @private\n */", "meta": { "range": [ 2201, 2340 ], "filename": "Text.js", "lineno": 74, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

Private tracker for the current text.

", "kind": "member", "name": "_text", "type": { "names": [ "string" ] }, "access": "private", "memberof": "PIXI.Text", "longname": "PIXI.Text#_text", "scope": "instance", "___id": "T000002R003423", "___s": true, "skip": true, "slug": "PIXI.Text_text", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Private tracker for the current style.\n *\n * @member {object} PIXI.Text#_style\n * @private\n */", "meta": { "range": [ 2377, 2518 ], "filename": "Text.js", "lineno": 82, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

Private tracker for the current style.

", "kind": "member", "name": "_style", "type": { "names": [ "object" ] }, "access": "private", "memberof": "PIXI.Text", "longname": "PIXI.Text#_style", "scope": "instance", "___id": "T000002R003425", "___s": true, "skip": true, "slug": "PIXI.Text_style", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Private listener to track style changes.\n *\n * @member {Function} PIXI.Text#_styleListener\n * @private\n */", "meta": { "range": [ 2555, 2708 ], "filename": "Text.js", "lineno": 89, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

Private listener to track style changes.

", "kind": "member", "name": "_styleListener", "type": { "names": [ "function" ] }, "access": "private", "memberof": "PIXI.Text", "longname": "PIXI.Text#_styleListener", "scope": "instance", "___id": "T000002R003427", "___s": true, "skip": true, "slug": "PIXI.Text_styleListener", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Private tracker for the current font.\n *\n * @member {string} PIXI.Text#_font\n * @private\n */", "meta": { "range": [ 2754, 2893 ], "filename": "Text.js", "lineno": 97, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

Private tracker for the current font.

", "kind": "member", "name": "_font", "type": { "names": [ "string" ] }, "access": "private", "memberof": "PIXI.Text", "longname": "PIXI.Text#_font", "scope": "instance", "___id": "T000002R003429", "___s": true, "skip": true, "slug": "PIXI.Text_font", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * @method\n * @name PIXI.Text#setText\n * @see PIXI.Text#text\n * @deprecated since version 3.0.0\n * @param {string} text - The text to set to.\n */", "meta": { "range": [ 17632, 17781 ], "filename": "deprecation.js", "lineno": 684, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "kind": "function", "name": "setText", "see": [ "PIXI.Text#text" ], "deprecated": "since version 3.0.0", "params": [ { "type": { "names": [ "string" ] }, "description": "

The text to set to.

", "name": "text" } ], "memberof": "PIXI.Text", "longname": "PIXI.Text#setText", "scope": "instance", "___id": "T000002R004651", "___s": true, "skip": true, "slug": "PIXI.TextsetText", "filepath": "deprecation.js" }, { "comment": "/**\n * @method\n * @name PIXI.Text#setStyle\n * @see PIXI.Text#style\n * @deprecated since version 3.0.0\n * @param {*} style - The style to set to.\n */", "meta": { "range": [ 17964, 18112 ], "filename": "deprecation.js", "lineno": 697, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "kind": "function", "name": "setStyle", "see": [ "PIXI.Text#style" ], "deprecated": "since version 3.0.0", "params": [ { "type": { "names": [ "*" ] }, "description": "

The style to set to.

", "name": "style" } ], "memberof": "PIXI.Text", "longname": "PIXI.Text#setStyle", "scope": "instance", "___id": "T000002R004654", "___s": true, "skip": true, "slug": "PIXI.TextsetStyle", "filepath": "deprecation.js" }, { "comment": "/**\n * @method\n * @name PIXI.Text#determineFontProperties\n * @see PIXI.Text#calculateFontProperties\n * @deprecated since version 4.2.0\n * @private\n * @param {string} fontStyle - String representing the style of the font\n * @return {Object} Font properties object\n */", "meta": { "range": [ 18299, 18565 ], "filename": "deprecation.js", "lineno": 710, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "kind": "function", "name": "determineFontProperties", "see": [ "PIXI.Text#calculateFontProperties" ], "deprecated": "since version 4.2.0", "access": "private", "params": [ { "type": { "names": [ "string" ] }, "description": "

String representing the style of the font

", "name": "fontStyle" } ], "returns": [ { "type": { "names": [ "Object" ] }, "description": "

Font properties object

" } ], "memberof": "PIXI.Text", "longname": "PIXI.Text#determineFontProperties", "scope": "instance", "___id": "T000002R004657", "___s": true, "skip": true, "slug": "PIXI.TextdetermineFontProperties", "filepath": "deprecation.js" }, { "comment": "/**\n * The canvas element that everything is drawn to\n *\n * @member {HTMLCanvasElement} PIXI.Text#canvas\n */", "meta": { "range": [ 1568, 1708 ], "filename": "Text.js", "lineno": 54, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

The canvas element that everything is drawn to

", "kind": "member", "name": "canvas", "type": { "names": [ "HTMLCanvasElement" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#canvas", "scope": "instance", "___id": "T000002R010351", "___s": true, "skip": true, "slug": "PIXI.Textcanvas", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * The canvas 2d context that everything is drawn with\n * @member {CanvasRenderingContext2D} PIXI.Text#context\n */", "meta": { "range": [ 1748, 1890 ], "filename": "Text.js", "lineno": 61, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

The canvas 2d context that everything is drawn with

", "kind": "member", "name": "context", "type": { "names": [ "CanvasRenderingContext2D" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#context", "scope": "instance", "___id": "T000002R010353", "___s": true, "skip": true, "slug": "PIXI.Textcontext", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * The resolution / device pixel ratio of the canvas. This is set automatically by the renderer.\n * @member {number} PIXI.Text#resolution\n * @default 1\n */", "meta": { "range": [ 1953, 2144 ], "filename": "Text.js", "lineno": 67, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

The resolution / device pixel ratio of the canvas. This is set automatically by the renderer.

", "kind": "member", "name": "resolution", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.Text", "longname": "PIXI.Text#resolution", "scope": "instance", "___id": "T000002R010355", "___s": true, "skip": true, "slug": "PIXI.Textresolution", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Private tracker for the current text.\n *\n * @member {string} PIXI.Text#_text\n * @private\n */", "meta": { "range": [ 2201, 2340 ], "filename": "Text.js", "lineno": 74, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

Private tracker for the current text.

", "kind": "member", "name": "_text", "type": { "names": [ "string" ] }, "access": "private", "memberof": "PIXI.Text", "longname": "PIXI.Text#_text", "scope": "instance", "___id": "T000002R010357", "___s": true, "skip": true, "slug": "PIXI.Text_text", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Private tracker for the current style.\n *\n * @member {object} PIXI.Text#_style\n * @private\n */", "meta": { "range": [ 2377, 2518 ], "filename": "Text.js", "lineno": 82, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

Private tracker for the current style.

", "kind": "member", "name": "_style", "type": { "names": [ "object" ] }, "access": "private", "memberof": "PIXI.Text", "longname": "PIXI.Text#_style", "scope": "instance", "___id": "T000002R010359", "___s": true, "skip": true, "slug": "PIXI.Text_style", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Private listener to track style changes.\n *\n * @member {Function} PIXI.Text#_styleListener\n * @private\n */", "meta": { "range": [ 2555, 2708 ], "filename": "Text.js", "lineno": 89, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

Private listener to track style changes.

", "kind": "member", "name": "_styleListener", "type": { "names": [ "function" ] }, "access": "private", "memberof": "PIXI.Text", "longname": "PIXI.Text#_styleListener", "scope": "instance", "___id": "T000002R010361", "___s": true, "skip": true, "slug": "PIXI.Text_styleListener", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * Private tracker for the current font.\n *\n * @member {string} PIXI.Text#_font\n * @private\n */", "meta": { "range": [ 2754, 2893 ], "filename": "Text.js", "lineno": 97, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\text", "code": {} }, "description": "

Private tracker for the current font.

", "kind": "member", "name": "_font", "type": { "names": [ "string" ] }, "access": "private", "memberof": "PIXI.Text", "longname": "PIXI.Text#_font", "scope": "instance", "___id": "T000002R010363", "___s": true, "skip": true, "slug": "PIXI.Text_font", "filepath": "core\\text\\Text.js" }, { "comment": "/**\n * @method\n * @name PIXI.Text#setText\n * @see PIXI.Text#text\n * @deprecated since version 3.0.0\n * @param {string} text - The text to set to.\n */", "meta": { "range": [ 17632, 17781 ], "filename": "deprecation.js", "lineno": 684, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "kind": "function", "name": "setText", "see": [ "PIXI.Text#text" ], "deprecated": "since version 3.0.0", "params": [ { "type": { "names": [ "string" ] }, "description": "

The text to set to.

", "name": "text" } ], "memberof": "PIXI.Text", "longname": "PIXI.Text#setText", "scope": "instance", "___id": "T000002R011585", "___s": true, "skip": true, "slug": "PIXI.TextsetText", "filepath": "deprecation.js" }, { "comment": "/**\n * @method\n * @name PIXI.Text#setStyle\n * @see PIXI.Text#style\n * @deprecated since version 3.0.0\n * @param {*} style - The style to set to.\n */", "meta": { "range": [ 17964, 18112 ], "filename": "deprecation.js", "lineno": 697, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "kind": "function", "name": "setStyle", "see": [ "PIXI.Text#style" ], "deprecated": "since version 3.0.0", "params": [ { "type": { "names": [ "*" ] }, "description": "

The style to set to.

", "name": "style" } ], "memberof": "PIXI.Text", "longname": "PIXI.Text#setStyle", "scope": "instance", "___id": "T000002R011588", "___s": true, "skip": true, "slug": "PIXI.TextsetStyle", "filepath": "deprecation.js" }, { "comment": "/**\n * @method\n * @name PIXI.Text#determineFontProperties\n * @see PIXI.Text#calculateFontProperties\n * @deprecated since version 4.2.0\n * @private\n * @param {string} fontStyle - String representing the style of the font\n * @return {Object} Font properties object\n */", "meta": { "range": [ 18299, 18565 ], "filename": "deprecation.js", "lineno": 710, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "kind": "function", "name": "determineFontProperties", "see": [ "PIXI.Text#calculateFontProperties" ], "deprecated": "since version 4.2.0", "access": "private", "params": [ { "type": { "names": [ "string" ] }, "description": "

String representing the style of the font

", "name": "fontStyle" } ], "returns": [ { "type": { "names": [ "Object" ] }, "description": "

Font properties object

" } ], "memberof": "PIXI.Text", "longname": "PIXI.Text#determineFontProperties", "scope": "instance", "___id": "T000002R011591", "___s": true, "skip": true, "slug": "PIXI.TextdetermineFontProperties", "filepath": "deprecation.js" }, { "comment": "/**\n * The anchor sets the origin point of the texture.\n * The default is 0,0 this means the texture's origin is the top left\n * Setting the anchor to 0.5,0.5 means the texture's origin is centered\n * Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner\n *\n * @member {PIXI.ObservablePoint} PIXI.Sprite#_anchor\n * @private\n */", "meta": { "range": [ 769, 1202 ], "filename": "Sprite.js", "lineno": 33, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting the anchor to 0.5,0.5 means the texture's origin is centered
Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

", "kind": "member", "name": "_anchor", "type": { "names": [ "PIXI.ObservablePoint" ] }, "access": "private", "memberof": "PIXI.Text", "longname": "PIXI.Text#_anchor", "scope": "instance", "inherits": "PIXI.Sprite#_anchor", "inherited": true, "overrides": "PIXI.Sprite#_anchor", "___id": "T000002R014066", "___s": true, "skip": true, "slug": "PIXI.Text_anchor", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The texture that the sprite is using\n *\n * @private\n * @member {PIXI.Texture} PIXI.Sprite#_texture\n */", "meta": { "range": [ 1284, 1433 ], "filename": "Sprite.js", "lineno": 44, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The texture that the sprite is using

", "access": "private", "kind": "member", "name": "_texture", "type": { "names": [ "PIXI.Texture" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#_texture", "scope": "instance", "inherits": "PIXI.Sprite#_texture", "inherited": true, "overrides": "PIXI.Sprite#_texture", "___id": "T000002R014067", "___s": true, "skip": true, "slug": "PIXI.Text_texture", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The width of the sprite (this is initially set by the texture)\n *\n * @private\n * @member {number} PIXI.Sprite#_width\n */", "meta": { "range": [ 1473, 1640 ], "filename": "Sprite.js", "lineno": 52, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The width of the sprite (this is initially set by the texture)

", "access": "private", "kind": "member", "name": "_width", "type": { "names": [ "number" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#_width", "scope": "instance", "inherits": "PIXI.Sprite#_width", "inherited": true, "overrides": "PIXI.Sprite#_width", "___id": "T000002R014068", "___s": true, "skip": true, "slug": "PIXI.Text_width", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The height of the sprite (this is initially set by the texture)\n *\n * @private\n * @member {number} PIXI.Sprite#_height\n */", "meta": { "range": [ 1675, 1844 ], "filename": "Sprite.js", "lineno": 60, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The height of the sprite (this is initially set by the texture)

", "access": "private", "kind": "member", "name": "_height", "type": { "names": [ "number" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#_height", "scope": "instance", "inherits": "PIXI.Sprite#_height", "inherited": true, "overrides": "PIXI.Sprite#_height", "___id": "T000002R014069", "___s": true, "skip": true, "slug": "PIXI.Text_height", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.\n *\n * @private\n * @member {number} PIXI.Sprite#_tint\n * @default 0xFFFFFF\n */", "meta": { "range": [ 1880, 2114 ], "filename": "Sprite.js", "lineno": 68, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

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

", "access": "private", "kind": "member", "name": "_tint", "type": { "names": [ "number" ] }, "defaultvalue": "0xFFFFFF", "memberof": "PIXI.Text", "longname": "PIXI.Text#_tint", "scope": "instance", "inherits": "PIXI.Sprite#_tint", "inherited": true, "overrides": "PIXI.Sprite#_tint", "___id": "T000002R014070", "___s": true, "skip": true, "slug": "PIXI.Text_tint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The blend mode to be applied to the sprite. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode.\n *\n * @member {number} PIXI.Sprite#blendMode\n * @default PIXI.BLEND_MODES.NORMAL\n * @see PIXI.BLEND_MODES\n */", "meta": { "range": [ 2211, 2487 ], "filename": "Sprite.js", "lineno": 79, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

", "kind": "member", "name": "blendMode", "type": { "names": [ "number" ] }, "defaultvalue": "PIXI.BLEND_MODES.NORMAL", "see": [ "PIXI.BLEND_MODES" ], "memberof": "PIXI.Text", "longname": "PIXI.Text#blendMode", "scope": "instance", "inherits": "PIXI.Sprite#blendMode", "inherited": true, "overrides": "PIXI.Sprite#blendMode", "___id": "T000002R014071", "___s": true, "skip": true, "slug": "PIXI.TextblendMode", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The shader that will be used to render the sprite. Set to null to remove a current shader.\n *\n * @member {PIXI.Filter|PIXI.Shader} PIXI.Sprite#shader\n */", "meta": { "range": [ 2542, 2734 ], "filename": "Sprite.js", "lineno": 88, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The shader that will be used to render the sprite. Set to null to remove a current shader.

", "kind": "member", "name": "shader", "type": { "names": [ "PIXI.Filter", "PIXI.Shader" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#shader", "scope": "instance", "inherits": "PIXI.Sprite#shader", "inherited": true, "overrides": "PIXI.Sprite#shader", "___id": "T000002R014072", "___s": true, "skip": true, "slug": "PIXI.Textshader", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * An internal cached value of the tint.\n *\n * @private\n * @member {number} PIXI.Sprite#cachedTint\n * @default 0xFFFFFF\n */", "meta": { "range": [ 2772, 2947 ], "filename": "Sprite.js", "lineno": 95, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

An internal cached value of the tint.

", "access": "private", "kind": "member", "name": "cachedTint", "type": { "names": [ "number" ] }, "defaultvalue": "0xFFFFFF", "memberof": "PIXI.Text", "longname": "PIXI.Text#cachedTint", "scope": "instance", "inherits": "PIXI.Sprite#cachedTint", "inherited": true, "overrides": "PIXI.Sprite#cachedTint", "___id": "T000002R014073", "___s": true, "skip": true, "slug": "PIXI.TextcachedTint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * this is used to store the vertex data of the sprite (basically a quad)\n *\n * @private\n * @member {Float32Array} PIXI.Sprite#vertexData\n */", "meta": { "range": [ 3074, 3259 ], "filename": "Sprite.js", "lineno": 107, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

this is used to store the vertex data of the sprite (basically a quad)

", "access": "private", "kind": "member", "name": "vertexData", "type": { "names": [ "Float32Array" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#vertexData", "scope": "instance", "inherits": "PIXI.Sprite#vertexData", "inherited": true, "overrides": "PIXI.Sprite#vertexData", "___id": "T000002R014074", "___s": true, "skip": true, "slug": "PIXI.TextvertexData", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * This is used to calculate the bounds of the object IF it is a trimmed sprite\n *\n * @private\n * @member {Float32Array} PIXI.Sprite#vertexTrimmedData\n */", "meta": { "range": [ 3316, 3514 ], "filename": "Sprite.js", "lineno": 115, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

This is used to calculate the bounds of the object IF it is a trimmed sprite

", "access": "private", "kind": "member", "name": "vertexTrimmedData", "type": { "names": [ "Float32Array" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#vertexTrimmedData", "scope": "instance", "inherits": "PIXI.Sprite#vertexTrimmedData", "inherited": true, "overrides": "PIXI.Sprite#vertexTrimmedData", "___id": "T000002R014075", "___s": true, "skip": true, "slug": "PIXI.TextvertexTrimmedData", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Plugin that is responsible for rendering this element.\n * Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.\n *\n * @member {string} PIXI.Sprite#pluginName\n * @default 'sprite'\n */", "meta": { "range": [ 3703, 3989 ], "filename": "Sprite.js", "lineno": 129, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "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": "'sprite'", "memberof": "PIXI.Text", "longname": "PIXI.Text#pluginName", "scope": "instance", "inherits": "PIXI.Sprite#pluginName", "inherited": true, "overrides": "PIXI.Sprite#pluginName", "___id": "T000002R014076", "___s": true, "skip": true, "slug": "PIXI.TextpluginName", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * @method\n * @private\n * @name PIXI.Sprite#setTexture\n * @see PIXI.Sprite#texture\n * @deprecated since version 3.0.0\n * @param {PIXI.Texture} texture - The texture to set to.\n */", "meta": { "range": [ 16870, 17053 ], "filename": "deprecation.js", "lineno": 657, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "kind": "function", "access": "private", "name": "setTexture", "see": [ "PIXI.Sprite#texture" ], "deprecated": "since version 3.0.0", "params": [ { "type": { "names": [ "PIXI.Texture" ] }, "description": "

The texture to set to.

", "name": "texture" } ], "memberof": "PIXI.Text", "longname": "PIXI.Text#setTexture", "scope": "instance", "inherits": "PIXI.Sprite#setTexture", "inherited": true, "overrides": "PIXI.Sprite#setTexture", "___id": "T000002R014086", "___s": true, "skip": true, "slug": "PIXI.TextsetTexture", "filepath": "deprecation.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.Text", "longname": "PIXI.Text#children", "scope": "instance", "inherits": "PIXI.Container#children", "inherited": true, "overrides": "PIXI.Sprite#children", "___id": "T000002R014087", "___s": true, "skip": true, "slug": "PIXI.Textchildren", "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.Text", "longname": "PIXI.Text#transform", "scope": "instance", "inherits": "PIXI.DisplayObject#transform", "inherited": true, "overrides": "PIXI.Sprite#transform", "___id": "T000002R014102", "___s": true, "skip": true, "slug": "PIXI.Texttransform", "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.Text", "longname": "PIXI.Text#alpha", "scope": "instance", "inherits": "PIXI.DisplayObject#alpha", "inherited": true, "overrides": "PIXI.Sprite#alpha", "___id": "T000002R014103", "___s": true, "skip": true, "slug": "PIXI.Textalpha", "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.

\n

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

", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#visible", "scope": "instance", "inherits": "PIXI.DisplayObject#visible", "inherited": true, "overrides": "PIXI.Sprite#visible", "___id": "T000002R014104", "___s": true, "skip": true, "slug": "PIXI.Textvisible", "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.

\n

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

", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#renderable", "scope": "instance", "inherits": "PIXI.DisplayObject#renderable", "inherited": true, "overrides": "PIXI.Sprite#renderable", "___id": "T000002R014105", "___s": true, "skip": true, "slug": "PIXI.Textrenderable", "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.Text", "longname": "PIXI.Text#parent", "scope": "instance", "inherits": "PIXI.DisplayObject#parent", "inherited": true, "overrides": "PIXI.Sprite#parent", "___id": "T000002R014106", "___s": true, "skip": true, "slug": "PIXI.Textparent", "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.Text", "longname": "PIXI.Text#worldAlpha", "scope": "instance", "inherits": "PIXI.DisplayObject#worldAlpha", "inherited": true, "overrides": "PIXI.Sprite#worldAlpha", "___id": "T000002R014107", "___s": true, "skip": true, "slug": "PIXI.TextworldAlpha", "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

\n

Also works as an interaction mask

", "kind": "member", "name": "filterArea", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.Text", "longname": "PIXI.Text#filterArea", "scope": "instance", "inherits": "PIXI.DisplayObject#filterArea", "inherited": true, "overrides": "PIXI.Sprite#filterArea", "___id": "T000002R014108", "___s": true, "skip": true, "slug": "PIXI.TextfilterArea", "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.Text", "longname": "PIXI.Text#_bounds", "scope": "instance", "inherits": "PIXI.DisplayObject#_bounds", "inherited": true, "overrides": "PIXI.Sprite#_bounds", "___id": "T000002R014109", "___s": true, "skip": true, "slug": "PIXI.Text_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.Text", "longname": "PIXI.Text#_mask", "scope": "instance", "inherits": "PIXI.DisplayObject#_mask", "inherited": true, "overrides": "PIXI.Sprite#_mask", "___id": "T000002R014110", "___s": true, "skip": true, "slug": "PIXI.Text_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.Text", "longname": "PIXI.Text#_destroyed", "scope": "instance", "inherits": "PIXI.DisplayObject#_destroyed", "inherited": true, "overrides": "PIXI.Sprite#_destroyed", "___id": "T000002R014111", "___s": true, "skip": true, "slug": "PIXI.Text_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'

\n

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.Text", "name": "cacheAsBitmap", "longname": "PIXI.Text#cacheAsBitmap", "scope": "instance", "inherits": "PIXI.DisplayObject#cacheAsBitmap", "inherited": true, "overrides": "PIXI.Sprite#cacheAsBitmap", "___id": "T000002R014131", "___s": true, "skip": true, "slug": "PIXI.TextcacheAsBitmap", "filepath": "extras\\cacheAsBitmap.js" } ], "$staticmethods": [], "$staticproperties": [], "$augments": [ { "comment": "/**\n * The Sprite object is the base for all textured objects that are rendered to the screen\n *\n * A sprite can be created directly from an image like this:\n *\n * ```js\n * let sprite = new PIXI.Sprite.fromImage('assets/image.png');\n * ```\n *\n * @class\n * @extends PIXI.Container\n * @memberof PIXI\n */", "meta": { "range": [ 596, 17118 ], "filename": "Sprite.js", "lineno": 24, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100033590", "name": "Sprite", "type": "ClassDeclaration", "paramnames": [ "texture" ] } }, "classdesc": "

The Sprite object is the base for all textured objects that are rendered to the screen

\n

A sprite can be created directly from an image like this:

\n
let sprite = new PIXI.Sprite.fromImage('assets/image.png');
", "kind": "class", "augments": [ "PIXI.Container" ], "memberof": "PIXI", "name": "Sprite", "longname": "PIXI.Sprite", "scope": "static", "params": [ { "type": { "names": [ "PIXI.Texture" ] }, "description": "

The texture for this sprite

", "name": "texture" } ], "___id": "T000002R003053", "___s": true, "$methods": [ { "comment": "/**\n * When the texture is updated, this event will fire to update the scale and frame\n *\n * @private\n */", "meta": { "range": [ 4163, 4585 ], "filename": "Sprite.js", "lineno": 144, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100033727", "name": "Sprite#_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.Sprite#_onTextureUpdate", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R003084", "___s": true, "skip": true, "slug": "PIXI.Sprite_onTextureUpdate", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Called when the anchor position updates.\n *\n * @private\n */", "meta": { "range": [ 4678, 4778 ], "filename": "Sprite.js", "lineno": 166, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100033807", "name": "Sprite#_onAnchorUpdate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Called when the anchor position updates.

", "access": "private", "name": "_onAnchorUpdate", "longname": "PIXI.Sprite#_onAnchorUpdate", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R003089", "___s": true, "skip": true, "slug": "PIXI.Sprite_onAnchorUpdate", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * calculates worldTransform * vertices, store it in vertexData\n */", "meta": { "range": [ 4868, 6671 ], "filename": "Sprite.js", "lineno": 175, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100033825", "name": "Sprite#calculateVertices", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

calculates worldTransform * vertices, store it in vertexData

", "name": "calculateVertices", "longname": "PIXI.Sprite#calculateVertices", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R003092", "___s": true, "skip": true, "slug": "PIXI.SpritecalculateVertices", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData\n * This is used to ensure that the true width and height of a trimmed texture is respected\n */", "meta": { "range": [ 6893, 8412 ], "filename": "Sprite.js", "lineno": 245, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034159", "name": "Sprite#calculateTrimmedVertices", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData
This is used to ensure that the true width and height of a trimmed texture is respected

", "name": "calculateTrimmedVertices", "longname": "PIXI.Sprite#calculateTrimmedVertices", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R003127", "___s": true, "skip": true, "slug": "PIXI.SpritecalculateTrimmedVertices", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n *\n * Renders the object using the WebGL renderer\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The webgl renderer to use.\n */", "meta": { "range": [ 8582, 8778 ], "filename": "Sprite.js", "lineno": 304, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034437", "name": "Sprite#_renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the WebGL renderer

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

The webgl renderer to use.

", "name": "renderer" } ], "name": "_renderWebGL", "longname": "PIXI.Sprite#_renderWebGL", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "overrides": "PIXI.Container#_renderWebGL", "___id": "T000002R003154", "___s": true, "skip": true, "slug": "PIXI.Sprite_renderWebGL", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 8930, 9021 ], "filename": "Sprite.js", "lineno": 318, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034471", "name": "Sprite#_renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the Canvas renderer

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

The renderer

", "name": "renderer" } ], "name": "_renderCanvas", "longname": "PIXI.Sprite#_renderCanvas", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "overrides": "PIXI.Container#_renderCanvas", "___id": "T000002R003155", "___s": true, "skip": true, "slug": "PIXI.Sprite_renderCanvas", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Updates the bounds of the sprite.\n *\n * @private\n */", "meta": { "range": [ 9107, 9733 ], "filename": "Sprite.js", "lineno": 328, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034488", "name": "Sprite#_calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Updates the bounds of the sprite.

", "access": "private", "name": "_calculateBounds", "longname": "PIXI.Sprite#_calculateBounds", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "overrides": "PIXI.Container#_calculateBounds", "___id": "T000002R003156", "___s": true, "skip": true, "slug": "PIXI.Sprite_calculateBounds", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Gets the local bounds of the sprite object.\n *\n * @param {PIXI.Rectangle} rect - The output rectangle.\n * @return {PIXI.Rectangle} The bounds.\n */", "meta": { "range": [ 9917, 10749 ], "filename": "Sprite.js", "lineno": 354, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034559", "name": "Sprite#getLocalBounds", "type": "MethodDefinition", "paramnames": [ "rect" ] }, "vars": { "": null } }, "description": "

Gets the local bounds of the sprite object.

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

The output rectangle.

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

The bounds.

" } ], "name": "getLocalBounds", "longname": "PIXI.Sprite#getLocalBounds", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "overrides": "PIXI.Container#getLocalBounds", "___id": "T000002R003159", "___s": true, "skip": true, "slug": "PIXI.SpritegetLocalBounds", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Tests if a point is inside this sprite\n *\n * @param {PIXI.Point} point - the point to test\n * @return {boolean} the result of the test\n */", "meta": { "range": [ 10925, 11444 ], "filename": "Sprite.js", "lineno": 386, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034699", "name": "Sprite#containsPoint", "type": "MethodDefinition", "paramnames": [ "point" ] }, "vars": { "": null } }, "description": "

Tests if a point is inside this sprite

", "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.Sprite#containsPoint", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "___id": "T000002R003166", "___s": true, "skip": true, "slug": "PIXI.SpritecontainsPoint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Destroys this sprite and optionally its texture and children\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] - Should it destroy the current texture of the sprite as well\n * @param {boolean} [options.baseTexture=false] - Should it destroy the base texture of the sprite as well\n */", "meta": { "range": [ 12084, 12553 ], "filename": "Sprite.js", "lineno": 418, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034793", "name": "Sprite#destroy", "type": "MethodDefinition", "paramnames": [ "options" ] }, "vars": { "": null } }, "description": "

Destroys this sprite and optionally its texture and children

", "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": "

Should it destroy the current texture of the sprite as well

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

Should it destroy the base texture of the sprite as well

", "name": "options.baseTexture" } ], "name": "destroy", "longname": "PIXI.Sprite#destroy", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "overrides": "PIXI.Container#destroy", "___id": "T000002R003172", "___s": true, "skip": true, "slug": "PIXI.Spritedestroy", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Helper function that creates a new sprite based on the source you provide.\n * The source can be - frame id, image url, video url, canvas element, video element, base texture\n *\n * @static\n * @param {number|string|PIXI.BaseTexture|HTMLCanvasElement|HTMLVideoElement} source Source to create texture from\n * @return {PIXI.Sprite} The newly created sprite\n */", "meta": { "range": [ 12987, 13067 ], "filename": "Sprite.js", "lineno": 447, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034863", "name": "Sprite.from", "type": "MethodDefinition", "paramnames": [ "source" ] }, "vars": { "": null } }, "description": "

Helper function that creates a new sprite based on the source you provide.
The source can be - frame id, image url, video url, canvas element, video element, base texture

", "scope": "static", "params": [ { "type": { "names": [ "number", "string", "PIXI.BaseTexture", "HTMLCanvasElement", "HTMLVideoElement" ] }, "description": "

Source to create texture from

", "name": "source" } ], "returns": [ { "type": { "names": [ "PIXI.Sprite" ] }, "description": "

The newly created sprite

" } ], "name": "from", "longname": "PIXI.Sprite.from", "kind": "function", "memberof": "PIXI.Sprite", "___id": "T000002R003178", "___s": true, "skip": true, "slug": "PIXI.Sprite.from", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\n * The frame ids are created when a Texture packer file has been loaded\n *\n * @static\n * @param {string} frameId - The frame Id of the texture in the cache\n * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId\n */", "meta": { "range": [ 13479, 13736 ], "filename": "Sprite.js", "lineno": 460, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034876", "name": "Sprite.fromFrame", "type": "MethodDefinition", "paramnames": [ "frameId" ] }, "vars": { "": null } }, "description": "

Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId
The frame ids are created when a Texture packer file has been loaded

", "scope": "static", "params": [ { "type": { "names": [ "string" ] }, "description": "

The frame Id of the texture in the cache

", "name": "frameId" } ], "returns": [ { "type": { "names": [ "PIXI.Sprite" ] }, "description": "

A new Sprite using a texture from the texture cache matching the frameId

" } ], "name": "fromFrame", "longname": "PIXI.Sprite.fromFrame", "kind": "function", "memberof": "PIXI.Sprite", "___id": "T000002R003179", "___s": true, "skip": true, "slug": "PIXI.Sprite.fromFrame", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Helper function that creates a sprite that will contain a texture based on an image url\n * If the image is not in the texture cache it will be loaded\n *\n * @static\n * @param {string} imageId - The image url of the texture\n * @param {boolean} [crossorigin=(auto)] - if you want to specify the cross-origin parameter\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - if you want to specify the scale mode,\n * see {@link PIXI.SCALE_MODES} for possible values\n * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id\n */", "meta": { "range": [ 14361, 14501 ], "filename": "Sprite.js", "lineno": 483, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034902", "name": "Sprite.fromImage", "type": "MethodDefinition", "paramnames": [ "imageId", "crossorigin", "scaleMode" ] }, "vars": { "": null } }, "description": "

Helper function that creates a sprite that will contain a texture based on an image url
If the image is not in the texture cache it will be loaded

", "scope": "static", "params": [ { "type": { "names": [ "string" ] }, "description": "

The image url of the texture

", "name": "imageId" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": "(auto)", "description": "

if you want to specify the cross-origin parameter

", "name": "crossorigin" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "PIXI.settings.SCALE_MODE", "description": "

if you want to specify the scale mode,
see {@link PIXI.SCALE_MODES} for possible values

", "name": "scaleMode" } ], "returns": [ { "type": { "names": [ "PIXI.Sprite" ] }, "description": "

A new Sprite using a texture from the texture cache matching the image id

" } ], "name": "fromImage", "longname": "PIXI.Sprite.fromImage", "kind": "function", "memberof": "PIXI.Sprite", "___id": "T000002R003181", "___s": true, "skip": true, "slug": "PIXI.Sprite.fromImage", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The width of the sprite, setting this will actually modify the scale to achieve the value set\n *\n * @member {number}\n */", "meta": { "range": [ 14655, 14744 ], "filename": "Sprite.js", "lineno": 493, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034919", "name": "Sprite#width", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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

", "kind": "member", "type": { "names": [ "number" ] }, "name": "width", "longname": "PIXI.Sprite#width", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "overrides": "PIXI.Container#width", "___id": "T000002R003182", "___s": true, "skip": true, "slug": "PIXI.Spritewidth", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The height of the sprite, setting this will actually modify the scale to achieve the value set\n *\n * @member {number}\n */", "meta": { "range": [ 15104, 15195 ], "filename": "Sprite.js", "lineno": 511, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100034982", "name": "Sprite#height", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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

", "kind": "member", "type": { "names": [ "number" ] }, "name": "height", "longname": "PIXI.Sprite#height", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "overrides": "PIXI.Container#height", "___id": "T000002R003187", "___s": true, "skip": true, "slug": "PIXI.Spriteheight", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The anchor sets the origin point of the texture.\n * The default is 0,0 this means the texture's origin is the top left\n * Setting the anchor to 0.5,0.5 means the texture's origin is centered\n * Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner\n *\n * @member {PIXI.ObservablePoint}\n */", "meta": { "range": [ 15779, 15832 ], "filename": "Sprite.js", "lineno": 532, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100035045", "name": "Sprite#anchor", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting the anchor to 0.5,0.5 means the texture's origin is centered
Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

", "kind": "member", "type": { "names": [ "PIXI.ObservablePoint" ] }, "name": "anchor", "longname": "PIXI.Sprite#anchor", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R003192", "___s": true, "skip": true, "slug": "PIXI.Spriteanchor", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The tint applied to the sprite. This is a hex value.\n * A value of 0xFFFFFF will remove any tint effect.\n *\n * @member {number}\n * @default 0xFFFFFF\n */", "meta": { "range": [ 16132, 16181 ], "filename": "Sprite.js", "lineno": 549, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100035066", "name": "Sprite#tint", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The tint applied to the sprite. 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.Sprite#tint", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R003194", "___s": true, "skip": true, "slug": "PIXI.Spritetint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The texture that the sprite is using\n *\n * @member {PIXI.Texture}\n */", "meta": { "range": [ 16465, 16520 ], "filename": "Sprite.js", "lineno": 565, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100035103", "name": "Sprite#texture", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The texture that the sprite is using

", "kind": "member", "type": { "names": [ "PIXI.Texture" ] }, "name": "texture", "longname": "PIXI.Sprite#texture", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R003198", "___s": true, "skip": true, "slug": "PIXI.Spritetexture", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * When the texture is updated, this event will fire to update the scale and frame\n *\n * @private\n */", "meta": { "range": [ 4163, 4585 ], "filename": "Sprite.js", "lineno": 144, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100108406", "name": "Sprite#_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.Sprite#_onTextureUpdate", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R010018", "___s": true, "skip": true, "slug": "PIXI.Sprite_onTextureUpdate", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Called when the anchor position updates.\n *\n * @private\n */", "meta": { "range": [ 4678, 4778 ], "filename": "Sprite.js", "lineno": 166, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100108486", "name": "Sprite#_onAnchorUpdate", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Called when the anchor position updates.

", "access": "private", "name": "_onAnchorUpdate", "longname": "PIXI.Sprite#_onAnchorUpdate", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R010023", "___s": true, "skip": true, "slug": "PIXI.Sprite_onAnchorUpdate", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * calculates worldTransform * vertices, store it in vertexData\n */", "meta": { "range": [ 4868, 6671 ], "filename": "Sprite.js", "lineno": 175, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100108504", "name": "Sprite#calculateVertices", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

calculates worldTransform * vertices, store it in vertexData

", "name": "calculateVertices", "longname": "PIXI.Sprite#calculateVertices", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R010026", "___s": true, "skip": true, "slug": "PIXI.SpritecalculateVertices", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData\n * This is used to ensure that the true width and height of a trimmed texture is respected\n */", "meta": { "range": [ 6893, 8412 ], "filename": "Sprite.js", "lineno": 245, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100108838", "name": "Sprite#calculateTrimmedVertices", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData
This is used to ensure that the true width and height of a trimmed texture is respected

", "name": "calculateTrimmedVertices", "longname": "PIXI.Sprite#calculateTrimmedVertices", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R010061", "___s": true, "skip": true, "slug": "PIXI.SpritecalculateTrimmedVertices", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n *\n * Renders the object using the WebGL renderer\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The webgl renderer to use.\n */", "meta": { "range": [ 8582, 8778 ], "filename": "Sprite.js", "lineno": 304, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109116", "name": "Sprite#_renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the WebGL renderer

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

The webgl renderer to use.

", "name": "renderer" } ], "name": "_renderWebGL", "longname": "PIXI.Sprite#_renderWebGL", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "overrides": "PIXI.Container#_renderWebGL", "___id": "T000002R010088", "___s": true, "skip": true, "slug": "PIXI.Sprite_renderWebGL", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 8930, 9021 ], "filename": "Sprite.js", "lineno": 318, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109150", "name": "Sprite#_renderCanvas", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "

Renders the object using the Canvas renderer

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

The renderer

", "name": "renderer" } ], "name": "_renderCanvas", "longname": "PIXI.Sprite#_renderCanvas", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "overrides": "PIXI.Container#_renderCanvas", "___id": "T000002R010089", "___s": true, "skip": true, "slug": "PIXI.Sprite_renderCanvas", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Updates the bounds of the sprite.\n *\n * @private\n */", "meta": { "range": [ 9107, 9733 ], "filename": "Sprite.js", "lineno": 328, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109167", "name": "Sprite#_calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Updates the bounds of the sprite.

", "access": "private", "name": "_calculateBounds", "longname": "PIXI.Sprite#_calculateBounds", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "overrides": "PIXI.Container#_calculateBounds", "___id": "T000002R010090", "___s": true, "skip": true, "slug": "PIXI.Sprite_calculateBounds", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Gets the local bounds of the sprite object.\n *\n * @param {PIXI.Rectangle} rect - The output rectangle.\n * @return {PIXI.Rectangle} The bounds.\n */", "meta": { "range": [ 9917, 10749 ], "filename": "Sprite.js", "lineno": 354, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109238", "name": "Sprite#getLocalBounds", "type": "MethodDefinition", "paramnames": [ "rect" ] }, "vars": { "": null } }, "description": "

Gets the local bounds of the sprite object.

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

The output rectangle.

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

The bounds.

" } ], "name": "getLocalBounds", "longname": "PIXI.Sprite#getLocalBounds", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "overrides": "PIXI.Container#getLocalBounds", "___id": "T000002R010093", "___s": true, "skip": true, "slug": "PIXI.SpritegetLocalBounds", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Tests if a point is inside this sprite\n *\n * @param {PIXI.Point} point - the point to test\n * @return {boolean} the result of the test\n */", "meta": { "range": [ 10925, 11444 ], "filename": "Sprite.js", "lineno": 386, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109378", "name": "Sprite#containsPoint", "type": "MethodDefinition", "paramnames": [ "point" ] }, "vars": { "": null } }, "description": "

Tests if a point is inside this sprite

", "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.Sprite#containsPoint", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "___id": "T000002R010100", "___s": true, "skip": true, "slug": "PIXI.SpritecontainsPoint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Destroys this sprite and optionally its texture and children\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] - Should it destroy the current texture of the sprite as well\n * @param {boolean} [options.baseTexture=false] - Should it destroy the base texture of the sprite as well\n */", "meta": { "range": [ 12084, 12553 ], "filename": "Sprite.js", "lineno": 418, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109472", "name": "Sprite#destroy", "type": "MethodDefinition", "paramnames": [ "options" ] }, "vars": { "": null } }, "description": "

Destroys this sprite and optionally its texture and children

", "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": "

Should it destroy the current texture of the sprite as well

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

Should it destroy the base texture of the sprite as well

", "name": "options.baseTexture" } ], "name": "destroy", "longname": "PIXI.Sprite#destroy", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "overrides": "PIXI.Container#destroy", "___id": "T000002R010106", "___s": true, "skip": true, "slug": "PIXI.Spritedestroy", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Helper function that creates a new sprite based on the source you provide.\n * The source can be - frame id, image url, video url, canvas element, video element, base texture\n *\n * @static\n * @param {number|string|PIXI.BaseTexture|HTMLCanvasElement|HTMLVideoElement} source Source to create texture from\n * @return {PIXI.Sprite} The newly created sprite\n */", "meta": { "range": [ 12987, 13067 ], "filename": "Sprite.js", "lineno": 447, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109542", "name": "Sprite.from", "type": "MethodDefinition", "paramnames": [ "source" ] }, "vars": { "": null } }, "description": "

Helper function that creates a new sprite based on the source you provide.
The source can be - frame id, image url, video url, canvas element, video element, base texture

", "scope": "static", "params": [ { "type": { "names": [ "number", "string", "PIXI.BaseTexture", "HTMLCanvasElement", "HTMLVideoElement" ] }, "description": "

Source to create texture from

", "name": "source" } ], "returns": [ { "type": { "names": [ "PIXI.Sprite" ] }, "description": "

The newly created sprite

" } ], "name": "from", "longname": "PIXI.Sprite.from", "kind": "function", "memberof": "PIXI.Sprite", "___id": "T000002R010112", "___s": true, "skip": true, "slug": "PIXI.Sprite.from", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId\n * The frame ids are created when a Texture packer file has been loaded\n *\n * @static\n * @param {string} frameId - The frame Id of the texture in the cache\n * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId\n */", "meta": { "range": [ 13479, 13736 ], "filename": "Sprite.js", "lineno": 460, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109555", "name": "Sprite.fromFrame", "type": "MethodDefinition", "paramnames": [ "frameId" ] }, "vars": { "": null } }, "description": "

Helper function that creates a sprite that will contain a texture from the TextureCache based on the frameId
The frame ids are created when a Texture packer file has been loaded

", "scope": "static", "params": [ { "type": { "names": [ "string" ] }, "description": "

The frame Id of the texture in the cache

", "name": "frameId" } ], "returns": [ { "type": { "names": [ "PIXI.Sprite" ] }, "description": "

A new Sprite using a texture from the texture cache matching the frameId

" } ], "name": "fromFrame", "longname": "PIXI.Sprite.fromFrame", "kind": "function", "memberof": "PIXI.Sprite", "___id": "T000002R010113", "___s": true, "skip": true, "slug": "PIXI.Sprite.fromFrame", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Helper function that creates a sprite that will contain a texture based on an image url\n * If the image is not in the texture cache it will be loaded\n *\n * @static\n * @param {string} imageId - The image url of the texture\n * @param {boolean} [crossorigin=(auto)] - if you want to specify the cross-origin parameter\n * @param {number} [scaleMode=PIXI.settings.SCALE_MODE] - if you want to specify the scale mode,\n * see {@link PIXI.SCALE_MODES} for possible values\n * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id\n */", "meta": { "range": [ 14361, 14501 ], "filename": "Sprite.js", "lineno": 483, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109581", "name": "Sprite.fromImage", "type": "MethodDefinition", "paramnames": [ "imageId", "crossorigin", "scaleMode" ] }, "vars": { "": null } }, "description": "

Helper function that creates a sprite that will contain a texture based on an image url
If the image is not in the texture cache it will be loaded

", "scope": "static", "params": [ { "type": { "names": [ "string" ] }, "description": "

The image url of the texture

", "name": "imageId" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": "(auto)", "description": "

if you want to specify the cross-origin parameter

", "name": "crossorigin" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": "PIXI.settings.SCALE_MODE", "description": "

if you want to specify the scale mode,
see {@link PIXI.SCALE_MODES} for possible values

", "name": "scaleMode" } ], "returns": [ { "type": { "names": [ "PIXI.Sprite" ] }, "description": "

A new Sprite using a texture from the texture cache matching the image id

" } ], "name": "fromImage", "longname": "PIXI.Sprite.fromImage", "kind": "function", "memberof": "PIXI.Sprite", "___id": "T000002R010115", "___s": true, "skip": true, "slug": "PIXI.Sprite.fromImage", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The width of the sprite, setting this will actually modify the scale to achieve the value set\n *\n * @member {number}\n */", "meta": { "range": [ 14655, 14744 ], "filename": "Sprite.js", "lineno": 493, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109598", "name": "Sprite#width", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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

", "kind": "member", "type": { "names": [ "number" ] }, "name": "width", "longname": "PIXI.Sprite#width", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "overrides": "PIXI.Container#width", "___id": "T000002R010116", "___s": true, "skip": true, "slug": "PIXI.Spritewidth", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The height of the sprite, setting this will actually modify the scale to achieve the value set\n *\n * @member {number}\n */", "meta": { "range": [ 15104, 15195 ], "filename": "Sprite.js", "lineno": 511, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109661", "name": "Sprite#height", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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

", "kind": "member", "type": { "names": [ "number" ] }, "name": "height", "longname": "PIXI.Sprite#height", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "overrides": "PIXI.Container#height", "___id": "T000002R010121", "___s": true, "skip": true, "slug": "PIXI.Spriteheight", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The anchor sets the origin point of the texture.\n * The default is 0,0 this means the texture's origin is the top left\n * Setting the anchor to 0.5,0.5 means the texture's origin is centered\n * Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner\n *\n * @member {PIXI.ObservablePoint}\n */", "meta": { "range": [ 15779, 15832 ], "filename": "Sprite.js", "lineno": 532, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109724", "name": "Sprite#anchor", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting the anchor to 0.5,0.5 means the texture's origin is centered
Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

", "kind": "member", "type": { "names": [ "PIXI.ObservablePoint" ] }, "name": "anchor", "longname": "PIXI.Sprite#anchor", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R010126", "___s": true, "skip": true, "slug": "PIXI.Spriteanchor", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The tint applied to the sprite. This is a hex value.\n * A value of 0xFFFFFF will remove any tint effect.\n *\n * @member {number}\n * @default 0xFFFFFF\n */", "meta": { "range": [ 16132, 16181 ], "filename": "Sprite.js", "lineno": 549, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109745", "name": "Sprite#tint", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The tint applied to the sprite. 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.Sprite#tint", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R010128", "___s": true, "skip": true, "slug": "PIXI.Spritetint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The texture that the sprite is using\n *\n * @member {PIXI.Texture}\n */", "meta": { "range": [ 16465, 16520 ], "filename": "Sprite.js", "lineno": 565, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": { "id": "astnode100109782", "name": "Sprite#texture", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

The texture that the sprite is using

", "kind": "member", "type": { "names": [ "PIXI.Texture" ] }, "name": "texture", "longname": "PIXI.Sprite#texture", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "___id": "T000002R010132", "___s": true, "skip": true, "slug": "PIXI.Spritetexture", "filepath": "core\\sprites\\Sprite.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.Sprite#onChildrenChange", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.Container#onChildrenChange", "inherited": true, "overrides": "PIXI.Container#onChildrenChange", "___id": "T000002R014020", "___s": true, "skip": true, "slug": "PIXI.SpriteonChildrenChange", "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.

\n

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.Sprite#addChild", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#addChild", "inherited": true, "overrides": "PIXI.Container#addChild", "___id": "T000002R014021", "___s": true, "skip": true, "slug": "PIXI.SpriteaddChild", "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.Sprite#addChildAt", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#addChildAt", "inherited": true, "overrides": "PIXI.Container#addChildAt", "___id": "T000002R014022", "___s": true, "skip": true, "slug": "PIXI.SpriteaddChildAt", "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.Sprite#swapChildren", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#swapChildren", "inherited": true, "overrides": "PIXI.Container#swapChildren", "___id": "T000002R014023", "___s": true, "skip": true, "slug": "PIXI.SpriteswapChildren", "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.Sprite#getChildIndex", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#getChildIndex", "inherited": true, "overrides": "PIXI.Container#getChildIndex", "___id": "T000002R014024", "___s": true, "skip": true, "slug": "PIXI.SpritegetChildIndex", "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.Sprite#setChildIndex", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#setChildIndex", "inherited": true, "overrides": "PIXI.Container#setChildIndex", "___id": "T000002R014025", "___s": true, "skip": true, "slug": "PIXI.SpritesetChildIndex", "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.Sprite#getChildAt", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#getChildAt", "inherited": true, "overrides": "PIXI.Container#getChildAt", "___id": "T000002R014026", "___s": true, "skip": true, "slug": "PIXI.SpritegetChildAt", "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.Sprite#removeChild", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#removeChild", "inherited": true, "overrides": "PIXI.Container#removeChild", "___id": "T000002R014027", "___s": true, "skip": true, "slug": "PIXI.SpriteremoveChild", "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.Sprite#removeChildAt", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#removeChildAt", "inherited": true, "overrides": "PIXI.Container#removeChildAt", "___id": "T000002R014028", "___s": true, "skip": true, "slug": "PIXI.SpriteremoveChildAt", "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.Sprite#removeChildren", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#removeChildren", "inherited": true, "overrides": "PIXI.Container#removeChildren", "___id": "T000002R014029", "___s": true, "skip": true, "slug": "PIXI.SpriteremoveChildren", "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.Sprite#updateTransform", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.Container#updateTransform", "inherited": true, "overrides": "PIXI.Container#updateTransform", "___id": "T000002R014030", "___s": true, "skip": true, "slug": "PIXI.SpriteupdateTransform", "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.Sprite#calculateBounds", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.Container#calculateBounds", "inherited": true, "overrides": "PIXI.Container#calculateBounds", "___id": "T000002R014031", "___s": true, "skip": true, "slug": "PIXI.SpritecalculateBounds", "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.Sprite#renderWebGL", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#renderWebGL", "inherited": true, "overrides": "PIXI.Container#renderWebGL", "___id": "T000002R014032", "___s": true, "skip": true, "slug": "PIXI.SpriterenderWebGL", "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.Sprite#renderAdvancedWebGL", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#renderAdvancedWebGL", "inherited": true, "overrides": "PIXI.Container#renderAdvancedWebGL", "___id": "T000002R014033", "___s": true, "skip": true, "slug": "PIXI.SpriterenderAdvancedWebGL", "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.Sprite#renderCanvas", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.Container#renderCanvas", "inherited": true, "overrides": "PIXI.Container#renderCanvas", "___id": "T000002R014034", "___s": true, "skip": true, "slug": "PIXI.SpriterenderCanvas", "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.Sprite#_tempDisplayObjectParent", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#_tempDisplayObjectParent", "inherited": true, "overrides": "PIXI.Container#_tempDisplayObjectParent", "___id": "T000002R014045", "___s": true, "skip": true, "slug": "PIXI.Sprite_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.Sprite#_recursivePostUpdateTransform", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#_recursivePostUpdateTransform", "inherited": true, "overrides": "PIXI.Container#_recursivePostUpdateTransform", "___id": "T000002R014046", "___s": true, "skip": true, "slug": "PIXI.Sprite_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.Sprite#getBounds", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.DisplayObject#getBounds", "inherited": true, "overrides": "PIXI.Container#getBounds", "___id": "T000002R014047", "___s": true, "skip": true, "slug": "PIXI.SpritegetBounds", "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.Sprite#toGlobal", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.DisplayObject#toGlobal", "inherited": true, "overrides": "PIXI.Container#toGlobal", "___id": "T000002R014048", "___s": true, "skip": true, "slug": "PIXI.SpritetoGlobal", "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.Sprite#toLocal", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.DisplayObject#toLocal", "inherited": true, "overrides": "PIXI.Container#toLocal", "___id": "T000002R014049", "___s": true, "skip": true, "slug": "PIXI.SpritetoLocal", "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.Sprite#setParent", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.DisplayObject#setParent", "inherited": true, "overrides": "PIXI.Container#setParent", "___id": "T000002R014050", "___s": true, "skip": true, "slug": "PIXI.SpritesetParent", "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.Sprite#setTransform", "kind": "function", "memberof": "PIXI.Sprite", "scope": "instance", "inherits": "PIXI.DisplayObject#setTransform", "inherited": true, "overrides": "PIXI.Container#setTransform", "___id": "T000002R014051", "___s": true, "skip": true, "slug": "PIXI.SpritesetTransform", "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.Sprite#x", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#x", "inherited": true, "overrides": "PIXI.Container#x", "___id": "T000002R014052", "___s": true, "skip": true, "slug": "PIXI.Spritex", "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.Sprite#y", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#y", "inherited": true, "overrides": "PIXI.Container#y", "___id": "T000002R014053", "___s": true, "skip": true, "slug": "PIXI.Spritey", "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.Sprite#worldTransform", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#worldTransform", "inherited": true, "overrides": "PIXI.Container#worldTransform", "___id": "T000002R014054", "___s": true, "skip": true, "slug": "PIXI.SpriteworldTransform", "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.Sprite#localTransform", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#localTransform", "inherited": true, "overrides": "PIXI.Container#localTransform", "___id": "T000002R014055", "___s": true, "skip": true, "slug": "PIXI.SpritelocalTransform", "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.Sprite#position", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#position", "inherited": true, "overrides": "PIXI.Container#position", "___id": "T000002R014056", "___s": true, "skip": true, "slug": "PIXI.Spriteposition", "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.Sprite#scale", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#scale", "inherited": true, "overrides": "PIXI.Container#scale", "___id": "T000002R014057", "___s": true, "skip": true, "slug": "PIXI.Spritescale", "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.Sprite#pivot", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#pivot", "inherited": true, "overrides": "PIXI.Container#pivot", "___id": "T000002R014058", "___s": true, "skip": true, "slug": "PIXI.Spritepivot", "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.Sprite#skew", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#skew", "inherited": true, "overrides": "PIXI.Container#skew", "___id": "T000002R014059", "___s": true, "skip": true, "slug": "PIXI.Spriteskew", "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.Sprite#rotation", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#rotation", "inherited": true, "overrides": "PIXI.Container#rotation", "___id": "T000002R014060", "___s": true, "skip": true, "slug": "PIXI.Spriterotation", "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.Sprite#worldVisible", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#worldVisible", "inherited": true, "overrides": "PIXI.Container#worldVisible", "___id": "T000002R014061", "___s": true, "skip": true, "slug": "PIXI.SpriteworldVisible", "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": "

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.

", "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.Sprite#mask", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#mask", "inherited": true, "overrides": "PIXI.Container#mask", "___id": "T000002R014062", "___s": true, "skip": true, "slug": "PIXI.Spritemask", "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.

\n
    \n
  • IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
    To remove filters simply set this property to 'null'
  • \n
", "kind": "member", "type": { "names": [ "Array." ] }, "name": "filters", "longname": "PIXI.Sprite#filters", "memberof": "PIXI.Sprite", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#filters", "inherited": true, "overrides": "PIXI.Container#filters", "___id": "T000002R014063", "___s": true, "skip": true, "slug": "PIXI.Spritefilters", "filepath": "core\\display\\DisplayObject.js" } ], "$attributes": [ { "comment": "/**\n * The anchor sets the origin point of the texture.\n * The default is 0,0 this means the texture's origin is the top left\n * Setting the anchor to 0.5,0.5 means the texture's origin is centered\n * Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner\n *\n * @member {PIXI.ObservablePoint} PIXI.Sprite#_anchor\n * @private\n */", "meta": { "range": [ 769, 1202 ], "filename": "Sprite.js", "lineno": 33, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting the anchor to 0.5,0.5 means the texture's origin is centered
Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

", "kind": "member", "name": "_anchor", "type": { "names": [ "PIXI.ObservablePoint" ] }, "access": "private", "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#_anchor", "scope": "instance", "___id": "T000002R003055", "___s": true, "skip": true, "slug": "PIXI.Sprite_anchor", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The texture that the sprite is using\n *\n * @private\n * @member {PIXI.Texture} PIXI.Sprite#_texture\n */", "meta": { "range": [ 1284, 1433 ], "filename": "Sprite.js", "lineno": 44, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The texture that the sprite is using

", "access": "private", "kind": "member", "name": "_texture", "type": { "names": [ "PIXI.Texture" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#_texture", "scope": "instance", "___id": "T000002R003057", "___s": true, "skip": true, "slug": "PIXI.Sprite_texture", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The width of the sprite (this is initially set by the texture)\n *\n * @private\n * @member {number} PIXI.Sprite#_width\n */", "meta": { "range": [ 1473, 1640 ], "filename": "Sprite.js", "lineno": 52, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The width of the sprite (this is initially set by the texture)

", "access": "private", "kind": "member", "name": "_width", "type": { "names": [ "number" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#_width", "scope": "instance", "___id": "T000002R003059", "___s": true, "skip": true, "slug": "PIXI.Sprite_width", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The height of the sprite (this is initially set by the texture)\n *\n * @private\n * @member {number} PIXI.Sprite#_height\n */", "meta": { "range": [ 1675, 1844 ], "filename": "Sprite.js", "lineno": 60, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The height of the sprite (this is initially set by the texture)

", "access": "private", "kind": "member", "name": "_height", "type": { "names": [ "number" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#_height", "scope": "instance", "___id": "T000002R003061", "___s": true, "skip": true, "slug": "PIXI.Sprite_height", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.\n *\n * @private\n * @member {number} PIXI.Sprite#_tint\n * @default 0xFFFFFF\n */", "meta": { "range": [ 1880, 2114 ], "filename": "Sprite.js", "lineno": 68, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

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

", "access": "private", "kind": "member", "name": "_tint", "type": { "names": [ "number" ] }, "defaultvalue": "0xFFFFFF", "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#_tint", "scope": "instance", "___id": "T000002R003063", "___s": true, "skip": true, "slug": "PIXI.Sprite_tint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The blend mode to be applied to the sprite. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode.\n *\n * @member {number} PIXI.Sprite#blendMode\n * @default PIXI.BLEND_MODES.NORMAL\n * @see PIXI.BLEND_MODES\n */", "meta": { "range": [ 2211, 2487 ], "filename": "Sprite.js", "lineno": 79, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

", "kind": "member", "name": "blendMode", "type": { "names": [ "number" ] }, "defaultvalue": "PIXI.BLEND_MODES.NORMAL", "see": [ "PIXI.BLEND_MODES" ], "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#blendMode", "scope": "instance", "___id": "T000002R003067", "___s": true, "skip": true, "slug": "PIXI.SpriteblendMode", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The shader that will be used to render the sprite. Set to null to remove a current shader.\n *\n * @member {PIXI.Filter|PIXI.Shader} PIXI.Sprite#shader\n */", "meta": { "range": [ 2542, 2734 ], "filename": "Sprite.js", "lineno": 88, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The shader that will be used to render the sprite. Set to null to remove a current shader.

", "kind": "member", "name": "shader", "type": { "names": [ "PIXI.Filter", "PIXI.Shader" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#shader", "scope": "instance", "___id": "T000002R003069", "___s": true, "skip": true, "slug": "PIXI.Spriteshader", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * An internal cached value of the tint.\n *\n * @private\n * @member {number} PIXI.Sprite#cachedTint\n * @default 0xFFFFFF\n */", "meta": { "range": [ 2772, 2947 ], "filename": "Sprite.js", "lineno": 95, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

An internal cached value of the tint.

", "access": "private", "kind": "member", "name": "cachedTint", "type": { "names": [ "number" ] }, "defaultvalue": "0xFFFFFF", "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#cachedTint", "scope": "instance", "___id": "T000002R003071", "___s": true, "skip": true, "slug": "PIXI.SpritecachedTint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * this is used to store the vertex data of the sprite (basically a quad)\n *\n * @private\n * @member {Float32Array} PIXI.Sprite#vertexData\n */", "meta": { "range": [ 3074, 3259 ], "filename": "Sprite.js", "lineno": 107, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

this is used to store the vertex data of the sprite (basically a quad)

", "access": "private", "kind": "member", "name": "vertexData", "type": { "names": [ "Float32Array" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#vertexData", "scope": "instance", "___id": "T000002R003074", "___s": true, "skip": true, "slug": "PIXI.SpritevertexData", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * This is used to calculate the bounds of the object IF it is a trimmed sprite\n *\n * @private\n * @member {Float32Array} PIXI.Sprite#vertexTrimmedData\n */", "meta": { "range": [ 3316, 3514 ], "filename": "Sprite.js", "lineno": 115, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

This is used to calculate the bounds of the object IF it is a trimmed sprite

", "access": "private", "kind": "member", "name": "vertexTrimmedData", "type": { "names": [ "Float32Array" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#vertexTrimmedData", "scope": "instance", "___id": "T000002R003076", "___s": true, "skip": true, "slug": "PIXI.SpritevertexTrimmedData", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Plugin that is responsible for rendering this element.\n * Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.\n *\n * @member {string} PIXI.Sprite#pluginName\n * @default 'sprite'\n */", "meta": { "range": [ 3703, 3989 ], "filename": "Sprite.js", "lineno": 129, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "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": "'sprite'", "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#pluginName", "scope": "instance", "___id": "T000002R003082", "___s": true, "skip": true, "slug": "PIXI.SpritepluginName", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * @method\n * @private\n * @name PIXI.Sprite#setTexture\n * @see PIXI.Sprite#texture\n * @deprecated since version 3.0.0\n * @param {PIXI.Texture} texture - The texture to set to.\n */", "meta": { "range": [ 16870, 17053 ], "filename": "deprecation.js", "lineno": 657, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "kind": "function", "access": "private", "name": "setTexture", "see": [ "PIXI.Sprite#texture" ], "deprecated": "since version 3.0.0", "params": [ { "type": { "names": [ "PIXI.Texture" ] }, "description": "

The texture to set to.

", "name": "texture" } ], "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#setTexture", "scope": "instance", "___id": "T000002R004645", "___s": true, "skip": true, "slug": "PIXI.SpritesetTexture", "filepath": "deprecation.js" }, { "comment": "/**\n * The anchor sets the origin point of the texture.\n * The default is 0,0 this means the texture's origin is the top left\n * Setting the anchor to 0.5,0.5 means the texture's origin is centered\n * Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner\n *\n * @member {PIXI.ObservablePoint} PIXI.Sprite#_anchor\n * @private\n */", "meta": { "range": [ 769, 1202 ], "filename": "Sprite.js", "lineno": 33, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The anchor sets the origin point of the texture.
The default is 0,0 this means the texture's origin is the top left
Setting the anchor to 0.5,0.5 means the texture's origin is centered
Setting the anchor to 1,1 would mean the texture's origin point will be the bottom right corner

", "kind": "member", "name": "_anchor", "type": { "names": [ "PIXI.ObservablePoint" ] }, "access": "private", "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#_anchor", "scope": "instance", "___id": "T000002R009989", "___s": true, "skip": true, "slug": "PIXI.Sprite_anchor", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The texture that the sprite is using\n *\n * @private\n * @member {PIXI.Texture} PIXI.Sprite#_texture\n */", "meta": { "range": [ 1284, 1433 ], "filename": "Sprite.js", "lineno": 44, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The texture that the sprite is using

", "access": "private", "kind": "member", "name": "_texture", "type": { "names": [ "PIXI.Texture" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#_texture", "scope": "instance", "___id": "T000002R009991", "___s": true, "skip": true, "slug": "PIXI.Sprite_texture", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The width of the sprite (this is initially set by the texture)\n *\n * @private\n * @member {number} PIXI.Sprite#_width\n */", "meta": { "range": [ 1473, 1640 ], "filename": "Sprite.js", "lineno": 52, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The width of the sprite (this is initially set by the texture)

", "access": "private", "kind": "member", "name": "_width", "type": { "names": [ "number" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#_width", "scope": "instance", "___id": "T000002R009993", "___s": true, "skip": true, "slug": "PIXI.Sprite_width", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The height of the sprite (this is initially set by the texture)\n *\n * @private\n * @member {number} PIXI.Sprite#_height\n */", "meta": { "range": [ 1675, 1844 ], "filename": "Sprite.js", "lineno": 60, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The height of the sprite (this is initially set by the texture)

", "access": "private", "kind": "member", "name": "_height", "type": { "names": [ "number" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#_height", "scope": "instance", "___id": "T000002R009995", "___s": true, "skip": true, "slug": "PIXI.Sprite_height", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.\n *\n * @private\n * @member {number} PIXI.Sprite#_tint\n * @default 0xFFFFFF\n */", "meta": { "range": [ 1880, 2114 ], "filename": "Sprite.js", "lineno": 68, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

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

", "access": "private", "kind": "member", "name": "_tint", "type": { "names": [ "number" ] }, "defaultvalue": "0xFFFFFF", "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#_tint", "scope": "instance", "___id": "T000002R009997", "___s": true, "skip": true, "slug": "PIXI.Sprite_tint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The blend mode to be applied to the sprite. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode.\n *\n * @member {number} PIXI.Sprite#blendMode\n * @default PIXI.BLEND_MODES.NORMAL\n * @see PIXI.BLEND_MODES\n */", "meta": { "range": [ 2211, 2487 ], "filename": "Sprite.js", "lineno": 79, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

", "kind": "member", "name": "blendMode", "type": { "names": [ "number" ] }, "defaultvalue": "PIXI.BLEND_MODES.NORMAL", "see": [ "PIXI.BLEND_MODES" ], "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#blendMode", "scope": "instance", "___id": "T000002R010001", "___s": true, "skip": true, "slug": "PIXI.SpriteblendMode", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * The shader that will be used to render the sprite. Set to null to remove a current shader.\n *\n * @member {PIXI.Filter|PIXI.Shader} PIXI.Sprite#shader\n */", "meta": { "range": [ 2542, 2734 ], "filename": "Sprite.js", "lineno": 88, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

The shader that will be used to render the sprite. Set to null to remove a current shader.

", "kind": "member", "name": "shader", "type": { "names": [ "PIXI.Filter", "PIXI.Shader" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#shader", "scope": "instance", "___id": "T000002R010003", "___s": true, "skip": true, "slug": "PIXI.Spriteshader", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * An internal cached value of the tint.\n *\n * @private\n * @member {number} PIXI.Sprite#cachedTint\n * @default 0xFFFFFF\n */", "meta": { "range": [ 2772, 2947 ], "filename": "Sprite.js", "lineno": 95, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

An internal cached value of the tint.

", "access": "private", "kind": "member", "name": "cachedTint", "type": { "names": [ "number" ] }, "defaultvalue": "0xFFFFFF", "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#cachedTint", "scope": "instance", "___id": "T000002R010005", "___s": true, "skip": true, "slug": "PIXI.SpritecachedTint", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * this is used to store the vertex data of the sprite (basically a quad)\n *\n * @private\n * @member {Float32Array} PIXI.Sprite#vertexData\n */", "meta": { "range": [ 3074, 3259 ], "filename": "Sprite.js", "lineno": 107, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

this is used to store the vertex data of the sprite (basically a quad)

", "access": "private", "kind": "member", "name": "vertexData", "type": { "names": [ "Float32Array" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#vertexData", "scope": "instance", "___id": "T000002R010008", "___s": true, "skip": true, "slug": "PIXI.SpritevertexData", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * This is used to calculate the bounds of the object IF it is a trimmed sprite\n *\n * @private\n * @member {Float32Array} PIXI.Sprite#vertexTrimmedData\n */", "meta": { "range": [ 3316, 3514 ], "filename": "Sprite.js", "lineno": 115, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "code": {} }, "description": "

This is used to calculate the bounds of the object IF it is a trimmed sprite

", "access": "private", "kind": "member", "name": "vertexTrimmedData", "type": { "names": [ "Float32Array" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#vertexTrimmedData", "scope": "instance", "___id": "T000002R010010", "___s": true, "skip": true, "slug": "PIXI.SpritevertexTrimmedData", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * Plugin that is responsible for rendering this element.\n * Allows to customize the rendering process without overriding '_renderWebGL' & '_renderCanvas' methods.\n *\n * @member {string} PIXI.Sprite#pluginName\n * @default 'sprite'\n */", "meta": { "range": [ 3703, 3989 ], "filename": "Sprite.js", "lineno": 129, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\sprites", "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": "'sprite'", "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#pluginName", "scope": "instance", "___id": "T000002R010016", "___s": true, "skip": true, "slug": "PIXI.SpritepluginName", "filepath": "core\\sprites\\Sprite.js" }, { "comment": "/**\n * @method\n * @private\n * @name PIXI.Sprite#setTexture\n * @see PIXI.Sprite#texture\n * @deprecated since version 3.0.0\n * @param {PIXI.Texture} texture - The texture to set to.\n */", "meta": { "range": [ 16870, 17053 ], "filename": "deprecation.js", "lineno": 657, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src", "code": {} }, "kind": "function", "access": "private", "name": "setTexture", "see": [ "PIXI.Sprite#texture" ], "deprecated": "since version 3.0.0", "params": [ { "type": { "names": [ "PIXI.Texture" ] }, "description": "

The texture to set to.

", "name": "texture" } ], "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#setTexture", "scope": "instance", "___id": "T000002R011579", "___s": true, "skip": true, "slug": "PIXI.SpritesetTexture", "filepath": "deprecation.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.Sprite", "longname": "PIXI.Sprite#children", "scope": "instance", "inherits": "PIXI.Container#children", "inherited": true, "overrides": "PIXI.Container#children", "___id": "T000002R014019", "___s": true, "skip": true, "slug": "PIXI.Spritechildren", "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.Sprite", "longname": "PIXI.Sprite#transform", "scope": "instance", "inherits": "PIXI.DisplayObject#transform", "inherited": true, "overrides": "PIXI.Container#transform", "___id": "T000002R014035", "___s": true, "skip": true, "slug": "PIXI.Spritetransform", "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.Sprite", "longname": "PIXI.Sprite#alpha", "scope": "instance", "inherits": "PIXI.DisplayObject#alpha", "inherited": true, "overrides": "PIXI.Container#alpha", "___id": "T000002R014036", "___s": true, "skip": true, "slug": "PIXI.Spritealpha", "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.

\n

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

", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#visible", "scope": "instance", "inherits": "PIXI.DisplayObject#visible", "inherited": true, "overrides": "PIXI.Container#visible", "___id": "T000002R014037", "___s": true, "skip": true, "slug": "PIXI.Spritevisible", "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.

\n

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

", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#renderable", "scope": "instance", "inherits": "PIXI.DisplayObject#renderable", "inherited": true, "overrides": "PIXI.Container#renderable", "___id": "T000002R014038", "___s": true, "skip": true, "slug": "PIXI.Spriterenderable", "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.Sprite", "longname": "PIXI.Sprite#parent", "scope": "instance", "inherits": "PIXI.DisplayObject#parent", "inherited": true, "overrides": "PIXI.Container#parent", "___id": "T000002R014039", "___s": true, "skip": true, "slug": "PIXI.Spriteparent", "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.Sprite", "longname": "PIXI.Sprite#worldAlpha", "scope": "instance", "inherits": "PIXI.DisplayObject#worldAlpha", "inherited": true, "overrides": "PIXI.Container#worldAlpha", "___id": "T000002R014040", "___s": true, "skip": true, "slug": "PIXI.SpriteworldAlpha", "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

\n

Also works as an interaction mask

", "kind": "member", "name": "filterArea", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.Sprite", "longname": "PIXI.Sprite#filterArea", "scope": "instance", "inherits": "PIXI.DisplayObject#filterArea", "inherited": true, "overrides": "PIXI.Container#filterArea", "___id": "T000002R014041", "___s": true, "skip": true, "slug": "PIXI.SpritefilterArea", "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.Sprite", "longname": "PIXI.Sprite#_bounds", "scope": "instance", "inherits": "PIXI.DisplayObject#_bounds", "inherited": true, "overrides": "PIXI.Container#_bounds", "___id": "T000002R014042", "___s": true, "skip": true, "slug": "PIXI.Sprite_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.Sprite", "longname": "PIXI.Sprite#_mask", "scope": "instance", "inherits": "PIXI.DisplayObject#_mask", "inherited": true, "overrides": "PIXI.Container#_mask", "___id": "T000002R014043", "___s": true, "skip": true, "slug": "PIXI.Sprite_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.Sprite", "longname": "PIXI.Sprite#_destroyed", "scope": "instance", "inherits": "PIXI.DisplayObject#_destroyed", "inherited": true, "overrides": "PIXI.Container#_destroyed", "___id": "T000002R014044", "___s": true, "skip": true, "slug": "PIXI.Sprite_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'

\n

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.Sprite", "name": "cacheAsBitmap", "longname": "PIXI.Sprite#cacheAsBitmap", "scope": "instance", "inherits": "PIXI.DisplayObject#cacheAsBitmap", "inherited": true, "overrides": "PIXI.Container#cacheAsBitmap", "___id": "T000002R014064", "___s": true, "skip": true, "slug": "PIXI.SpritecacheAsBitmap", "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.

\n
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.

\n

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": "

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.Container#destroy", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "overrides": "PIXI.DisplayObject#destroy", "___id": "T000002R000497", "___s": true, "skip": true, "slug": "PIXI.Containerdestroy", "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.Container#width", "memberof": "PIXI.Container", "scope": "instance", "params": [], "___id": "T000002R000501", "___s": true, "skip": true, "slug": "PIXI.Containerwidth", "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.Container#height", "memberof": "PIXI.Container", "scope": "instance", "params": [], "___id": "T000002R000507", "___s": true, "skip": true, "slug": "PIXI.Containerheight", "filepath": "core\\display\\Container.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": "astnode100078205", "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": "T000002R007366", "___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": "astnode100078209", "name": "Container#addChild", "type": "MethodDefinition", "paramnames": [ "child" ] }, "vars": { "": null } }, "description": "

Adds one or more children to the container.

\n

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": "T000002R007367", "___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": "astnode100078307", "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": "T000002R007372", "___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": "astnode100078399", "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": "T000002R007375", "___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": "astnode100078454", "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": "T000002R007380", "___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": "astnode100078481", "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": "T000002R007382", "___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": "astnode100078536", "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": "T000002R007384", "___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": "astnode100078567", "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": "T000002R007385", "___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": "astnode100078663", "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": "T000002R007391", "___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": "astnode100078719", "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": "T000002R007395", "___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": "astnode100078867", "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": "T000002R007405", "___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": "astnode100078938", "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": "T000002R007410", "___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": "astnode100079058", "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": "T000002R007414", "___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": "astnode100079062", "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": "T000002R007415", "___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": "astnode100079135", "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": "T000002R007418", "___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": "astnode100079315", "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": "T000002R007426", "___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": "astnode100079320", "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": "T000002R007427", "___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": "astnode100079325", "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": "T000002R007428", "___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": "astnode100079410", "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.Container#destroy", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "overrides": "PIXI.DisplayObject#destroy", "___id": "T000002R007431", "___s": true, "skip": true, "slug": "PIXI.Containerdestroy", "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": "astnode100079471", "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.Container#width", "memberof": "PIXI.Container", "scope": "instance", "params": [], "___id": "T000002R007435", "___s": true, "skip": true, "slug": "PIXI.Containerwidth", "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": "astnode100079532", "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.Container#height", "memberof": "PIXI.Container", "scope": "instance", "params": [], "___id": "T000002R007441", "___s": true, "skip": true, "slug": "PIXI.Containerheight", "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.Container#_tempDisplayObjectParent", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#_tempDisplayObjectParent", "inherited": true, "overrides": "PIXI.DisplayObject#_tempDisplayObjectParent", "___id": "T000002R013881", "___s": true, "skip": true, "slug": "PIXI.Container_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.Container#_recursivePostUpdateTransform", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#_recursivePostUpdateTransform", "inherited": true, "overrides": "PIXI.DisplayObject#_recursivePostUpdateTransform", "___id": "T000002R013882", "___s": true, "skip": true, "slug": "PIXI.Container_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.Container#getBounds", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "inherits": "PIXI.DisplayObject#getBounds", "inherited": true, "overrides": "PIXI.DisplayObject#getBounds", "___id": "T000002R013883", "___s": true, "skip": true, "slug": "PIXI.ContainergetBounds", "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.Container#getLocalBounds", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "inherits": "PIXI.DisplayObject#getLocalBounds", "inherited": true, "overrides": "PIXI.DisplayObject#getLocalBounds", "___id": "T000002R013884", "___s": true, "skip": true, "slug": "PIXI.ContainergetLocalBounds", "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.Container#toGlobal", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "inherits": "PIXI.DisplayObject#toGlobal", "inherited": true, "overrides": "PIXI.DisplayObject#toGlobal", "___id": "T000002R013885", "___s": true, "skip": true, "slug": "PIXI.ContainertoGlobal", "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.Container#toLocal", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "inherits": "PIXI.DisplayObject#toLocal", "inherited": true, "overrides": "PIXI.DisplayObject#toLocal", "___id": "T000002R013886", "___s": true, "skip": true, "slug": "PIXI.ContainertoLocal", "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.Container#setParent", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "inherits": "PIXI.DisplayObject#setParent", "inherited": true, "overrides": "PIXI.DisplayObject#setParent", "___id": "T000002R013887", "___s": true, "skip": true, "slug": "PIXI.ContainersetParent", "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.Container#setTransform", "kind": "function", "memberof": "PIXI.Container", "scope": "instance", "inherits": "PIXI.DisplayObject#setTransform", "inherited": true, "overrides": "PIXI.DisplayObject#setTransform", "___id": "T000002R013888", "___s": true, "skip": true, "slug": "PIXI.ContainersetTransform", "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.Container#x", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#x", "inherited": true, "overrides": "PIXI.DisplayObject#x", "___id": "T000002R013889", "___s": true, "skip": true, "slug": "PIXI.Containerx", "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.Container#y", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#y", "inherited": true, "overrides": "PIXI.DisplayObject#y", "___id": "T000002R013890", "___s": true, "skip": true, "slug": "PIXI.Containery", "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.Container#worldTransform", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#worldTransform", "inherited": true, "overrides": "PIXI.DisplayObject#worldTransform", "___id": "T000002R013891", "___s": true, "skip": true, "slug": "PIXI.ContainerworldTransform", "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.Container#localTransform", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#localTransform", "inherited": true, "overrides": "PIXI.DisplayObject#localTransform", "___id": "T000002R013892", "___s": true, "skip": true, "slug": "PIXI.ContainerlocalTransform", "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.Container#position", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#position", "inherited": true, "overrides": "PIXI.DisplayObject#position", "___id": "T000002R013893", "___s": true, "skip": true, "slug": "PIXI.Containerposition", "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.Container#scale", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#scale", "inherited": true, "overrides": "PIXI.DisplayObject#scale", "___id": "T000002R013894", "___s": true, "skip": true, "slug": "PIXI.Containerscale", "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.Container#pivot", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#pivot", "inherited": true, "overrides": "PIXI.DisplayObject#pivot", "___id": "T000002R013895", "___s": true, "skip": true, "slug": "PIXI.Containerpivot", "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.Container#skew", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#skew", "inherited": true, "overrides": "PIXI.DisplayObject#skew", "___id": "T000002R013896", "___s": true, "skip": true, "slug": "PIXI.Containerskew", "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.Container#rotation", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#rotation", "inherited": true, "overrides": "PIXI.DisplayObject#rotation", "___id": "T000002R013897", "___s": true, "skip": true, "slug": "PIXI.Containerrotation", "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.Container#worldVisible", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#worldVisible", "inherited": true, "overrides": "PIXI.DisplayObject#worldVisible", "___id": "T000002R013898", "___s": true, "skip": true, "slug": "PIXI.ContainerworldVisible", "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": "

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.

", "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.Container#mask", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#mask", "inherited": true, "overrides": "PIXI.DisplayObject#mask", "___id": "T000002R013899", "___s": true, "skip": true, "slug": "PIXI.Containermask", "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.

\n
    \n
  • IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
    To remove filters simply set this property to 'null'
  • \n
", "kind": "member", "type": { "names": [ "Array." ] }, "name": "filters", "longname": "PIXI.Container#filters", "memberof": "PIXI.Container", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#filters", "inherited": true, "overrides": "PIXI.DisplayObject#filters", "___id": "T000002R013900", "___s": true, "skip": true, "slug": "PIXI.Containerfilters", "filepath": "core\\display\\DisplayObject.js" } ], "$attributes": [ { "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.Container", "longname": "PIXI.Container#children", "scope": "instance", "___id": "T000002R000430", "___s": true, "skip": true, "slug": "PIXI.Containerchildren", "filepath": "core\\display\\Container.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.Container", "longname": "PIXI.Container#children", "scope": "instance", "___id": "T000002R007364", "___s": true, "skip": true, "slug": "PIXI.Containerchildren", "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.Container", "longname": "PIXI.Container#transform", "scope": "instance", "inherits": "PIXI.DisplayObject#transform", "inherited": true, "overrides": "PIXI.DisplayObject#transform", "___id": "T000002R013871", "___s": true, "skip": true, "slug": "PIXI.Containertransform", "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.Container", "longname": "PIXI.Container#alpha", "scope": "instance", "inherits": "PIXI.DisplayObject#alpha", "inherited": true, "overrides": "PIXI.DisplayObject#alpha", "___id": "T000002R013872", "___s": true, "skip": true, "slug": "PIXI.Containeralpha", "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.

\n

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

", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Container", "longname": "PIXI.Container#visible", "scope": "instance", "inherits": "PIXI.DisplayObject#visible", "inherited": true, "overrides": "PIXI.DisplayObject#visible", "___id": "T000002R013873", "___s": true, "skip": true, "slug": "PIXI.Containervisible", "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.

\n

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

", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Container", "longname": "PIXI.Container#renderable", "scope": "instance", "inherits": "PIXI.DisplayObject#renderable", "inherited": true, "overrides": "PIXI.DisplayObject#renderable", "___id": "T000002R013874", "___s": true, "skip": true, "slug": "PIXI.Containerrenderable", "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.Container", "longname": "PIXI.Container#parent", "scope": "instance", "inherits": "PIXI.DisplayObject#parent", "inherited": true, "overrides": "PIXI.DisplayObject#parent", "___id": "T000002R013875", "___s": true, "skip": true, "slug": "PIXI.Containerparent", "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.Container", "longname": "PIXI.Container#worldAlpha", "scope": "instance", "inherits": "PIXI.DisplayObject#worldAlpha", "inherited": true, "overrides": "PIXI.DisplayObject#worldAlpha", "___id": "T000002R013876", "___s": true, "skip": true, "slug": "PIXI.ContainerworldAlpha", "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

\n

Also works as an interaction mask

", "kind": "member", "name": "filterArea", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.Container", "longname": "PIXI.Container#filterArea", "scope": "instance", "inherits": "PIXI.DisplayObject#filterArea", "inherited": true, "overrides": "PIXI.DisplayObject#filterArea", "___id": "T000002R013877", "___s": true, "skip": true, "slug": "PIXI.ContainerfilterArea", "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.Container", "longname": "PIXI.Container#_bounds", "scope": "instance", "inherits": "PIXI.DisplayObject#_bounds", "inherited": true, "overrides": "PIXI.DisplayObject#_bounds", "___id": "T000002R013878", "___s": true, "skip": true, "slug": "PIXI.Container_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.Container", "longname": "PIXI.Container#_mask", "scope": "instance", "inherits": "PIXI.DisplayObject#_mask", "inherited": true, "overrides": "PIXI.DisplayObject#_mask", "___id": "T000002R013879", "___s": true, "skip": true, "slug": "PIXI.Container_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.Container", "longname": "PIXI.Container#_destroyed", "scope": "instance", "inherits": "PIXI.DisplayObject#_destroyed", "inherited": true, "overrides": "PIXI.DisplayObject#_destroyed", "___id": "T000002R013880", "___s": true, "skip": true, "slug": "PIXI.Container_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'

\n

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.Container", "name": "cacheAsBitmap", "longname": "PIXI.Container#cacheAsBitmap", "scope": "instance", "inherits": "PIXI.DisplayObject#cacheAsBitmap", "inherited": true, "overrides": "PIXI.DisplayObject#cacheAsBitmap", "___id": "T000002R013901", "___s": true, "skip": true, "slug": "PIXI.ContainercacheAsBitmap", "filepath": "extras\\cacheAsBitmap.js" } ], "$staticmethods": [], "$staticproperties": [], "$augments": [ { "comment": "/**\n * The base class for all objects that are rendered on the screen.\n * This is an abstract class and should not be used on its own rather it should be extended.\n *\n * @class\n * @extends EventEmitter\n * @mixes PIXI.interaction.interactiveTarget\n * @memberof PIXI\n */", "meta": { "range": [ 627, 17309 ], "filename": "DisplayObject.js", "lineno": 21, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100004957", "name": "DisplayObject", "type": "ClassDeclaration", "paramnames": [] } }, "classdesc": "

The base class for all objects that are rendered on the screen.
This is an abstract class and should not be used on its own rather it should be extended.

", "kind": "class", "augments": [ "EventEmitter" ], "mixes": [ "PIXI.interaction.interactiveTarget" ], "memberof": "PIXI", "name": "DisplayObject", "longname": "PIXI.DisplayObject", "scope": "static", "params": [], "___id": "T000002R000515", "___s": true, "$methods": [ { "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.DisplayObject#_tempDisplayObjectParent", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000545", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_tempDisplayObjectParent", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Updates the object transform for rendering\n *\n * TODO - Optimization pass!\n */", "meta": { "range": [ 4320, 4542 ], "filename": "DisplayObject.js", "lineno": 148, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005108", "name": "DisplayObject#updateTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Updates the object transform for rendering

\n

TODO - Optimization pass!

", "name": "updateTransform", "longname": "PIXI.DisplayObject#updateTransform", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000547", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectupdateTransform", "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.DisplayObject#_recursivePostUpdateTransform", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000549", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_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.DisplayObject#getBounds", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R000550", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectgetBounds", "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.DisplayObject#getLocalBounds", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R000555", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectgetLocalBounds", "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.DisplayObject#toGlobal", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R000565", "___s": true, "skip": true, "slug": "PIXI.DisplayObjecttoGlobal", "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.DisplayObject#toLocal", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R000568", "___s": true, "skip": true, "slug": "PIXI.DisplayObjecttoLocal", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 10140, 10233 ], "filename": "DisplayObject.js", "lineno": 329, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005484", "name": "DisplayObject#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.DisplayObject#renderWebGL", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R000572", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrenderWebGL", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 10374, 10468 ], "filename": "DisplayObject.js", "lineno": 339, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005489", "name": "DisplayObject#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.DisplayObject#renderCanvas", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R000573", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrenderCanvas", "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.DisplayObject#setParent", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R000574", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectsetParent", "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.DisplayObject#setTransform", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R000575", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectsetTransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Base destroy method for generic display objects. This will automatically\n * remove the display object from its parent Container as well as remove\n * all current event listeners and internal references. Do not use a DisplayObject\n * after calling `destroy`.\n *\n */", "meta": { "range": [ 12339, 12779 ], "filename": "DisplayObject.js", "lineno": 398, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100005631", "name": "DisplayObject#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Base destroy method for generic display objects. This will automatically
remove the display object from its parent Container as well as remove
all current event listeners and internal references. Do not use a DisplayObject
after calling destroy.

", "name": "destroy", "longname": "PIXI.DisplayObject#destroy", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000585", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectdestroy", "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.DisplayObject#x", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000595", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectx", "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.DisplayObject#y", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000598", "___s": true, "skip": true, "slug": "PIXI.DisplayObjecty", "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.DisplayObject#worldTransform", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000601", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectworldTransform", "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.DisplayObject#localTransform", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000602", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectlocalTransform", "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.DisplayObject#position", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000603", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectposition", "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.DisplayObject#scale", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000605", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectscale", "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.DisplayObject#pivot", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000607", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectpivot", "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.DisplayObject#skew", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000609", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectskew", "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.DisplayObject#rotation", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000611", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrotation", "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.DisplayObject#worldVisible", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000614", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectworldVisible", "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": "

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.

", "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.DisplayObject#mask", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000617", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectmask", "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.

\n
    \n
  • IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
    To remove filters simply set this property to 'null'
  • \n
", "kind": "member", "type": { "names": [ "Array." ] }, "name": "filters", "longname": "PIXI.DisplayObject#filters", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R000622", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectfilters", "filepath": "core\\display\\DisplayObject.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": "astnode100079765", "name": "DisplayObject#_tempDisplayObjectParent", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "access": "private", "kind": "member", "type": { "names": [ "PIXI.DisplayObject" ] }, "name": "_tempDisplayObjectParent", "longname": "PIXI.DisplayObject#_tempDisplayObjectParent", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007479", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_tempDisplayObjectParent", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Updates the object transform for rendering\n *\n * TODO - Optimization pass!\n */", "meta": { "range": [ 4320, 4542 ], "filename": "DisplayObject.js", "lineno": 148, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100079787", "name": "DisplayObject#updateTransform", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Updates the object transform for rendering

\n

TODO - Optimization pass!

", "name": "updateTransform", "longname": "PIXI.DisplayObject#updateTransform", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007481", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectupdateTransform", "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": "astnode100079824", "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.DisplayObject#_recursivePostUpdateTransform", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007483", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_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": "astnode100079865", "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.DisplayObject#getBounds", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007484", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectgetBounds", "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": "astnode100079956", "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.DisplayObject#getLocalBounds", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007489", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectgetLocalBounds", "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": "astnode100080035", "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.DisplayObject#toGlobal", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007499", "___s": true, "skip": true, "slug": "PIXI.DisplayObjecttoGlobal", "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": "astnode100080093", "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.DisplayObject#toLocal", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007502", "___s": true, "skip": true, "slug": "PIXI.DisplayObjecttoLocal", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 10140, 10233 ], "filename": "DisplayObject.js", "lineno": 329, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080163", "name": "DisplayObject#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.DisplayObject#renderWebGL", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007506", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrenderWebGL", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 10374, 10468 ], "filename": "DisplayObject.js", "lineno": 339, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080168", "name": "DisplayObject#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.DisplayObject#renderCanvas", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007507", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrenderCanvas", "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": "astnode100080173", "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.DisplayObject#setParent", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007508", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectsetParent", "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": "astnode100080199", "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.DisplayObject#setTransform", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "___id": "T000002R007509", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectsetTransform", "filepath": "core\\display\\DisplayObject.js" }, { "comment": "/**\n * Base destroy method for generic display objects. This will automatically\n * remove the display object from its parent Container as well as remove\n * all current event listeners and internal references. Do not use a DisplayObject\n * after calling `destroy`.\n *\n */", "meta": { "range": [ 12339, 12779 ], "filename": "DisplayObject.js", "lineno": 398, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\display", "code": { "id": "astnode100080310", "name": "DisplayObject#destroy", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Base destroy method for generic display objects. This will automatically
remove the display object from its parent Container as well as remove
all current event listeners and internal references. Do not use a DisplayObject
after calling destroy.

", "name": "destroy", "longname": "PIXI.DisplayObject#destroy", "kind": "function", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007519", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectdestroy", "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": "astnode100080386", "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.DisplayObject#x", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007529", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectx", "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": "astnode100080411", "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.DisplayObject#y", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007532", "___s": true, "skip": true, "slug": "PIXI.DisplayObjecty", "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": "astnode100080436", "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.DisplayObject#worldTransform", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007535", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectworldTransform", "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": "astnode100080446", "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.DisplayObject#localTransform", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007536", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectlocalTransform", "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": "astnode100080456", "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.DisplayObject#position", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007537", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectposition", "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": "astnode100080481", "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.DisplayObject#scale", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007539", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectscale", "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": "astnode100080506", "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.DisplayObject#pivot", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007541", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectpivot", "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": "astnode100080531", "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.DisplayObject#skew", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007543", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectskew", "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": "astnode100080556", "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.DisplayObject#rotation", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007545", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrotation", "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": "astnode100080579", "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.DisplayObject#worldVisible", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007548", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectworldVisible", "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": "astnode100080606", "name": "DisplayObject#mask", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

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.

", "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.DisplayObject#mask", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007551", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectmask", "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": "astnode100080651", "name": "DisplayObject#filters", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "

Sets the filters for the displayObject.

\n
    \n
  • IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
    To remove filters simply set this property to 'null'
  • \n
", "kind": "member", "type": { "names": [ "Array." ] }, "name": "filters", "longname": "PIXI.DisplayObject#filters", "memberof": "PIXI.DisplayObject", "scope": "instance", "params": [], "___id": "T000002R007556", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectfilters", "filepath": "core\\display\\DisplayObject.js" } ], "$attributes": [ { "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.DisplayObject", "longname": "PIXI.DisplayObject#transform", "scope": "instance", "___id": "T000002R000519", "___s": true, "skip": true, "slug": "PIXI.DisplayObjecttransform", "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.DisplayObject", "longname": "PIXI.DisplayObject#alpha", "scope": "instance", "___id": "T000002R000521", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectalpha", "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.

\n

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

", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#visible", "scope": "instance", "___id": "T000002R000523", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectvisible", "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.

\n

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

", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#renderable", "scope": "instance", "___id": "T000002R000525", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrenderable", "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.DisplayObject", "longname": "PIXI.DisplayObject#parent", "scope": "instance", "___id": "T000002R000527", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectparent", "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.DisplayObject", "longname": "PIXI.DisplayObject#worldAlpha", "scope": "instance", "___id": "T000002R000529", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectworldAlpha", "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

\n

Also works as an interaction mask

", "kind": "member", "name": "filterArea", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#filterArea", "scope": "instance", "___id": "T000002R000531", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectfilterArea", "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.DisplayObject", "longname": "PIXI.DisplayObject#_bounds", "scope": "instance", "___id": "T000002R000535", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_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.DisplayObject", "longname": "PIXI.DisplayObject#_mask", "scope": "instance", "___id": "T000002R000541", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_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.DisplayObject", "longname": "PIXI.DisplayObject#_destroyed", "scope": "instance", "___id": "T000002R000543", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_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'

\n

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.DisplayObject", "name": "cacheAsBitmap", "longname": "PIXI.DisplayObject#cacheAsBitmap", "scope": "instance", "___id": "T000002R005071", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectcacheAsBitmap", "filepath": "extras\\cacheAsBitmap.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.DisplayObject", "longname": "PIXI.DisplayObject#transform", "scope": "instance", "___id": "T000002R007453", "___s": true, "skip": true, "slug": "PIXI.DisplayObjecttransform", "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.DisplayObject", "longname": "PIXI.DisplayObject#alpha", "scope": "instance", "___id": "T000002R007455", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectalpha", "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.

\n

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

", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#visible", "scope": "instance", "___id": "T000002R007457", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectvisible", "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.

\n

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

", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#renderable", "scope": "instance", "___id": "T000002R007459", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectrenderable", "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.DisplayObject", "longname": "PIXI.DisplayObject#parent", "scope": "instance", "___id": "T000002R007461", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectparent", "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.DisplayObject", "longname": "PIXI.DisplayObject#worldAlpha", "scope": "instance", "___id": "T000002R007463", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectworldAlpha", "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

\n

Also works as an interaction mask

", "kind": "member", "name": "filterArea", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.DisplayObject", "longname": "PIXI.DisplayObject#filterArea", "scope": "instance", "___id": "T000002R007465", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectfilterArea", "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.DisplayObject", "longname": "PIXI.DisplayObject#_bounds", "scope": "instance", "___id": "T000002R007469", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_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.DisplayObject", "longname": "PIXI.DisplayObject#_mask", "scope": "instance", "___id": "T000002R007475", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_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.DisplayObject", "longname": "PIXI.DisplayObject#_destroyed", "scope": "instance", "___id": "T000002R007477", "___s": true, "skip": true, "slug": "PIXI.DisplayObject_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": "astnode100128200", "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'

\n

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.DisplayObject", "name": "cacheAsBitmap", "longname": "PIXI.DisplayObject#cacheAsBitmap", "scope": "instance", "___id": "T000002R012005", "___s": true, "skip": true, "slug": "PIXI.DisplayObjectcacheAsBitmap", "filepath": "extras\\cacheAsBitmap.js" } ], "$staticmethods": [], "$staticproperties": [], "$augments": [ { "name": "EventEmitter" } ], "$augmentedBy": [ { "name": "Container" }, { "name": "Container" } ], "filepath": "core\\display\\DisplayObject.js" } ], "$augmentedBy": [ { "name": "Graphics" }, { "name": "Sprite" }, { "name": "BitmapText" }, { "name": "Mesh" }, { "name": "ParticleContainer" }, { "name": "Graphics" }, { "name": "Sprite" }, { "name": "BitmapText" }, { "name": "Mesh" }, { "name": "ParticleContainer" } ], "filepath": "core\\display\\Container.js" } ], "$augmentedBy": [ { "name": "Text" }, { "name": "AnimatedSprite" }, { "name": "TilingSprite" }, { "name": "Text" }, { "name": "AnimatedSprite" }, { "name": "TilingSprite" } ], "filepath": "core\\sprites\\Sprite.js" } ], "$augmentedBy": [], "filepath": "core\\text\\Text.js" }