The Graphics class contains methods used to draw primitive shapes such as lines, circles and
rectangles to the display, and to color and fill them.
Public methods | |
---|---|
public | clone(): PIXI.Graphics |
public | lineStyle(lineWidth: number, color: number, alpha: number): PIXI.Graphics |
public | moveTo(x: number, y: number): PIXI.Graphics |
public | lineTo(x: number, y: number): PIXI.Graphics |
public | quadraticCurveTo(cpX: number, cpY: number, toX: number, toY: number): PIXI.Graphics |
public | bezierCurveTo(cpX: number, cpY: number, cpX2: number, cpY2: number, toX: number, toY: number): PIXI.Graphics |
public | arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): PIXI.Graphics |
public | arc(cx: number, cy: number, radius: number, startAngle: number, endAngle: number, anticlockwise: boolean): PIXI.Graphics |
public | beginFill(color: number, alpha: number): PIXI.Graphics |
public | endFill(): PIXI.Graphics |
public | drawRect(x: number, y: number, width: number, height: number): PIXI.Graphics |
public | drawRoundedRect(x: number, y: number, width: number, height: number, radius: number): PIXI.Graphics |
public | drawCircle(x: number, y: number, radius: number): PIXI.Graphics |
public | drawEllipse(x: number, y: number, width: number, height: number): PIXI.Graphics |
public |
drawPolygon(path: Array.<number>, Array. |
public | clear(): PIXI.Graphics |
public | isFastRect(): boolean |
private | _renderWebGL(renderer: PIXI.WebGLRenderer): void |
private | _renderSpriteRect(renderer: PIXI.WebGLRenderer): void |
private | _renderCanvas(renderer: PIXI.CanvasRenderer): void |
private | _calculateBounds(): void |
public | containsPoint(point: PIXI.Point): boolean |
public | updateLocalBounds(): void |
public | drawShape(shape: PIXI.Circle, PIXI.Ellipse, PIXI.Polygon, PIXI.Rectangle, PIXI.RoundedRectangle): PIXI.GraphicsData |
public | generateCanvasTexture(scaleMode: number, resolution: number): PIXI.Texture |
public | closePath(): PIXI.Graphics |
public | addHole(): PIXI.Graphics |
public | destroy(options: object, boolean): void |
public | clone(): PIXI.Graphics |
public | lineStyle(lineWidth: number, color: number, alpha: number): PIXI.Graphics |
public | moveTo(x: number, y: number): PIXI.Graphics |
public | lineTo(x: number, y: number): PIXI.Graphics |
public | quadraticCurveTo(cpX: number, cpY: number, toX: number, toY: number): PIXI.Graphics |
public | bezierCurveTo(cpX: number, cpY: number, cpX2: number, cpY2: number, toX: number, toY: number): PIXI.Graphics |
public | arcTo(x1: number, y1: number, x2: number, y2: number, radius: number): PIXI.Graphics |
public | arc(cx: number, cy: number, radius: number, startAngle: number, endAngle: number, anticlockwise: boolean): PIXI.Graphics |
public | beginFill(color: number, alpha: number): PIXI.Graphics |
public | endFill(): PIXI.Graphics |
public | drawRect(x: number, y: number, width: number, height: number): PIXI.Graphics |
public | drawRoundedRect(x: number, y: number, width: number, height: number, radius: number): PIXI.Graphics |
public | drawCircle(x: number, y: number, radius: number): PIXI.Graphics |
public | drawEllipse(x: number, y: number, width: number, height: number): PIXI.Graphics |
public |
drawPolygon(path: Array.<number>, Array. |
public | clear(): PIXI.Graphics |
public | isFastRect(): boolean |
private | _renderWebGL(renderer: PIXI.WebGLRenderer): void |
private | _renderSpriteRect(renderer: PIXI.WebGLRenderer): void |
private | _renderCanvas(renderer: PIXI.CanvasRenderer): void |
private | _calculateBounds(): void |
public | containsPoint(point: PIXI.Point): boolean |
public | updateLocalBounds(): void |
public | drawShape(shape: PIXI.Circle, PIXI.Ellipse, PIXI.Polygon, PIXI.Rectangle, PIXI.RoundedRectangle): PIXI.GraphicsData |
public | generateCanvasTexture(scaleMode: number, resolution: number): PIXI.Texture |
public | closePath(): PIXI.Graphics |
public | addHole(): PIXI.Graphics |
public | destroy(options: object, boolean): void |
private | onChildrenChange(): void |
public | addChild(child: PIXI.DisplayObject): PIXI.DisplayObject |
public | addChildAt(child: PIXI.DisplayObject, index: number): PIXI.DisplayObject |
public | swapChildren(child: PIXI.DisplayObject, child2: PIXI.DisplayObject): void |
public | getChildIndex(child: PIXI.DisplayObject): number |
public | setChildIndex(child: PIXI.DisplayObject, index: number): void |
public | getChildAt(index: number): PIXI.DisplayObject |
public | removeChild(child: PIXI.DisplayObject): PIXI.DisplayObject |
public | removeChildAt(index: number): PIXI.DisplayObject |
public | removeChildren(beginIndex: number, endIndex: number): Array.<DisplayObject> |
public | updateTransform(): void |
public | calculateBounds(): void |
public | renderWebGL(renderer: PIXI.WebGLRenderer): void |
private | renderAdvancedWebGL(renderer: PIXI.WebGLRenderer): void |
public | renderCanvas(renderer: PIXI.CanvasRenderer): void |
public | width(): void |
public | height(): void |
private | _tempDisplayObjectParent(): void |
public | _recursivePostUpdateTransform(): void |
public | getBounds(skipUpdate: boolean, rect: PIXI.Rectangle): PIXI.Rectangle |
public | getLocalBounds(rect: PIXI.Rectangle): PIXI.Rectangle |
public | toGlobal(position: PIXI.Point, point: PIXI.Point, skipUpdate: boolean): PIXI.Point |
public | toLocal(position: PIXI.Point, from: PIXI.DisplayObject, point: PIXI.Point, skipUpdate: boolean): PIXI.Point |
public | setParent(container: PIXI.Container): PIXI.Container |
public | setTransform(x: number, y: number, scaleX: number, scaleY: number, rotation: number, skewX: number, skewY: number, pivotX: number, pivotY: number): PIXI.DisplayObject |
public | x(): void |
public | y(): void |
public | worldTransform(): void |
public | localTransform(): void |
public | position(): void |
public | scale(): void |
public | pivot(): void |
public | skew(): void |
public | rotation(): void |
public | worldVisible(): void |
public | mask(): void |
public | filters(): void |
Name | Type | Attribute | Description |
---|---|---|---|
fillAlpha | number | public | The alpha value used when filling the Graphics object. |
lineWidth | number | public | The width (thickness) of any lines drawn. |
nativeLines | boolean | public | If true the lines will be draw using LINES instead of TRIANGLE_STRIP |
lineColor | string | public | The color of any lines drawn. |
graphicsData |
Array. |
private | Graphics data |
tint | number | public | The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to |
_prevTint | number | private | The previous tint applied to the graphic shape. Used to compare to the current tint and |
blendMode | number | public | The blend mode to be applied to the graphic shape. Apply a value of |
currentPath | PIXI.GraphicsData | private | Current path |
isMask | boolean | public | Whether this shape is being used as a mask. |
boundsPadding | number | public | The bounds' padding used for bounds calculation. |
_localBounds | PIXI.Rectangle | private | A cache of the local bounds to prevent recalculation. |
dirty | boolean | private | Used to detect if the graphics object has changed. If this is set to true then the graphics |
cachedSpriteDirty | boolean | private | Used to detect if the cached sprite object needs to be updated. |
cacheAsBitmap | boolean | public | When cacheAsBitmap is set to true the graphics object will be rendered as if it was a sprite. |
fillAlpha | number | public | The alpha value used when filling the Graphics object. |
lineWidth | number | public | The width (thickness) of any lines drawn. |
nativeLines | boolean | public | If true the lines will be draw using LINES instead of TRIANGLE_STRIP |
lineColor | string | public | The color of any lines drawn. |
graphicsData |
Array. |
private | Graphics data |
tint | number | public | The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to |
_prevTint | number | private | The previous tint applied to the graphic shape. Used to compare to the current tint and |
blendMode | number | public | The blend mode to be applied to the graphic shape. Apply a value of |
currentPath | PIXI.GraphicsData | private | Current path |
isMask | boolean | public | Whether this shape is being used as a mask. |
boundsPadding | number | public | The bounds' padding used for bounds calculation. |
_localBounds | PIXI.Rectangle | private | A cache of the local bounds to prevent recalculation. |
dirty | boolean | private | Used to detect if the graphics object has changed. If this is set to true then the graphics |
cachedSpriteDirty | boolean | private | Used to detect if the cached sprite object needs to be updated. |
cacheAsBitmap | boolean | public | When cacheAsBitmap is set to true the graphics object will be rendered as if it was a sprite. |
children |
Array. |
public | The array of children of this container. |
transform | PIXI.TransformBase | public | World transform and local transform of this object. |
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 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 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 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. |
Creates a new Graphics object with the same values as this one.
Note that the only the properties of the object are cloned, not its transform (position,scale,etc)
PIXI.Graphics
Specifies the line style used for subsequent calls to Graphics methods such as the lineTo()
method or the drawCircle() method.
Name | Type | Attribute | Description |
---|---|---|---|
lineWidth | width of the line to draw, will update the objects stored style |
||
color | color of the line to draw, will update the objects stored style |
||
alpha | alpha of the line to draw, will update the objects stored style |
PIXI.Graphics
Moves the current drawing position to x, y.
Name | Type | Attribute | Description |
---|---|---|---|
x | the X coordinate to move to |
||
y | the Y coordinate to move to |
PIXI.Graphics
Draws a line using the current line style from the current drawing position to (x, y);
The current drawing position is then set to (x, y).
Name | Type | Attribute | Description |
---|---|---|---|
x | the X coordinate to draw to |
||
y | the Y coordinate to draw to |
PIXI.Graphics
Calculate the points for a quadratic bezier curve and then draws it.
Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c
Name | Type | Attribute | Description |
---|---|---|---|
cpX | Control point x |
||
cpY | Control point y |
||
toX | Destination point x |
||
toY | Destination point y |
PIXI.Graphics
Calculate the points for a bezier curve and then draws it.
Name | Type | Attribute | Description |
---|---|---|---|
cpX | Control point x |
||
cpY | Control point y |
||
cpX2 | Second Control point x |
||
cpY2 | Second Control point y |
||
toX | Destination point x |
||
toY | Destination point y |
PIXI.Graphics
The arcTo() method creates an arc/curve between two tangents on the canvas.
"borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!
Name | Type | Attribute | Description |
---|---|---|---|
x1 | The x-coordinate of the beginning of the arc |
||
y1 | The y-coordinate of the beginning of the arc |
||
x2 | The x-coordinate of the end of the arc |
||
y2 | The y-coordinate of the end of the arc |
||
radius | The radius of the arc |
PIXI.Graphics
The arc method creates an arc/curve (used to create circles, or parts of circles).
Name | Type | Attribute | Description |
---|---|---|---|
cx | The x-coordinate of the center of the circle |
||
cy | The y-coordinate of the center of the circle |
||
radius | The radius of the circle |
||
startAngle | The starting angle, in radians (0 is at the 3 o'clock position |
||
endAngle | The ending angle, in radians |
||
anticlockwise | Specifies whether the drawing should be |
PIXI.Graphics
Specifies a simple one-color fill that subsequent calls to other Graphics methods
(such as lineTo() or drawCircle()) use when drawing.
Name | Type | Attribute | Description |
---|---|---|---|
color | the color of the fill |
||
alpha | the alpha of the fill |
PIXI.Graphics
Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.
PIXI.Graphics
Name | Type | Attribute | Description |
---|---|---|---|
x | The X coord of the top-left of the rectangle |
||
y | The Y coord of the top-left of the rectangle |
||
width | The width of the rectangle |
||
height | The height of the rectangle |
PIXI.Graphics
Name | Type | Attribute | Description |
---|---|---|---|
x | The X coord of the top-left of the rectangle |
||
y | The Y coord of the top-left of the rectangle |
||
width | The width of the rectangle |
||
height | The height of the rectangle |
||
radius | Radius of the rectangle corners |
PIXI.Graphics
Draws a circle.
Name | Type | Attribute | Description |
---|---|---|---|
x | The X coordinate of the center of the circle |
||
y | The Y coordinate of the center of the circle |
||
radius | The radius of the circle |
PIXI.Graphics
Draws an ellipse.
Name | Type | Attribute | Description |
---|---|---|---|
x | The X coordinate of the center of the ellipse |
||
y | The Y coordinate of the center of the ellipse |
||
width | The half width of the ellipse |
||
height | The half height of the ellipse |
PIXI.Graphics
Draws a polygon using the given path.
Name | Type | Attribute | Description |
---|---|---|---|
path | The path data used to construct the polygon. |
PIXI.Graphics
Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
PIXI.Graphics
True if graphics consists of one rectangle, and thus, can be drawn like a Sprite and
masked with gl.scissor.
Renders the object using the WebGL renderer
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Renders a sprite rectangle.
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Renders the object using the Canvas renderer
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Retrieves the bounds of the graphic shape as a rectangle object
void
Tests if a point is inside this graphics object
Name | Type | Attribute | Description |
---|---|---|---|
point | the point to test |
Update the bounds of the object
void
Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.
Name | Type | Attribute | Description |
---|---|---|---|
shape | The shape object to draw. |
PIXI.GraphicsData
Generates a canvas texture.
Name | Type | Attribute | Description |
---|---|---|---|
scaleMode | The scale mode of the texture. |
||
resolution | The resolution of the texture. |
PIXI.Texture
Closes the current path.
PIXI.Graphics
Adds a hole in the current path.
PIXI.Graphics
Destroys the Graphics object.
Name | Type | Attribute | Description |
---|---|---|---|
options | Options parameter. A boolean will act as if all |
||
options.children | if set to true, all the children will have |
||
options.texture | Only used for child Sprites if options.children is set to true |
||
options.baseTexture | Only used for child Sprites if options.children is set to true |
void
Creates a new Graphics object with the same values as this one.
Note that the only the properties of the object are cloned, not its transform (position,scale,etc)
PIXI.Graphics
Specifies the line style used for subsequent calls to Graphics methods such as the lineTo()
method or the drawCircle() method.
Name | Type | Attribute | Description |
---|---|---|---|
lineWidth | width of the line to draw, will update the objects stored style |
||
color | color of the line to draw, will update the objects stored style |
||
alpha | alpha of the line to draw, will update the objects stored style |
PIXI.Graphics
Moves the current drawing position to x, y.
Name | Type | Attribute | Description |
---|---|---|---|
x | the X coordinate to move to |
||
y | the Y coordinate to move to |
PIXI.Graphics
Draws a line using the current line style from the current drawing position to (x, y);
The current drawing position is then set to (x, y).
Name | Type | Attribute | Description |
---|---|---|---|
x | the X coordinate to draw to |
||
y | the Y coordinate to draw to |
PIXI.Graphics
Calculate the points for a quadratic bezier curve and then draws it.
Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c
Name | Type | Attribute | Description |
---|---|---|---|
cpX | Control point x |
||
cpY | Control point y |
||
toX | Destination point x |
||
toY | Destination point y |
PIXI.Graphics
Calculate the points for a bezier curve and then draws it.
Name | Type | Attribute | Description |
---|---|---|---|
cpX | Control point x |
||
cpY | Control point y |
||
cpX2 | Second Control point x |
||
cpY2 | Second Control point y |
||
toX | Destination point x |
||
toY | Destination point y |
PIXI.Graphics
The arcTo() method creates an arc/curve between two tangents on the canvas.
"borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!
Name | Type | Attribute | Description |
---|---|---|---|
x1 | The x-coordinate of the beginning of the arc |
||
y1 | The y-coordinate of the beginning of the arc |
||
x2 | The x-coordinate of the end of the arc |
||
y2 | The y-coordinate of the end of the arc |
||
radius | The radius of the arc |
PIXI.Graphics
The arc method creates an arc/curve (used to create circles, or parts of circles).
Name | Type | Attribute | Description |
---|---|---|---|
cx | The x-coordinate of the center of the circle |
||
cy | The y-coordinate of the center of the circle |
||
radius | The radius of the circle |
||
startAngle | The starting angle, in radians (0 is at the 3 o'clock position |
||
endAngle | The ending angle, in radians |
||
anticlockwise | Specifies whether the drawing should be |
PIXI.Graphics
Specifies a simple one-color fill that subsequent calls to other Graphics methods
(such as lineTo() or drawCircle()) use when drawing.
Name | Type | Attribute | Description |
---|---|---|---|
color | the color of the fill |
||
alpha | the alpha of the fill |
PIXI.Graphics
Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.
PIXI.Graphics
Name | Type | Attribute | Description |
---|---|---|---|
x | The X coord of the top-left of the rectangle |
||
y | The Y coord of the top-left of the rectangle |
||
width | The width of the rectangle |
||
height | The height of the rectangle |
PIXI.Graphics
Name | Type | Attribute | Description |
---|---|---|---|
x | The X coord of the top-left of the rectangle |
||
y | The Y coord of the top-left of the rectangle |
||
width | The width of the rectangle |
||
height | The height of the rectangle |
||
radius | Radius of the rectangle corners |
PIXI.Graphics
Draws a circle.
Name | Type | Attribute | Description |
---|---|---|---|
x | The X coordinate of the center of the circle |
||
y | The Y coordinate of the center of the circle |
||
radius | The radius of the circle |
PIXI.Graphics
Draws an ellipse.
Name | Type | Attribute | Description |
---|---|---|---|
x | The X coordinate of the center of the ellipse |
||
y | The Y coordinate of the center of the ellipse |
||
width | The half width of the ellipse |
||
height | The half height of the ellipse |
PIXI.Graphics
Draws a polygon using the given path.
Name | Type | Attribute | Description |
---|---|---|---|
path | The path data used to construct the polygon. |
PIXI.Graphics
Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
PIXI.Graphics
True if graphics consists of one rectangle, and thus, can be drawn like a Sprite and
masked with gl.scissor.
Renders the object using the WebGL renderer
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Renders a sprite rectangle.
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Renders the object using the Canvas renderer
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Retrieves the bounds of the graphic shape as a rectangle object
void
Tests if a point is inside this graphics object
Name | Type | Attribute | Description |
---|---|---|---|
point | the point to test |
Update the bounds of the object
void
Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.
Name | Type | Attribute | Description |
---|---|---|---|
shape | The shape object to draw. |
PIXI.GraphicsData
Generates a canvas texture.
Name | Type | Attribute | Description |
---|---|---|---|
scaleMode | The scale mode of the texture. |
||
resolution | The resolution of the texture. |
PIXI.Texture
Closes the current path.
PIXI.Graphics
Adds a hole in the current path.
PIXI.Graphics
Destroys the Graphics object.
Name | Type | Attribute | Description |
---|---|---|---|
options | Options parameter. A boolean will act as if all |
||
options.children | if set to true, all the children will have |
||
options.texture | Only used for child Sprites if options.children is set to true |
||
options.baseTexture | Only used for child Sprites if options.children is set to true |
void
Overridable method that can be used by Container subclasses whenever the children array is modified
void
Adds one or more children to the container.
Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)
Name | Type | Attribute | Description |
---|---|---|---|
child | The DisplayObject(s) to add to the container |
PIXI.DisplayObject
Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown
Name | Type | Attribute | Description |
---|---|---|---|
child | The child to add |
||
index | The index to place the child in |
PIXI.DisplayObject
Swaps the position of 2 Display Objects within this container.
Name | Type | Attribute | Description |
---|---|---|---|
child | First display object to swap |
||
child2 | Second display object to swap |
void
Returns the index position of a child DisplayObject instance
Name | Type | Attribute | Description |
---|---|---|---|
child | The DisplayObject instance to identify |
Changes the position of an existing child in the display object container
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 |
void
Returns the child at the specified index
Name | Type | Attribute | Description |
---|---|---|---|
index | The index to get the child at |
PIXI.DisplayObject
Removes one or more children from the container.
Name | Type | Attribute | Description |
---|---|---|---|
child | The DisplayObject(s) to remove |
PIXI.DisplayObject
Removes a child from the specified index position.
Name | Type | Attribute | Description |
---|---|---|---|
index | The index to get the child from |
PIXI.DisplayObject
Removes all children from this container that are within the begin and end indexes.
Name | Type | Attribute | Description |
---|---|---|---|
beginIndex | The beginning position. |
||
endIndex | The ending position. Default value is size of the container. |
Updates the transform on all children of this container for rendering
void
Recalculates the bounds of the container.
void
Renders the object using the WebGL renderer
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Render the object using the WebGL renderer and advanced features.
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
Renders the object using the Canvas renderer
Name | Type | Attribute | Description |
---|---|---|---|
renderer | The renderer |
void
The width of the Container, setting this will actually modify the scale to achieve the value set
void
The height of the Container, setting this will actually modify the scale to achieve the value set
void
void
recursively updates transform of all objects from the root to this one
internal function for toLocal()
void
Retrieves the bounds of the displayObject as a rectangle object.
Name | Type | Attribute | Description |
---|---|---|---|
skipUpdate | setting to true will stop the transforms of the scene graph from |
||
rect | Optional rectangle to store the result of the bounds calculation |
PIXI.Rectangle
Retrieves the local bounds of the displayObject as a rectangle object
Name | Type | Attribute | Description |
---|---|---|---|
rect | Optional rectangle to store the result of the bounds calculation |
PIXI.Rectangle
Calculates the global position of the display object
Name | Type | Attribute | Description |
---|---|---|---|
position | The world origin to calculate from |
||
point | A Point object in which to store the value, optional |
||
skipUpdate | Should we skip the update transform. |
PIXI.Point
Calculates the local position of the display object relative to another point
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 |
||
skipUpdate | Should we skip the update transform |
PIXI.Point
Set the parent Container of this DisplayObject
Name | Type | Attribute | Description |
---|---|---|---|
container | The Container to add this DisplayObject to |
PIXI.Container
Convenience function to set the position, scale, skew and pivot at once.
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 |
PIXI.DisplayObject
The position of the displayObject on the x axis relative to the local coordinates of the parent.
An alias to position.x
void
The position of the displayObject on the y axis relative to the local coordinates of the parent.
An alias to position.y
void
Current transform of the object based on world (parent) factors
void
Current transform of the object based on local factors: position, scale, other stuff
void
The coordinate of the object relative to the local coordinates of the parent.
Assignment by value since pixi-v4.
void
The scale factor of the object.
Assignment by value since pixi-v4.
void
The pivot point of the displayObject that it rotates around
Assignment by value since pixi-v4.
void
The skew factor for the object in radians.
Assignment by value since pixi-v4.
void
The rotation of the object in radians.
void
Indicates if the object is globally visible.
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.
void
Sets the filters for the displayObject.
void
{ "comment": "/**\n * The Graphics class contains methods used to draw primitive shapes such as lines, circles and\n * rectangles to the display, and to color and fill them.\n *\n * @class\n * @extends PIXI.Container\n * @memberof PIXI\n */", "meta": { "range": [ 984, 34271 ], "filename": "Graphics.js", "lineno": 29, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100008990", "name": "Graphics", "type": "ClassDeclaration", "paramnames": [ "nativeLines" ] } }, "classdesc": "The Graphics class contains methods used to draw primitive shapes such as lines, circles and
", "kind": "class", "augments": [ "PIXI.Container" ], "memberof": "PIXI", "name": "Graphics", "longname": "PIXI.Graphics", "scope": "static", "params": [ { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
rectangles to the display, and to color and fill them.If true the lines will be draw using LINES instead of TRIANGLE_STRIP
", "name": "nativeLines" } ], "___id": "T000002R000833", "___s": true, "$methods": [ { "comment": "/**\n * Creates a new Graphics object with the same values as this one.\n * Note that the only the properties of the object are cloned, not its transform (position,scale,etc)\n *\n * @return {PIXI.Graphics} A clone of the graphics object\n */", "meta": { "range": [ 6130, 6917 ], "filename": "Graphics.js", "lineno": 204, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100009129", "name": "Graphics#clone", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Creates a new Graphics object with the same values as this one.
", "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "
Note that the only the properties of the object are cloned, not its transform (position,scale,etc)A clone of the graphics object
" } ], "name": "clone", "longname": "PIXI.Graphics#clone", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R000870", "___s": true, "skip": true, "slug": "PIXI.Graphicsclone", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Specifies the line style used for subsequent calls to Graphics methods such as the lineTo()\n * method or the drawCircle() method.\n *\n * @param {number} [lineWidth=0] - width of the line to draw, will update the objects stored style\n * @param {number} [color=0] - color of the line to draw, will update the objects stored style\n * @param {number} [alpha=1] - alpha of the line to draw, will update the objects stored style\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 7472, 8312 ], "filename": "Graphics.js", "lineno": 241, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100009269", "name": "Graphics#lineStyle", "type": "MethodDefinition", "paramnames": [ "lineWidth", "color", "alpha" ] }, "vars": { "": null } }, "description": "Specifies the line style used for subsequent calls to Graphics methods such as the lineTo()
", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "
method or the drawCircle() method.width of the line to draw, will update the objects stored style
", "name": "lineWidth" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "color of the line to draw, will update the objects stored style
", "name": "color" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 1, "description": "alpha of the line to draw, will update the objects stored style
", "name": "alpha" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "lineStyle", "longname": "PIXI.Graphics#lineStyle", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000884", "___s": true, "skip": true, "slug": "PIXI.GraphicslineStyle", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Moves the current drawing position to x, y.\n *\n * @param {number} x - the X coordinate to move to\n * @param {number} y - the Y coordinate to move to\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 8586, 8737 ], "filename": "Graphics.js", "lineno": 277, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100009378", "name": "Graphics#moveTo", "type": "MethodDefinition", "paramnames": [ "x", "y" ] }, "vars": { "": null } }, "description": "Moves the current drawing position to x, y.
", "params": [ { "type": { "names": [ "number" ] }, "description": "the X coordinate to move to
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "the Y coordinate to move to
", "name": "y" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "moveTo", "longname": "PIXI.Graphics#moveTo", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000893", "___s": true, "skip": true, "slug": "PIXI.GraphicsmoveTo", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Draws a line using the current line style from the current drawing position to (x, y);\n * The current drawing position is then set to (x, y).\n *\n * @param {number} x - the X coordinate to draw to\n * @param {number} y - the Y coordinate to draw to\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 9113, 9231 ], "filename": "Graphics.js", "lineno": 295, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100009406", "name": "Graphics#lineTo", "type": "MethodDefinition", "paramnames": [ "x", "y" ] }, "vars": { "": null } }, "description": "Draws a line using the current line style from the current drawing position to (x, y);
", "params": [ { "type": { "names": [ "number" ] }, "description": "
The current drawing position is then set to (x, y).the X coordinate to draw to
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "the Y coordinate to draw to
", "name": "y" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "lineTo", "longname": "PIXI.Graphics#lineTo", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000896", "___s": true, "skip": true, "slug": "PIXI.GraphicslineTo", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Calculate the points for a quadratic bezier curve and then draws it.\n * Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c\n *\n * @param {number} cpX - Control point x\n * @param {number} cpY - Control point y\n * @param {number} toX - Destination point x\n * @param {number} toY - Destination point y\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 9707, 10671 ], "filename": "Graphics.js", "lineno": 313, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100009432", "name": "Graphics#quadraticCurveTo", "type": "MethodDefinition", "paramnames": [ "cpX", "cpY", "toX", "toY" ] }, "vars": { "": null } }, "description": "Calculate the points for a quadratic bezier curve and then draws it.
", "params": [ { "type": { "names": [ "number" ] }, "description": "
Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-cControl point x
", "name": "cpX" }, { "type": { "names": [ "number" ] }, "description": "Control point y
", "name": "cpY" }, { "type": { "names": [ "number" ] }, "description": "Destination point x
", "name": "toX" }, { "type": { "names": [ "number" ] }, "description": "Destination point y
", "name": "toY" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "quadraticCurveTo", "longname": "PIXI.Graphics#quadraticCurveTo", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000897", "___s": true, "skip": true, "slug": "PIXI.GraphicsquadraticCurveTo", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Calculate the points for a bezier curve and then draws it.\n *\n * @param {number} cpX - Control point x\n * @param {number} cpY - Control point y\n * @param {number} cpX2 - Second Control point x\n * @param {number} cpY2 - Second Control point y\n * @param {number} toX - Destination point x\n * @param {number} toY - Destination point y\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 11144, 11765 ], "filename": "Graphics.js", "lineno": 367, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100009609", "name": "Graphics#bezierCurveTo", "type": "MethodDefinition", "paramnames": [ "cpX", "cpY", "cpX2", "cpY2", "toX", "toY" ] }, "vars": { "": null } }, "description": "Calculate the points for a bezier curve and then draws it.
", "params": [ { "type": { "names": [ "number" ] }, "description": "Control point x
", "name": "cpX" }, { "type": { "names": [ "number" ] }, "description": "Control point y
", "name": "cpY" }, { "type": { "names": [ "number" ] }, "description": "Second Control point x
", "name": "cpX2" }, { "type": { "names": [ "number" ] }, "description": "Second Control point y
", "name": "cpY2" }, { "type": { "names": [ "number" ] }, "description": "Destination point x
", "name": "toX" }, { "type": { "names": [ "number" ] }, "description": "Destination point y
", "name": "toY" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "bezierCurveTo", "longname": "PIXI.Graphics#bezierCurveTo", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000909", "___s": true, "skip": true, "slug": "PIXI.GraphicsbezierCurveTo", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The arcTo() method creates an arc/curve between two tangents on the canvas.\n *\n * \"borrowed\" from https://code.google.com/p/fxcanvas/ - thanks google!\n *\n * @param {number} x1 - The x-coordinate of the beginning of the arc\n * @param {number} y1 - The y-coordinate of the beginning of the arc\n * @param {number} x2 - The x-coordinate of the end of the arc\n * @param {number} y2 - The y-coordinate of the end of the arc\n * @param {number} radius - The radius of the arc\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 12378, 14071 ], "filename": "Graphics.js", "lineno": 407, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100009712", "name": "Graphics#arcTo", "type": "MethodDefinition", "paramnames": [ "x1", "y1", "x2", "y2", "radius" ] }, "vars": { "": null } }, "description": "The arcTo() method creates an arc/curve between two tangents on the canvas.
\n"borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!
", "params": [ { "type": { "names": [ "number" ] }, "description": "The x-coordinate of the beginning of the arc
", "name": "x1" }, { "type": { "names": [ "number" ] }, "description": "The y-coordinate of the beginning of the arc
", "name": "y1" }, { "type": { "names": [ "number" ] }, "description": "The x-coordinate of the end of the arc
", "name": "x2" }, { "type": { "names": [ "number" ] }, "description": "The y-coordinate of the end of the arc
", "name": "y2" }, { "type": { "names": [ "number" ] }, "description": "The radius of the arc
", "name": "radius" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "arcTo", "longname": "PIXI.Graphics#arcTo", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000915", "___s": true, "skip": true, "slug": "PIXI.GraphicsarcTo", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The arc method creates an arc/curve (used to create circles, or parts of circles).\n *\n * @param {number} cx - The x-coordinate of the center of the circle\n * @param {number} cy - The y-coordinate of the center of the circle\n * @param {number} radius - The radius of the circle\n * @param {number} startAngle - The starting angle, in radians (0 is at the 3 o'clock position\n * of the arc's circle)\n * @param {number} endAngle - The ending angle, in radians\n * @param {boolean} [anticlockwise=false] - Specifies whether the drawing should be\n * counter-clockwise or clockwise. False is default, and indicates clockwise, while true\n * indicates counter-clockwise.\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 14887, 16813 ], "filename": "Graphics.js", "lineno": 477, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010042", "name": "Graphics#arc", "type": "MethodDefinition", "paramnames": [ "cx", "cy", "radius", "startAngle", "endAngle", "anticlockwise" ] }, "vars": { "": null } }, "description": "The arc method creates an arc/curve (used to create circles, or parts of circles).
", "params": [ { "type": { "names": [ "number" ] }, "description": "The x-coordinate of the center of the circle
", "name": "cx" }, { "type": { "names": [ "number" ] }, "description": "The y-coordinate of the center of the circle
", "name": "cy" }, { "type": { "names": [ "number" ] }, "description": "The radius of the circle
", "name": "radius" }, { "type": { "names": [ "number" ] }, "description": "The starting angle, in radians (0 is at the 3 o'clock position
", "name": "startAngle" }, { "type": { "names": [ "number" ] }, "description": "
of the arc's circle)The ending angle, in radians
", "name": "endAngle" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "Specifies whether the drawing should be
", "name": "anticlockwise" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "
counter-clockwise or clockwise. False is default, and indicates clockwise, while true
indicates counter-clockwise.This Graphics object. Good for chaining method calls
" } ], "name": "arc", "longname": "PIXI.Graphics#arc", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000939", "___s": true, "skip": true, "slug": "PIXI.Graphicsarc", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Specifies a simple one-color fill that subsequent calls to other Graphics methods\n * (such as lineTo() or drawCircle()) use when drawing.\n *\n * @param {number} [color=0] - the color of the fill\n * @param {number} [alpha=1] - the alpha of the fill\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 17189, 17661 ], "filename": "Graphics.js", "lineno": 558, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010338", "name": "Graphics#beginFill", "type": "MethodDefinition", "paramnames": [ "color", "alpha" ] }, "vars": { "": null } }, "description": "Specifies a simple one-color fill that subsequent calls to other Graphics methods
", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "
(such as lineTo() or drawCircle()) use when drawing.the color of the fill
", "name": "color" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 1, "description": "the alpha of the fill
", "name": "alpha" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "beginFill", "longname": "PIXI.Graphics#beginFill", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000959", "___s": true, "skip": true, "slug": "PIXI.GraphicsbeginFill", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.\n *\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 17883, 18015 ], "filename": "Graphics.js", "lineno": 582, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010416", "name": "Graphics#endFill", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.
", "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "endFill", "longname": "PIXI.Graphics#endFill", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R000966", "___s": true, "skip": true, "slug": "PIXI.GraphicsendFill", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n *\n * @param {number} x - The X coord of the top-left of the rectangle\n * @param {number} y - The Y coord of the top-left of the rectangle\n * @param {number} width - The width of the rectangle\n * @param {number} height - The height of the rectangle\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 18390, 18513 ], "filename": "Graphics.js", "lineno": 599, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010440", "name": "Graphics#drawRect", "type": "MethodDefinition", "paramnames": [ "x", "y", "width", "height" ] }, "vars": { "": null } }, "params": [ { "type": { "names": [ "number" ] }, "description": "The X coord of the top-left of the rectangle
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "The Y coord of the top-left of the rectangle
", "name": "y" }, { "type": { "names": [ "number" ] }, "description": "The width of the rectangle
", "name": "width" }, { "type": { "names": [ "number" ] }, "description": "The height of the rectangle
", "name": "height" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "drawRect", "longname": "PIXI.Graphics#drawRect", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000970", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawRect", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n *\n * @param {number} x - The X coord of the top-left of the rectangle\n * @param {number} y - The Y coord of the top-left of the rectangle\n * @param {number} width - The width of the rectangle\n * @param {number} height - The height of the rectangle\n * @param {number} radius - Radius of the rectangle corners\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 18952, 19105 ], "filename": "Graphics.js", "lineno": 615, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010461", "name": "Graphics#drawRoundedRect", "type": "MethodDefinition", "paramnames": [ "x", "y", "width", "height", "radius" ] }, "vars": { "": null } }, "params": [ { "type": { "names": [ "number" ] }, "description": "The X coord of the top-left of the rectangle
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "The Y coord of the top-left of the rectangle
", "name": "y" }, { "type": { "names": [ "number" ] }, "description": "The width of the rectangle
", "name": "width" }, { "type": { "names": [ "number" ] }, "description": "The height of the rectangle
", "name": "height" }, { "type": { "names": [ "number" ] }, "description": "Radius of the rectangle corners
", "name": "radius" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "drawRoundedRect", "longname": "PIXI.Graphics#drawRoundedRect", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000971", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawRoundedRect", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Draws a circle.\n *\n * @param {number} x - The X coordinate of the center of the circle\n * @param {number} y - The Y coordinate of the center of the circle\n * @param {number} radius - The radius of the circle\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 19442, 19550 ], "filename": "Graphics.js", "lineno": 630, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010484", "name": "Graphics#drawCircle", "type": "MethodDefinition", "paramnames": [ "x", "y", "radius" ] }, "vars": { "": null } }, "description": "Draws a circle.
", "params": [ { "type": { "names": [ "number" ] }, "description": "The X coordinate of the center of the circle
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "The Y coordinate of the center of the circle
", "name": "y" }, { "type": { "names": [ "number" ] }, "description": "The radius of the circle
", "name": "radius" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "drawCircle", "longname": "PIXI.Graphics#drawCircle", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000972", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawCircle", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Draws an ellipse.\n *\n * @param {number} x - The X coordinate of the center of the ellipse\n * @param {number} y - The Y coordinate of the center of the ellipse\n * @param {number} width - The half width of the ellipse\n * @param {number} height - The half height of the ellipse\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 19958, 20082 ], "filename": "Graphics.js", "lineno": 646, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010503", "name": "Graphics#drawEllipse", "type": "MethodDefinition", "paramnames": [ "x", "y", "width", "height" ] }, "vars": { "": null } }, "description": "Draws an ellipse.
", "params": [ { "type": { "names": [ "number" ] }, "description": "The X coordinate of the center of the ellipse
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "The Y coordinate of the center of the ellipse
", "name": "y" }, { "type": { "names": [ "number" ] }, "description": "The half width of the ellipse
", "name": "width" }, { "type": { "names": [ "number" ] }, "description": "The half height of the ellipse
", "name": "height" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "drawEllipse", "longname": "PIXI.Graphics#drawEllipse", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000973", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawEllipse", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Draws a polygon using the given path.\n *\n * @param {number[]|PIXI.Point[]} path - The path data used to construct the polygon.\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 20330, 21280 ], "filename": "Graphics.js", "lineno": 659, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010524", "name": "Graphics#drawPolygon", "type": "MethodDefinition", "paramnames": [ "path" ] }, "vars": { "": null } }, "description": "Draws a polygon using the given path.
", "params": [ { "type": { "names": [ "Array.", "Array. " ] }, "description": " The path data used to construct the polygon.
", "name": "path" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "drawPolygon", "longname": "PIXI.Graphics#drawPolygon", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000974", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawPolygon", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.\n *\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 21502, 21907 ], "filename": "Graphics.js", "lineno": 699, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010611", "name": "Graphics#clear", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
", "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "clear", "longname": "PIXI.Graphics#clear", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R000984", "___s": true, "skip": true, "slug": "PIXI.Graphicsclear", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * True if graphics consists of one rectangle, and thus, can be drawn like a Sprite and\n * masked with gl.scissor.\n *\n * @returns {boolean} True if only 1 rect.\n */", "meta": { "range": [ 22106, 22287 ], "filename": "Graphics.js", "lineno": 724, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010683", "name": "Graphics#isFastRect", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "True if graphics consists of one rectangle, and thus, can be drawn like a Sprite and
", "returns": [ { "type": { "names": [ "boolean" ] }, "description": "
masked with gl.scissor.True if only 1 rect.
" } ], "name": "isFastRect", "longname": "PIXI.Graphics#isFastRect", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R000991", "___s": true, "skip": true, "slug": "PIXI.GraphicsisFastRect", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 22442, 23027 ], "filename": "Graphics.js", "lineno": 737, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010718", "name": "Graphics#_renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "Renders the object using the WebGL renderer
", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "The renderer
", "name": "renderer" } ], "name": "_renderWebGL", "longname": "PIXI.Graphics#_renderWebGL", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "overrides": "PIXI.Container#_renderWebGL", "___id": "T000002R000992", "___s": true, "skip": true, "slug": "PIXI.Graphics_renderWebGL", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Renders a sprite rectangle.\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 23166, 24340 ], "filename": "Graphics.js", "lineno": 764, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100010781", "name": "Graphics#_renderSpriteRect", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "Renders a sprite rectangle.
", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "The renderer
", "name": "renderer" } ], "name": "_renderSpriteRect", "longname": "PIXI.Graphics#_renderSpriteRect", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R000995", "___s": true, "skip": true, "slug": "PIXI.Graphics_renderSpriteRect", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 24497, 24655 ], "filename": "Graphics.js", "lineno": 814, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100011000", "name": "Graphics#_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.Graphics#_renderCanvas", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "overrides": "PIXI.Container#_renderCanvas", "___id": "T000002R001012", "___s": true, "skip": true, "slug": "PIXI.Graphics_renderCanvas", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Retrieves the bounds of the graphic shape as a rectangle object\n *\n * @private\n */", "meta": { "range": [ 24771, 25114 ], "filename": "Graphics.js", "lineno": 829, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100011023", "name": "Graphics#_calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Retrieves the bounds of the graphic shape as a rectangle object
", "access": "private", "name": "_calculateBounds", "longname": "PIXI.Graphics#_calculateBounds", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "overrides": "PIXI.Container#_calculateBounds", "___id": "T000002R001013", "___s": true, "skip": true, "slug": "PIXI.Graphics_calculateBounds", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Tests if a point is inside this graphics object\n *\n * @param {PIXI.Point} point - the point to test\n * @return {boolean} the result of the test\n */", "meta": { "range": [ 25299, 25894 ], "filename": "Graphics.js", "lineno": 850, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100011083", "name": "Graphics#containsPoint", "type": "MethodDefinition", "paramnames": [ "point" ] }, "vars": { "": null } }, "description": "Tests if a point is inside this graphics object
", "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.Graphics#containsPoint", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R001017", "___s": true, "skip": true, "slug": "PIXI.GraphicscontainsPoint", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Update the bounds of the object\n *\n */", "meta": { "range": [ 25962, 29872 ], "filename": "Graphics.js", "lineno": 882, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100011152", "name": "Graphics#updateLocalBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Update the bounds of the object
", "name": "updateLocalBounds", "longname": "PIXI.Graphics#updateLocalBounds", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R001021", "___s": true, "skip": true, "slug": "PIXI.GraphicsupdateLocalBounds", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.\n *\n * @param {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} shape - The shape object to draw.\n * @return {PIXI.GraphicsData} The generated GraphicsData object.\n */", "meta": { "range": [ 30209, 30997 ], "filename": "Graphics.js", "lineno": 1011, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100011805", "name": "Graphics#drawShape", "type": "MethodDefinition", "paramnames": [ "shape" ] }, "vars": { "": null } }, "description": "Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.
", "params": [ { "type": { "names": [ "PIXI.Circle", "PIXI.Ellipse", "PIXI.Polygon", "PIXI.Rectangle", "PIXI.RoundedRectangle" ] }, "description": "The shape object to draw.
", "name": "shape" } ], "returns": [ { "type": { "names": [ "PIXI.GraphicsData" ] }, "description": "The generated GraphicsData object.
" } ], "name": "drawShape", "longname": "PIXI.Graphics#drawShape", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R001096", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawShape", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Generates a canvas texture.\n *\n * @param {number} scaleMode - The scale mode of the texture.\n * @param {number} resolution - The resolution of the texture.\n * @return {PIXI.Texture} The new texture.\n */", "meta": { "range": [ 31241, 32053 ], "filename": "Graphics.js", "lineno": 1055, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100011914", "name": "Graphics#generateCanvasTexture", "type": "MethodDefinition", "paramnames": [ "scaleMode", "resolution" ] }, "vars": { "": null } }, "description": "Generates a canvas texture.
", "params": [ { "type": { "names": [ "number" ] }, "description": "The scale mode of the texture.
", "name": "scaleMode" }, { "type": { "names": [ "number" ] }, "description": "The resolution of the texture.
", "name": "resolution", "defaultvalue": 1 } ], "returns": [ { "type": { "names": [ "PIXI.Texture" ] }, "description": "The new texture.
" } ], "name": "generateCanvasTexture", "longname": "PIXI.Graphics#generateCanvasTexture", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R001101", "___s": true, "skip": true, "slug": "PIXI.GraphicsgenerateCanvasTexture", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Closes the current path.\n *\n * @return {PIXI.Graphics} Returns itself.\n */", "meta": { "range": [ 32161, 32414 ], "filename": "Graphics.js", "lineno": 1089, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100012032", "name": "Graphics#closePath", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Closes the current path.
", "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "Returns itself.
" } ], "name": "closePath", "longname": "PIXI.Graphics#closePath", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R001109", "___s": true, "skip": true, "slug": "PIXI.GraphicsclosePath", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Adds a hole in the current path.\n *\n * @return {PIXI.Graphics} Returns itself.\n */", "meta": { "range": [ 32530, 32803 ], "filename": "Graphics.js", "lineno": 1107, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100012058", "name": "Graphics#addHole", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Adds a hole in the current path.
", "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "Returns itself.
" } ], "name": "addHole", "longname": "PIXI.Graphics#addHole", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R001111", "___s": true, "skip": true, "slug": "PIXI.GraphicsaddHole", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Destroys the Graphics object.\n *\n * @param {object|boolean} [options] - Options parameter. A boolean will act as if all\n * options have been set to that value\n * @param {boolean} [options.children=false] - if set to true, all the children will have\n * their destroy 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": [ 33538, 34268 ], "filename": "Graphics.js", "lineno": 1132, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100012105", "name": "Graphics#destroy", "type": "MethodDefinition", "paramnames": [ "options" ] }, "vars": { "": null } }, "description": "Destroys the Graphics object.
", "params": [ { "type": { "names": [ "object", "boolean" ] }, "optional": true, "description": "Options parameter. A boolean will act as if all
", "name": "options" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
options have been set to that valueif set to true, all the children will have
", "name": "options.children" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
their destroy method called as well. 'options' will be passed on to those calls.Only used for child Sprites if options.children is set to true
", "name": "options.texture" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
Should it destroy the texture of the child spriteOnly used for child Sprites if options.children is set to true
", "name": "options.baseTexture" } ], "name": "destroy", "longname": "PIXI.Graphics#destroy", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "overrides": "PIXI.Container#destroy", "___id": "T000002R001115", "___s": true, "skip": true, "slug": "PIXI.Graphicsdestroy", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Creates a new Graphics object with the same values as this one.\n * Note that the only the properties of the object are cloned, not its transform (position,scale,etc)\n *\n * @return {PIXI.Graphics} A clone of the graphics object\n */", "meta": { "range": [ 6130, 6917 ], "filename": "Graphics.js", "lineno": 204, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100083808", "name": "Graphics#clone", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "
Should it destroy the base texture of the child spriteCreates a new Graphics object with the same values as this one.
", "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "
Note that the only the properties of the object are cloned, not its transform (position,scale,etc)A clone of the graphics object
" } ], "name": "clone", "longname": "PIXI.Graphics#clone", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R007804", "___s": true, "skip": true, "slug": "PIXI.Graphicsclone", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Specifies the line style used for subsequent calls to Graphics methods such as the lineTo()\n * method or the drawCircle() method.\n *\n * @param {number} [lineWidth=0] - width of the line to draw, will update the objects stored style\n * @param {number} [color=0] - color of the line to draw, will update the objects stored style\n * @param {number} [alpha=1] - alpha of the line to draw, will update the objects stored style\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 7472, 8312 ], "filename": "Graphics.js", "lineno": 241, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100083948", "name": "Graphics#lineStyle", "type": "MethodDefinition", "paramnames": [ "lineWidth", "color", "alpha" ] }, "vars": { "": null } }, "description": "Specifies the line style used for subsequent calls to Graphics methods such as the lineTo()
", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "
method or the drawCircle() method.width of the line to draw, will update the objects stored style
", "name": "lineWidth" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "color of the line to draw, will update the objects stored style
", "name": "color" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 1, "description": "alpha of the line to draw, will update the objects stored style
", "name": "alpha" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "lineStyle", "longname": "PIXI.Graphics#lineStyle", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007818", "___s": true, "skip": true, "slug": "PIXI.GraphicslineStyle", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Moves the current drawing position to x, y.\n *\n * @param {number} x - the X coordinate to move to\n * @param {number} y - the Y coordinate to move to\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 8586, 8737 ], "filename": "Graphics.js", "lineno": 277, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100084057", "name": "Graphics#moveTo", "type": "MethodDefinition", "paramnames": [ "x", "y" ] }, "vars": { "": null } }, "description": "Moves the current drawing position to x, y.
", "params": [ { "type": { "names": [ "number" ] }, "description": "the X coordinate to move to
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "the Y coordinate to move to
", "name": "y" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "moveTo", "longname": "PIXI.Graphics#moveTo", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007827", "___s": true, "skip": true, "slug": "PIXI.GraphicsmoveTo", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Draws a line using the current line style from the current drawing position to (x, y);\n * The current drawing position is then set to (x, y).\n *\n * @param {number} x - the X coordinate to draw to\n * @param {number} y - the Y coordinate to draw to\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 9113, 9231 ], "filename": "Graphics.js", "lineno": 295, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100084085", "name": "Graphics#lineTo", "type": "MethodDefinition", "paramnames": [ "x", "y" ] }, "vars": { "": null } }, "description": "Draws a line using the current line style from the current drawing position to (x, y);
", "params": [ { "type": { "names": [ "number" ] }, "description": "
The current drawing position is then set to (x, y).the X coordinate to draw to
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "the Y coordinate to draw to
", "name": "y" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "lineTo", "longname": "PIXI.Graphics#lineTo", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007830", "___s": true, "skip": true, "slug": "PIXI.GraphicslineTo", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Calculate the points for a quadratic bezier curve and then draws it.\n * Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c\n *\n * @param {number} cpX - Control point x\n * @param {number} cpY - Control point y\n * @param {number} toX - Destination point x\n * @param {number} toY - Destination point y\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 9707, 10671 ], "filename": "Graphics.js", "lineno": 313, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100084111", "name": "Graphics#quadraticCurveTo", "type": "MethodDefinition", "paramnames": [ "cpX", "cpY", "toX", "toY" ] }, "vars": { "": null } }, "description": "Calculate the points for a quadratic bezier curve and then draws it.
", "params": [ { "type": { "names": [ "number" ] }, "description": "
Based on: https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-cControl point x
", "name": "cpX" }, { "type": { "names": [ "number" ] }, "description": "Control point y
", "name": "cpY" }, { "type": { "names": [ "number" ] }, "description": "Destination point x
", "name": "toX" }, { "type": { "names": [ "number" ] }, "description": "Destination point y
", "name": "toY" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "quadraticCurveTo", "longname": "PIXI.Graphics#quadraticCurveTo", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007831", "___s": true, "skip": true, "slug": "PIXI.GraphicsquadraticCurveTo", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Calculate the points for a bezier curve and then draws it.\n *\n * @param {number} cpX - Control point x\n * @param {number} cpY - Control point y\n * @param {number} cpX2 - Second Control point x\n * @param {number} cpY2 - Second Control point y\n * @param {number} toX - Destination point x\n * @param {number} toY - Destination point y\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 11144, 11765 ], "filename": "Graphics.js", "lineno": 367, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100084288", "name": "Graphics#bezierCurveTo", "type": "MethodDefinition", "paramnames": [ "cpX", "cpY", "cpX2", "cpY2", "toX", "toY" ] }, "vars": { "": null } }, "description": "Calculate the points for a bezier curve and then draws it.
", "params": [ { "type": { "names": [ "number" ] }, "description": "Control point x
", "name": "cpX" }, { "type": { "names": [ "number" ] }, "description": "Control point y
", "name": "cpY" }, { "type": { "names": [ "number" ] }, "description": "Second Control point x
", "name": "cpX2" }, { "type": { "names": [ "number" ] }, "description": "Second Control point y
", "name": "cpY2" }, { "type": { "names": [ "number" ] }, "description": "Destination point x
", "name": "toX" }, { "type": { "names": [ "number" ] }, "description": "Destination point y
", "name": "toY" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "bezierCurveTo", "longname": "PIXI.Graphics#bezierCurveTo", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007843", "___s": true, "skip": true, "slug": "PIXI.GraphicsbezierCurveTo", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The arcTo() method creates an arc/curve between two tangents on the canvas.\n *\n * \"borrowed\" from https://code.google.com/p/fxcanvas/ - thanks google!\n *\n * @param {number} x1 - The x-coordinate of the beginning of the arc\n * @param {number} y1 - The y-coordinate of the beginning of the arc\n * @param {number} x2 - The x-coordinate of the end of the arc\n * @param {number} y2 - The y-coordinate of the end of the arc\n * @param {number} radius - The radius of the arc\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 12378, 14071 ], "filename": "Graphics.js", "lineno": 407, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100084391", "name": "Graphics#arcTo", "type": "MethodDefinition", "paramnames": [ "x1", "y1", "x2", "y2", "radius" ] }, "vars": { "": null } }, "description": "The arcTo() method creates an arc/curve between two tangents on the canvas.
\n"borrowed" from https://code.google.com/p/fxcanvas/ - thanks google!
", "params": [ { "type": { "names": [ "number" ] }, "description": "The x-coordinate of the beginning of the arc
", "name": "x1" }, { "type": { "names": [ "number" ] }, "description": "The y-coordinate of the beginning of the arc
", "name": "y1" }, { "type": { "names": [ "number" ] }, "description": "The x-coordinate of the end of the arc
", "name": "x2" }, { "type": { "names": [ "number" ] }, "description": "The y-coordinate of the end of the arc
", "name": "y2" }, { "type": { "names": [ "number" ] }, "description": "The radius of the arc
", "name": "radius" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "arcTo", "longname": "PIXI.Graphics#arcTo", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007849", "___s": true, "skip": true, "slug": "PIXI.GraphicsarcTo", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The arc method creates an arc/curve (used to create circles, or parts of circles).\n *\n * @param {number} cx - The x-coordinate of the center of the circle\n * @param {number} cy - The y-coordinate of the center of the circle\n * @param {number} radius - The radius of the circle\n * @param {number} startAngle - The starting angle, in radians (0 is at the 3 o'clock position\n * of the arc's circle)\n * @param {number} endAngle - The ending angle, in radians\n * @param {boolean} [anticlockwise=false] - Specifies whether the drawing should be\n * counter-clockwise or clockwise. False is default, and indicates clockwise, while true\n * indicates counter-clockwise.\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 14887, 16813 ], "filename": "Graphics.js", "lineno": 477, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100084721", "name": "Graphics#arc", "type": "MethodDefinition", "paramnames": [ "cx", "cy", "radius", "startAngle", "endAngle", "anticlockwise" ] }, "vars": { "": null } }, "description": "The arc method creates an arc/curve (used to create circles, or parts of circles).
", "params": [ { "type": { "names": [ "number" ] }, "description": "The x-coordinate of the center of the circle
", "name": "cx" }, { "type": { "names": [ "number" ] }, "description": "The y-coordinate of the center of the circle
", "name": "cy" }, { "type": { "names": [ "number" ] }, "description": "The radius of the circle
", "name": "radius" }, { "type": { "names": [ "number" ] }, "description": "The starting angle, in radians (0 is at the 3 o'clock position
", "name": "startAngle" }, { "type": { "names": [ "number" ] }, "description": "
of the arc's circle)The ending angle, in radians
", "name": "endAngle" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "Specifies whether the drawing should be
", "name": "anticlockwise" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "
counter-clockwise or clockwise. False is default, and indicates clockwise, while true
indicates counter-clockwise.This Graphics object. Good for chaining method calls
" } ], "name": "arc", "longname": "PIXI.Graphics#arc", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007873", "___s": true, "skip": true, "slug": "PIXI.Graphicsarc", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Specifies a simple one-color fill that subsequent calls to other Graphics methods\n * (such as lineTo() or drawCircle()) use when drawing.\n *\n * @param {number} [color=0] - the color of the fill\n * @param {number} [alpha=1] - the alpha of the fill\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 17189, 17661 ], "filename": "Graphics.js", "lineno": 558, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085017", "name": "Graphics#beginFill", "type": "MethodDefinition", "paramnames": [ "color", "alpha" ] }, "vars": { "": null } }, "description": "Specifies a simple one-color fill that subsequent calls to other Graphics methods
", "params": [ { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 0, "description": "
(such as lineTo() or drawCircle()) use when drawing.the color of the fill
", "name": "color" }, { "type": { "names": [ "number" ] }, "optional": true, "defaultvalue": 1, "description": "the alpha of the fill
", "name": "alpha" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "beginFill", "longname": "PIXI.Graphics#beginFill", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007893", "___s": true, "skip": true, "slug": "PIXI.GraphicsbeginFill", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.\n *\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 17883, 18015 ], "filename": "Graphics.js", "lineno": 582, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085095", "name": "Graphics#endFill", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Applies a fill to the lines and shapes that were added since the last call to the beginFill() method.
", "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "endFill", "longname": "PIXI.Graphics#endFill", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R007900", "___s": true, "skip": true, "slug": "PIXI.GraphicsendFill", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n *\n * @param {number} x - The X coord of the top-left of the rectangle\n * @param {number} y - The Y coord of the top-left of the rectangle\n * @param {number} width - The width of the rectangle\n * @param {number} height - The height of the rectangle\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 18390, 18513 ], "filename": "Graphics.js", "lineno": 599, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085119", "name": "Graphics#drawRect", "type": "MethodDefinition", "paramnames": [ "x", "y", "width", "height" ] }, "vars": { "": null } }, "params": [ { "type": { "names": [ "number" ] }, "description": "The X coord of the top-left of the rectangle
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "The Y coord of the top-left of the rectangle
", "name": "y" }, { "type": { "names": [ "number" ] }, "description": "The width of the rectangle
", "name": "width" }, { "type": { "names": [ "number" ] }, "description": "The height of the rectangle
", "name": "height" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "drawRect", "longname": "PIXI.Graphics#drawRect", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007904", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawRect", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n *\n * @param {number} x - The X coord of the top-left of the rectangle\n * @param {number} y - The Y coord of the top-left of the rectangle\n * @param {number} width - The width of the rectangle\n * @param {number} height - The height of the rectangle\n * @param {number} radius - Radius of the rectangle corners\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 18952, 19105 ], "filename": "Graphics.js", "lineno": 615, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085140", "name": "Graphics#drawRoundedRect", "type": "MethodDefinition", "paramnames": [ "x", "y", "width", "height", "radius" ] }, "vars": { "": null } }, "params": [ { "type": { "names": [ "number" ] }, "description": "The X coord of the top-left of the rectangle
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "The Y coord of the top-left of the rectangle
", "name": "y" }, { "type": { "names": [ "number" ] }, "description": "The width of the rectangle
", "name": "width" }, { "type": { "names": [ "number" ] }, "description": "The height of the rectangle
", "name": "height" }, { "type": { "names": [ "number" ] }, "description": "Radius of the rectangle corners
", "name": "radius" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "drawRoundedRect", "longname": "PIXI.Graphics#drawRoundedRect", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007905", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawRoundedRect", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Draws a circle.\n *\n * @param {number} x - The X coordinate of the center of the circle\n * @param {number} y - The Y coordinate of the center of the circle\n * @param {number} radius - The radius of the circle\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 19442, 19550 ], "filename": "Graphics.js", "lineno": 630, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085163", "name": "Graphics#drawCircle", "type": "MethodDefinition", "paramnames": [ "x", "y", "radius" ] }, "vars": { "": null } }, "description": "Draws a circle.
", "params": [ { "type": { "names": [ "number" ] }, "description": "The X coordinate of the center of the circle
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "The Y coordinate of the center of the circle
", "name": "y" }, { "type": { "names": [ "number" ] }, "description": "The radius of the circle
", "name": "radius" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "drawCircle", "longname": "PIXI.Graphics#drawCircle", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007906", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawCircle", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Draws an ellipse.\n *\n * @param {number} x - The X coordinate of the center of the ellipse\n * @param {number} y - The Y coordinate of the center of the ellipse\n * @param {number} width - The half width of the ellipse\n * @param {number} height - The half height of the ellipse\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 19958, 20082 ], "filename": "Graphics.js", "lineno": 646, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085182", "name": "Graphics#drawEllipse", "type": "MethodDefinition", "paramnames": [ "x", "y", "width", "height" ] }, "vars": { "": null } }, "description": "Draws an ellipse.
", "params": [ { "type": { "names": [ "number" ] }, "description": "The X coordinate of the center of the ellipse
", "name": "x" }, { "type": { "names": [ "number" ] }, "description": "The Y coordinate of the center of the ellipse
", "name": "y" }, { "type": { "names": [ "number" ] }, "description": "The half width of the ellipse
", "name": "width" }, { "type": { "names": [ "number" ] }, "description": "The half height of the ellipse
", "name": "height" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "drawEllipse", "longname": "PIXI.Graphics#drawEllipse", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007907", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawEllipse", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Draws a polygon using the given path.\n *\n * @param {number[]|PIXI.Point[]} path - The path data used to construct the polygon.\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 20330, 21280 ], "filename": "Graphics.js", "lineno": 659, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085203", "name": "Graphics#drawPolygon", "type": "MethodDefinition", "paramnames": [ "path" ] }, "vars": { "": null } }, "description": "Draws a polygon using the given path.
", "params": [ { "type": { "names": [ "Array.", "Array. " ] }, "description": " The path data used to construct the polygon.
", "name": "path" } ], "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "drawPolygon", "longname": "PIXI.Graphics#drawPolygon", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007908", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawPolygon", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.\n *\n * @return {PIXI.Graphics} This Graphics object. Good for chaining method calls\n */", "meta": { "range": [ 21502, 21907 ], "filename": "Graphics.js", "lineno": 699, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085290", "name": "Graphics#clear", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Clears the graphics that were drawn to this Graphics object, and resets fill and line style settings.
", "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "This Graphics object. Good for chaining method calls
" } ], "name": "clear", "longname": "PIXI.Graphics#clear", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R007918", "___s": true, "skip": true, "slug": "PIXI.Graphicsclear", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * True if graphics consists of one rectangle, and thus, can be drawn like a Sprite and\n * masked with gl.scissor.\n *\n * @returns {boolean} True if only 1 rect.\n */", "meta": { "range": [ 22106, 22287 ], "filename": "Graphics.js", "lineno": 724, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085362", "name": "Graphics#isFastRect", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "True if graphics consists of one rectangle, and thus, can be drawn like a Sprite and
", "returns": [ { "type": { "names": [ "boolean" ] }, "description": "
masked with gl.scissor.True if only 1 rect.
" } ], "name": "isFastRect", "longname": "PIXI.Graphics#isFastRect", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R007925", "___s": true, "skip": true, "slug": "PIXI.GraphicsisFastRect", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Renders the object using the WebGL renderer\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 22442, 23027 ], "filename": "Graphics.js", "lineno": 737, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085397", "name": "Graphics#_renderWebGL", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "Renders the object using the WebGL renderer
", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "The renderer
", "name": "renderer" } ], "name": "_renderWebGL", "longname": "PIXI.Graphics#_renderWebGL", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "overrides": "PIXI.Container#_renderWebGL", "___id": "T000002R007926", "___s": true, "skip": true, "slug": "PIXI.Graphics_renderWebGL", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Renders a sprite rectangle.\n *\n * @private\n * @param {PIXI.WebGLRenderer} renderer - The renderer\n */", "meta": { "range": [ 23166, 24340 ], "filename": "Graphics.js", "lineno": 764, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085460", "name": "Graphics#_renderSpriteRect", "type": "MethodDefinition", "paramnames": [ "renderer" ] }, "vars": { "": null } }, "description": "Renders a sprite rectangle.
", "access": "private", "params": [ { "type": { "names": [ "PIXI.WebGLRenderer" ] }, "description": "The renderer
", "name": "renderer" } ], "name": "_renderSpriteRect", "longname": "PIXI.Graphics#_renderSpriteRect", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007929", "___s": true, "skip": true, "slug": "PIXI.Graphics_renderSpriteRect", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Renders the object using the Canvas renderer\n *\n * @private\n * @param {PIXI.CanvasRenderer} renderer - The renderer\n */", "meta": { "range": [ 24497, 24655 ], "filename": "Graphics.js", "lineno": 814, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085679", "name": "Graphics#_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.Graphics#_renderCanvas", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "overrides": "PIXI.Container#_renderCanvas", "___id": "T000002R007946", "___s": true, "skip": true, "slug": "PIXI.Graphics_renderCanvas", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Retrieves the bounds of the graphic shape as a rectangle object\n *\n * @private\n */", "meta": { "range": [ 24771, 25114 ], "filename": "Graphics.js", "lineno": 829, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085702", "name": "Graphics#_calculateBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Retrieves the bounds of the graphic shape as a rectangle object
", "access": "private", "name": "_calculateBounds", "longname": "PIXI.Graphics#_calculateBounds", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "overrides": "PIXI.Container#_calculateBounds", "___id": "T000002R007947", "___s": true, "skip": true, "slug": "PIXI.Graphics_calculateBounds", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Tests if a point is inside this graphics object\n *\n * @param {PIXI.Point} point - the point to test\n * @return {boolean} the result of the test\n */", "meta": { "range": [ 25299, 25894 ], "filename": "Graphics.js", "lineno": 850, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085762", "name": "Graphics#containsPoint", "type": "MethodDefinition", "paramnames": [ "point" ] }, "vars": { "": null } }, "description": "Tests if a point is inside this graphics object
", "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.Graphics#containsPoint", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R007951", "___s": true, "skip": true, "slug": "PIXI.GraphicscontainsPoint", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Update the bounds of the object\n *\n */", "meta": { "range": [ 25962, 29872 ], "filename": "Graphics.js", "lineno": 882, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100085831", "name": "Graphics#updateLocalBounds", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Update the bounds of the object
", "name": "updateLocalBounds", "longname": "PIXI.Graphics#updateLocalBounds", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R007955", "___s": true, "skip": true, "slug": "PIXI.GraphicsupdateLocalBounds", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.\n *\n * @param {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} shape - The shape object to draw.\n * @return {PIXI.GraphicsData} The generated GraphicsData object.\n */", "meta": { "range": [ 30209, 30997 ], "filename": "Graphics.js", "lineno": 1011, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100086484", "name": "Graphics#drawShape", "type": "MethodDefinition", "paramnames": [ "shape" ] }, "vars": { "": null } }, "description": "Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon.
", "params": [ { "type": { "names": [ "PIXI.Circle", "PIXI.Ellipse", "PIXI.Polygon", "PIXI.Rectangle", "PIXI.RoundedRectangle" ] }, "description": "The shape object to draw.
", "name": "shape" } ], "returns": [ { "type": { "names": [ "PIXI.GraphicsData" ] }, "description": "The generated GraphicsData object.
" } ], "name": "drawShape", "longname": "PIXI.Graphics#drawShape", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R008030", "___s": true, "skip": true, "slug": "PIXI.GraphicsdrawShape", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Generates a canvas texture.\n *\n * @param {number} scaleMode - The scale mode of the texture.\n * @param {number} resolution - The resolution of the texture.\n * @return {PIXI.Texture} The new texture.\n */", "meta": { "range": [ 31241, 32053 ], "filename": "Graphics.js", "lineno": 1055, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100086593", "name": "Graphics#generateCanvasTexture", "type": "MethodDefinition", "paramnames": [ "scaleMode", "resolution" ] }, "vars": { "": null } }, "description": "Generates a canvas texture.
", "params": [ { "type": { "names": [ "number" ] }, "description": "The scale mode of the texture.
", "name": "scaleMode" }, { "type": { "names": [ "number" ] }, "description": "The resolution of the texture.
", "name": "resolution", "defaultvalue": 1 } ], "returns": [ { "type": { "names": [ "PIXI.Texture" ] }, "description": "The new texture.
" } ], "name": "generateCanvasTexture", "longname": "PIXI.Graphics#generateCanvasTexture", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "___id": "T000002R008035", "___s": true, "skip": true, "slug": "PIXI.GraphicsgenerateCanvasTexture", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Closes the current path.\n *\n * @return {PIXI.Graphics} Returns itself.\n */", "meta": { "range": [ 32161, 32414 ], "filename": "Graphics.js", "lineno": 1089, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100086711", "name": "Graphics#closePath", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Closes the current path.
", "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "Returns itself.
" } ], "name": "closePath", "longname": "PIXI.Graphics#closePath", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R008043", "___s": true, "skip": true, "slug": "PIXI.GraphicsclosePath", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Adds a hole in the current path.\n *\n * @return {PIXI.Graphics} Returns itself.\n */", "meta": { "range": [ 32530, 32803 ], "filename": "Graphics.js", "lineno": 1107, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100086737", "name": "Graphics#addHole", "type": "MethodDefinition", "paramnames": [] }, "vars": { "": null } }, "description": "Adds a hole in the current path.
", "returns": [ { "type": { "names": [ "PIXI.Graphics" ] }, "description": "Returns itself.
" } ], "name": "addHole", "longname": "PIXI.Graphics#addHole", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "___id": "T000002R008045", "___s": true, "skip": true, "slug": "PIXI.GraphicsaddHole", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Destroys the Graphics object.\n *\n * @param {object|boolean} [options] - Options parameter. A boolean will act as if all\n * options have been set to that value\n * @param {boolean} [options.children=false] - if set to true, all the children will have\n * their destroy 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": [ 33538, 34268 ], "filename": "Graphics.js", "lineno": 1132, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": { "id": "astnode100086784", "name": "Graphics#destroy", "type": "MethodDefinition", "paramnames": [ "options" ] }, "vars": { "": null } }, "description": "Destroys the Graphics object.
", "params": [ { "type": { "names": [ "object", "boolean" ] }, "optional": true, "description": "Options parameter. A boolean will act as if all
", "name": "options" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
options have been set to that valueif set to true, all the children will have
", "name": "options.children" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
their destroy method called as well. 'options' will be passed on to those calls.Only used for child Sprites if options.children is set to true
", "name": "options.texture" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
Should it destroy the texture of the child spriteOnly used for child Sprites if options.children is set to true
", "name": "options.baseTexture" } ], "name": "destroy", "longname": "PIXI.Graphics#destroy", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "overrides": "PIXI.Container#destroy", "___id": "T000002R008049", "___s": true, "skip": true, "slug": "PIXI.Graphicsdestroy", "filepath": "core\\graphics\\Graphics.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": "
Should it destroy the base texture of the child spriteOverridable method that can be used by Container subclasses whenever the children array is modified
", "access": "private", "name": "onChildrenChange", "longname": "PIXI.Graphics#onChildrenChange", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.Container#onChildrenChange", "inherited": true, "overrides": "PIXI.Container#onChildrenChange", "___id": "T000002R013909", "___s": true, "skip": true, "slug": "PIXI.GraphicsonChildrenChange", "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.
\nMultiple items can be added like so:
", "params": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "variable": true, "description": "myContainer.addChild(thingOne, thingTwo, thingThree)
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.Graphics#addChild", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#addChild", "inherited": true, "overrides": "PIXI.Container#addChild", "___id": "T000002R013910", "___s": true, "skip": true, "slug": "PIXI.GraphicsaddChild", "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.Graphics#addChildAt", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#addChildAt", "inherited": true, "overrides": "PIXI.Container#addChildAt", "___id": "T000002R013911", "___s": true, "skip": true, "slug": "PIXI.GraphicsaddChildAt", "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.Graphics#swapChildren", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#swapChildren", "inherited": true, "overrides": "PIXI.Container#swapChildren", "___id": "T000002R013912", "___s": true, "skip": true, "slug": "PIXI.GraphicsswapChildren", "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.Graphics#getChildIndex", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#getChildIndex", "inherited": true, "overrides": "PIXI.Container#getChildIndex", "___id": "T000002R013913", "___s": true, "skip": true, "slug": "PIXI.GraphicsgetChildIndex", "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.Graphics#setChildIndex", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#setChildIndex", "inherited": true, "overrides": "PIXI.Container#setChildIndex", "___id": "T000002R013914", "___s": true, "skip": true, "slug": "PIXI.GraphicssetChildIndex", "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.Graphics#getChildAt", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#getChildAt", "inherited": true, "overrides": "PIXI.Container#getChildAt", "___id": "T000002R013915", "___s": true, "skip": true, "slug": "PIXI.GraphicsgetChildAt", "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.Graphics#removeChild", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#removeChild", "inherited": true, "overrides": "PIXI.Container#removeChild", "___id": "T000002R013916", "___s": true, "skip": true, "slug": "PIXI.GraphicsremoveChild", "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.Graphics#removeChildAt", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#removeChildAt", "inherited": true, "overrides": "PIXI.Container#removeChildAt", "___id": "T000002R013917", "___s": true, "skip": true, "slug": "PIXI.GraphicsremoveChildAt", "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.Graphics#removeChildren", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#removeChildren", "inherited": true, "overrides": "PIXI.Container#removeChildren", "___id": "T000002R013918", "___s": true, "skip": true, "slug": "PIXI.GraphicsremoveChildren", "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.Graphics#updateTransform", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.Container#updateTransform", "inherited": true, "overrides": "PIXI.Container#updateTransform", "___id": "T000002R013919", "___s": true, "skip": true, "slug": "PIXI.GraphicsupdateTransform", "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.Graphics#calculateBounds", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.Container#calculateBounds", "inherited": true, "overrides": "PIXI.Container#calculateBounds", "___id": "T000002R013920", "___s": true, "skip": true, "slug": "PIXI.GraphicscalculateBounds", "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.Graphics#renderWebGL", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#renderWebGL", "inherited": true, "overrides": "PIXI.Container#renderWebGL", "___id": "T000002R013921", "___s": true, "skip": true, "slug": "PIXI.GraphicsrenderWebGL", "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.Graphics#renderAdvancedWebGL", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#renderAdvancedWebGL", "inherited": true, "overrides": "PIXI.Container#renderAdvancedWebGL", "___id": "T000002R013922", "___s": true, "skip": true, "slug": "PIXI.GraphicsrenderAdvancedWebGL", "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.Graphics#renderCanvas", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.Container#renderCanvas", "inherited": true, "overrides": "PIXI.Container#renderCanvas", "___id": "T000002R013923", "___s": true, "skip": true, "slug": "PIXI.GraphicsrenderCanvas", "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.Graphics#width", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.Container#width", "inherited": true, "overrides": "PIXI.Container#width", "___id": "T000002R013924", "___s": true, "skip": true, "slug": "PIXI.Graphicswidth", "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.Graphics#height", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.Container#height", "inherited": true, "overrides": "PIXI.Container#height", "___id": "T000002R013925", "___s": true, "skip": true, "slug": "PIXI.Graphicsheight", "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.Graphics#_tempDisplayObjectParent", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#_tempDisplayObjectParent", "inherited": true, "overrides": "PIXI.Container#_tempDisplayObjectParent", "___id": "T000002R013936", "___s": true, "skip": true, "slug": "PIXI.Graphics_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
", "name": "_recursivePostUpdateTransform", "longname": "PIXI.Graphics#_recursivePostUpdateTransform", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#_recursivePostUpdateTransform", "inherited": true, "overrides": "PIXI.Container#_recursivePostUpdateTransform", "___id": "T000002R013937", "___s": true, "skip": true, "slug": "PIXI.Graphics_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": "
internal function for toLocal()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
", "name": "skipUpdate" }, { "type": { "names": [ "PIXI.Rectangle" ] }, "description": "
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boostOptional 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.Graphics#getBounds", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.DisplayObject#getBounds", "inherited": true, "overrides": "PIXI.Container#getBounds", "___id": "T000002R013938", "___s": true, "skip": true, "slug": "PIXI.GraphicsgetBounds", "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.Graphics#getLocalBounds", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.DisplayObject#getLocalBounds", "inherited": true, "overrides": "PIXI.Container#getLocalBounds", "___id": "T000002R013939", "___s": true, "skip": true, "slug": "PIXI.GraphicsgetLocalBounds", "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
", "name": "point" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
(otherwise will create a new Point)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.Graphics#toGlobal", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.DisplayObject#toGlobal", "inherited": true, "overrides": "PIXI.Container#toGlobal", "___id": "T000002R013940", "___s": true, "skip": true, "slug": "PIXI.GraphicstoGlobal", "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
", "name": "point" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
(otherwise will create a new Point)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.Graphics#toLocal", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.DisplayObject#toLocal", "inherited": true, "overrides": "PIXI.Container#toLocal", "___id": "T000002R013941", "___s": true, "skip": true, "slug": "PIXI.GraphicstoLocal", "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.Graphics#setParent", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.DisplayObject#setParent", "inherited": true, "overrides": "PIXI.Container#setParent", "___id": "T000002R013942", "___s": true, "skip": true, "slug": "PIXI.GraphicssetParent", "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.Graphics#setTransform", "kind": "function", "memberof": "PIXI.Graphics", "scope": "instance", "inherits": "PIXI.DisplayObject#setTransform", "inherited": true, "overrides": "PIXI.Container#setTransform", "___id": "T000002R013943", "___s": true, "skip": true, "slug": "PIXI.GraphicssetTransform", "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.
", "kind": "member", "type": { "names": [ "number" ] }, "name": "x", "longname": "PIXI.Graphics#x", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#x", "inherited": true, "overrides": "PIXI.Container#x", "___id": "T000002R013944", "___s": true, "skip": true, "slug": "PIXI.Graphicsx", "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": "
An alias to position.xThe position of the displayObject on the y axis relative to the local coordinates of the parent.
", "kind": "member", "type": { "names": [ "number" ] }, "name": "y", "longname": "PIXI.Graphics#y", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#y", "inherited": true, "overrides": "PIXI.Container#y", "___id": "T000002R013945", "___s": true, "skip": true, "slug": "PIXI.Graphicsy", "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": "
An alias to position.yCurrent transform of the object based on world (parent) factors
", "kind": "member", "type": { "names": [ "PIXI.Matrix" ] }, "readonly": true, "name": "worldTransform", "longname": "PIXI.Graphics#worldTransform", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#worldTransform", "inherited": true, "overrides": "PIXI.Container#worldTransform", "___id": "T000002R013946", "___s": true, "skip": true, "slug": "PIXI.GraphicsworldTransform", "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.Graphics#localTransform", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#localTransform", "inherited": true, "overrides": "PIXI.Container#localTransform", "___id": "T000002R013947", "___s": true, "skip": true, "slug": "PIXI.GraphicslocalTransform", "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.
", "kind": "member", "type": { "names": [ "PIXI.Point", "PIXI.ObservablePoint" ] }, "name": "position", "longname": "PIXI.Graphics#position", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#position", "inherited": true, "overrides": "PIXI.Container#position", "___id": "T000002R013948", "___s": true, "skip": true, "slug": "PIXI.Graphicsposition", "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": "
Assignment by value since pixi-v4.The scale factor of the object.
", "kind": "member", "type": { "names": [ "PIXI.Point", "PIXI.ObservablePoint" ] }, "name": "scale", "longname": "PIXI.Graphics#scale", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#scale", "inherited": true, "overrides": "PIXI.Container#scale", "___id": "T000002R013949", "___s": true, "skip": true, "slug": "PIXI.Graphicsscale", "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": "
Assignment by value since pixi-v4.The pivot point of the displayObject that it rotates around
", "kind": "member", "type": { "names": [ "PIXI.Point", "PIXI.ObservablePoint" ] }, "name": "pivot", "longname": "PIXI.Graphics#pivot", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#pivot", "inherited": true, "overrides": "PIXI.Container#pivot", "___id": "T000002R013950", "___s": true, "skip": true, "slug": "PIXI.Graphicspivot", "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": "
Assignment by value since pixi-v4.The skew factor for the object in radians.
", "kind": "member", "type": { "names": [ "PIXI.ObservablePoint" ] }, "name": "skew", "longname": "PIXI.Graphics#skew", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#skew", "inherited": true, "overrides": "PIXI.Container#skew", "___id": "T000002R013951", "___s": true, "skip": true, "slug": "PIXI.Graphicsskew", "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": "
Assignment by value since pixi-v4.The rotation of the object in radians.
", "kind": "member", "type": { "names": [ "number" ] }, "name": "rotation", "longname": "PIXI.Graphics#rotation", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#rotation", "inherited": true, "overrides": "PIXI.Container#rotation", "___id": "T000002R013952", "___s": true, "skip": true, "slug": "PIXI.Graphicsrotation", "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.Graphics#worldVisible", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#worldVisible", "inherited": true, "overrides": "PIXI.Container#worldVisible", "___id": "T000002R013953", "___s": true, "skip": true, "slug": "PIXI.GraphicsworldVisible", "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
", "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.Graphics#mask", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#mask", "inherited": true, "overrides": "PIXI.Container#mask", "___id": "T000002R013954", "___s": true, "skip": true, "slug": "PIXI.Graphicsmask", "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": "
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.Sets the filters for the displayObject.
\n\n
", "kind": "member", "type": { "names": [ "Array.- 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'" ] }, "name": "filters", "longname": "PIXI.Graphics#filters", "memberof": "PIXI.Graphics", "scope": "instance", "params": [], "inherits": "PIXI.DisplayObject#filters", "inherited": true, "overrides": "PIXI.Container#filters", "___id": "T000002R013955", "___s": true, "skip": true, "slug": "PIXI.Graphicsfilters", "filepath": "core\\display\\DisplayObject.js" } ], "$attributes": [ { "comment": "/**\n * The alpha value used when filling the Graphics object.\n *\n * @member {number} PIXI.Graphics#fillAlpha\n * @default 1\n */", "meta": { "range": [ 1226, 1392 ], "filename": "Graphics.js", "lineno": 39, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": " The alpha value used when filling the Graphics object.
", "kind": "member", "name": "fillAlpha", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#fillAlpha", "scope": "instance", "___id": "T000002R000835", "___s": true, "skip": true, "slug": "PIXI.GraphicsfillAlpha", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The width (thickness) of any lines drawn.\n *\n * @member {number} PIXI.Graphics#lineWidth\n * @default 0\n */", "meta": { "range": [ 1430, 1583 ], "filename": "Graphics.js", "lineno": 47, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "The width (thickness) of any lines drawn.
", "kind": "member", "name": "lineWidth", "type": { "names": [ "number" ] }, "defaultvalue": "0", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#lineWidth", "scope": "instance", "___id": "T000002R000837", "___s": true, "skip": true, "slug": "PIXI.GraphicslineWidth", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * If true the lines will be draw using LINES instead of TRIANGLE_STRIP\n *\n * @member {boolean} PIXI.Graphics#nativeLines\n */", "meta": { "range": [ 1621, 1782 ], "filename": "Graphics.js", "lineno": 55, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "If true the lines will be draw using LINES instead of TRIANGLE_STRIP
", "kind": "member", "name": "nativeLines", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#nativeLines", "scope": "instance", "___id": "T000002R000839", "___s": true, "skip": true, "slug": "PIXI.GraphicsnativeLines", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The color of any lines drawn.\n *\n * @member {string} PIXI.Graphics#lineColor\n * @default 0\n */", "meta": { "range": [ 1832, 1973 ], "filename": "Graphics.js", "lineno": 62, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "The color of any lines drawn.
", "kind": "member", "name": "lineColor", "type": { "names": [ "string" ] }, "defaultvalue": "0", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#lineColor", "scope": "instance", "___id": "T000002R000841", "___s": true, "skip": true, "slug": "PIXI.GraphicslineColor", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Graphics data\n *\n * @member {PIXI.GraphicsData[]} PIXI.Graphics#graphicsData\n * @private\n */", "meta": { "range": [ 2011, 2150 ], "filename": "Graphics.js", "lineno": 70, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "Graphics data
", "kind": "member", "name": "graphicsData", "type": { "names": [ "Array." ] }, "access": "private", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#graphicsData", "scope": "instance", "___id": "T000002R000843", "___s": true, "skip": true, "slug": "PIXI.GraphicsgraphicsData", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to\n * reset the tint.\n *\n * @member {number} PIXI.Graphics#tint\n * @default 0xFFFFFF\n */", "meta": { "range": [ 2192, 2421 ], "filename": "Graphics.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": " The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to
", "kind": "member", "name": "tint", "type": { "names": [ "number" ] }, "defaultvalue": "0xFFFFFF", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#tint", "scope": "instance", "___id": "T000002R000845", "___s": true, "skip": true, "slug": "PIXI.Graphicstint", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The previous tint applied to the graphic shape. Used to compare to the current tint and\n * check if theres change.\n *\n * @member {number} PIXI.Graphics#_prevTint\n * @private\n * @default 0xFFFFFF\n */", "meta": { "range": [ 2461, 2722 ], "filename": "Graphics.js", "lineno": 87, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "
reset the tint.The previous tint applied to the graphic shape. Used to compare to the current tint and
", "kind": "member", "name": "_prevTint", "type": { "names": [ "number" ] }, "access": "private", "defaultvalue": "0xFFFFFF", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#_prevTint", "scope": "instance", "___id": "T000002R000847", "___s": true, "skip": true, "slug": "PIXI.Graphics_prevTint", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The blend mode to be applied to the graphic shape. Apply a value of\n * `PIXI.BLEND_MODES.NORMAL` to reset the blend mode.\n *\n * @member {number} PIXI.Graphics#blendMode\n * @default PIXI.BLEND_MODES.NORMAL;\n * @see PIXI.BLEND_MODES\n */", "meta": { "range": [ 2767, 3064 ], "filename": "Graphics.js", "lineno": 97, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "
check if theres change.The blend mode to be applied to the graphic shape. Apply a value of
", "kind": "member", "name": "blendMode", "type": { "names": [ "number" ] }, "defaultvalue": "PIXI.BLEND_MODES.NORMAL;", "see": [ "PIXI.BLEND_MODES" ], "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#blendMode", "scope": "instance", "___id": "T000002R000849", "___s": true, "skip": true, "slug": "PIXI.GraphicsblendMode", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Current path\n *\n * @member {PIXI.GraphicsData} PIXI.Graphics#currentPath\n * @private\n */", "meta": { "range": [ 3119, 3254 ], "filename": "Graphics.js", "lineno": 107, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "PIXI.BLEND_MODES.NORMAL
to reset the blend mode.Current path
", "kind": "member", "name": "currentPath", "type": { "names": [ "PIXI.GraphicsData" ] }, "access": "private", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#currentPath", "scope": "instance", "___id": "T000002R000851", "___s": true, "skip": true, "slug": "PIXI.GraphicscurrentPath", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Whether this shape is being used as a mask.\n *\n * @member {boolean} PIXI.Graphics#isMask\n */", "meta": { "range": [ 3601, 3732 ], "filename": "Graphics.js", "lineno": 124, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "Whether this shape is being used as a mask.
", "kind": "member", "name": "isMask", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#isMask", "scope": "instance", "___id": "T000002R000854", "___s": true, "skip": true, "slug": "PIXI.GraphicsisMask", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The bounds' padding used for bounds calculation.\n *\n * @member {number} PIXI.Graphics#boundsPadding\n */", "meta": { "range": [ 3771, 3913 ], "filename": "Graphics.js", "lineno": 131, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "The bounds' padding used for bounds calculation.
", "kind": "member", "name": "boundsPadding", "type": { "names": [ "number" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#boundsPadding", "scope": "instance", "___id": "T000002R000856", "___s": true, "skip": true, "slug": "PIXI.GraphicsboundsPadding", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * A cache of the local bounds to prevent recalculation.\n *\n * @member {PIXI.Rectangle} PIXI.Graphics#_localBounds\n * @private\n */", "meta": { "range": [ 3955, 4129 ], "filename": "Graphics.js", "lineno": 138, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "A cache of the local bounds to prevent recalculation.
", "kind": "member", "name": "_localBounds", "type": { "names": [ "PIXI.Rectangle" ] }, "access": "private", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#_localBounds", "scope": "instance", "___id": "T000002R000858", "___s": true, "skip": true, "slug": "PIXI.Graphics_localBounds", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Used to detect if the graphics object has changed. If this is set to true then the graphics\n * object will be recalculated.\n *\n * @member {boolean} PIXI.Graphics#dirty\n * @private\n */", "meta": { "range": [ 4181, 4419 ], "filename": "Graphics.js", "lineno": 146, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "Used to detect if the graphics object has changed. If this is set to true then the graphics
", "kind": "member", "name": "dirty", "type": { "names": [ "boolean" ] }, "access": "private", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#dirty", "scope": "instance", "___id": "T000002R000860", "___s": true, "skip": true, "slug": "PIXI.Graphicsdirty", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Used to detect if the cached sprite object needs to be updated.\n *\n * @member {boolean} PIXI.Graphics#cachedSpriteDirty\n * @private\n */", "meta": { "range": [ 4918, 5100 ], "filename": "Graphics.js", "lineno": 173, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "
object will be recalculated.Used to detect if the cached sprite object needs to be updated.
", "kind": "member", "name": "cachedSpriteDirty", "type": { "names": [ "boolean" ] }, "access": "private", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#cachedSpriteDirty", "scope": "instance", "___id": "T000002R000865", "___s": true, "skip": true, "slug": "PIXI.GraphicscachedSpriteDirty", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * When cacheAsBitmap is set to true the graphics object will be rendered as if it was a sprite.\n * This is useful if your graphics element does not change often, as it will speed up the rendering\n * of the object in exchange for taking up texture memory. It is also useful if you need the graphics\n * object to be anti-aliased, because it will be rendered using canvas. This is not recommended if\n * you are constantly redrawing the graphics element.\n *\n * @name cacheAsBitmap\n * @member {boolean}\n * @memberof PIXI.Graphics#\n * @default false\n */", "meta": { "range": [ 5216, 5856 ], "filename": "Graphics.js", "lineno": 184, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "When cacheAsBitmap is set to true the graphics object will be rendered as if it was a sprite.
", "name": "cacheAsBitmap", "kind": "member", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Graphics", "defaultvalue": "false", "longname": "PIXI.Graphics#cacheAsBitmap", "scope": "instance", "overrides": "PIXI.Container#cacheAsBitmap", "___id": "T000002R000869", "___s": true, "skip": true, "slug": "PIXI.GraphicscacheAsBitmap", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The alpha value used when filling the Graphics object.\n *\n * @member {number} PIXI.Graphics#fillAlpha\n * @default 1\n */", "meta": { "range": [ 1226, 1392 ], "filename": "Graphics.js", "lineno": 39, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "
This is useful if your graphics element does not change often, as it will speed up the rendering
of the object in exchange for taking up texture memory. It is also useful if you need the graphics
object to be anti-aliased, because it will be rendered using canvas. This is not recommended if
you are constantly redrawing the graphics element.The alpha value used when filling the Graphics object.
", "kind": "member", "name": "fillAlpha", "type": { "names": [ "number" ] }, "defaultvalue": "1", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#fillAlpha", "scope": "instance", "___id": "T000002R007769", "___s": true, "skip": true, "slug": "PIXI.GraphicsfillAlpha", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The width (thickness) of any lines drawn.\n *\n * @member {number} PIXI.Graphics#lineWidth\n * @default 0\n */", "meta": { "range": [ 1430, 1583 ], "filename": "Graphics.js", "lineno": 47, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "The width (thickness) of any lines drawn.
", "kind": "member", "name": "lineWidth", "type": { "names": [ "number" ] }, "defaultvalue": "0", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#lineWidth", "scope": "instance", "___id": "T000002R007771", "___s": true, "skip": true, "slug": "PIXI.GraphicslineWidth", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * If true the lines will be draw using LINES instead of TRIANGLE_STRIP\n *\n * @member {boolean} PIXI.Graphics#nativeLines\n */", "meta": { "range": [ 1621, 1782 ], "filename": "Graphics.js", "lineno": 55, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "If true the lines will be draw using LINES instead of TRIANGLE_STRIP
", "kind": "member", "name": "nativeLines", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#nativeLines", "scope": "instance", "___id": "T000002R007773", "___s": true, "skip": true, "slug": "PIXI.GraphicsnativeLines", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The color of any lines drawn.\n *\n * @member {string} PIXI.Graphics#lineColor\n * @default 0\n */", "meta": { "range": [ 1832, 1973 ], "filename": "Graphics.js", "lineno": 62, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "The color of any lines drawn.
", "kind": "member", "name": "lineColor", "type": { "names": [ "string" ] }, "defaultvalue": "0", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#lineColor", "scope": "instance", "___id": "T000002R007775", "___s": true, "skip": true, "slug": "PIXI.GraphicslineColor", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Graphics data\n *\n * @member {PIXI.GraphicsData[]} PIXI.Graphics#graphicsData\n * @private\n */", "meta": { "range": [ 2011, 2150 ], "filename": "Graphics.js", "lineno": 70, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "Graphics data
", "kind": "member", "name": "graphicsData", "type": { "names": [ "Array." ] }, "access": "private", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#graphicsData", "scope": "instance", "___id": "T000002R007777", "___s": true, "skip": true, "slug": "PIXI.GraphicsgraphicsData", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to\n * reset the tint.\n *\n * @member {number} PIXI.Graphics#tint\n * @default 0xFFFFFF\n */", "meta": { "range": [ 2192, 2421 ], "filename": "Graphics.js", "lineno": 78, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": " The tint applied to the graphic shape. This is a hex value. Apply a value of 0xFFFFFF to
", "kind": "member", "name": "tint", "type": { "names": [ "number" ] }, "defaultvalue": "0xFFFFFF", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#tint", "scope": "instance", "___id": "T000002R007779", "___s": true, "skip": true, "slug": "PIXI.Graphicstint", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The previous tint applied to the graphic shape. Used to compare to the current tint and\n * check if theres change.\n *\n * @member {number} PIXI.Graphics#_prevTint\n * @private\n * @default 0xFFFFFF\n */", "meta": { "range": [ 2461, 2722 ], "filename": "Graphics.js", "lineno": 87, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "
reset the tint.The previous tint applied to the graphic shape. Used to compare to the current tint and
", "kind": "member", "name": "_prevTint", "type": { "names": [ "number" ] }, "access": "private", "defaultvalue": "0xFFFFFF", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#_prevTint", "scope": "instance", "___id": "T000002R007781", "___s": true, "skip": true, "slug": "PIXI.Graphics_prevTint", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The blend mode to be applied to the graphic shape. Apply a value of\n * `PIXI.BLEND_MODES.NORMAL` to reset the blend mode.\n *\n * @member {number} PIXI.Graphics#blendMode\n * @default PIXI.BLEND_MODES.NORMAL;\n * @see PIXI.BLEND_MODES\n */", "meta": { "range": [ 2767, 3064 ], "filename": "Graphics.js", "lineno": 97, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "
check if theres change.The blend mode to be applied to the graphic shape. Apply a value of
", "kind": "member", "name": "blendMode", "type": { "names": [ "number" ] }, "defaultvalue": "PIXI.BLEND_MODES.NORMAL;", "see": [ "PIXI.BLEND_MODES" ], "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#blendMode", "scope": "instance", "___id": "T000002R007783", "___s": true, "skip": true, "slug": "PIXI.GraphicsblendMode", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Current path\n *\n * @member {PIXI.GraphicsData} PIXI.Graphics#currentPath\n * @private\n */", "meta": { "range": [ 3119, 3254 ], "filename": "Graphics.js", "lineno": 107, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "PIXI.BLEND_MODES.NORMAL
to reset the blend mode.Current path
", "kind": "member", "name": "currentPath", "type": { "names": [ "PIXI.GraphicsData" ] }, "access": "private", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#currentPath", "scope": "instance", "___id": "T000002R007785", "___s": true, "skip": true, "slug": "PIXI.GraphicscurrentPath", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Whether this shape is being used as a mask.\n *\n * @member {boolean} PIXI.Graphics#isMask\n */", "meta": { "range": [ 3601, 3732 ], "filename": "Graphics.js", "lineno": 124, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "Whether this shape is being used as a mask.
", "kind": "member", "name": "isMask", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#isMask", "scope": "instance", "___id": "T000002R007788", "___s": true, "skip": true, "slug": "PIXI.GraphicsisMask", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * The bounds' padding used for bounds calculation.\n *\n * @member {number} PIXI.Graphics#boundsPadding\n */", "meta": { "range": [ 3771, 3913 ], "filename": "Graphics.js", "lineno": 131, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "The bounds' padding used for bounds calculation.
", "kind": "member", "name": "boundsPadding", "type": { "names": [ "number" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#boundsPadding", "scope": "instance", "___id": "T000002R007790", "___s": true, "skip": true, "slug": "PIXI.GraphicsboundsPadding", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * A cache of the local bounds to prevent recalculation.\n *\n * @member {PIXI.Rectangle} PIXI.Graphics#_localBounds\n * @private\n */", "meta": { "range": [ 3955, 4129 ], "filename": "Graphics.js", "lineno": 138, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "A cache of the local bounds to prevent recalculation.
", "kind": "member", "name": "_localBounds", "type": { "names": [ "PIXI.Rectangle" ] }, "access": "private", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#_localBounds", "scope": "instance", "___id": "T000002R007792", "___s": true, "skip": true, "slug": "PIXI.Graphics_localBounds", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Used to detect if the graphics object has changed. If this is set to true then the graphics\n * object will be recalculated.\n *\n * @member {boolean} PIXI.Graphics#dirty\n * @private\n */", "meta": { "range": [ 4181, 4419 ], "filename": "Graphics.js", "lineno": 146, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "Used to detect if the graphics object has changed. If this is set to true then the graphics
", "kind": "member", "name": "dirty", "type": { "names": [ "boolean" ] }, "access": "private", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#dirty", "scope": "instance", "___id": "T000002R007794", "___s": true, "skip": true, "slug": "PIXI.Graphicsdirty", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * Used to detect if the cached sprite object needs to be updated.\n *\n * @member {boolean} PIXI.Graphics#cachedSpriteDirty\n * @private\n */", "meta": { "range": [ 4918, 5100 ], "filename": "Graphics.js", "lineno": 173, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "
object will be recalculated.Used to detect if the cached sprite object needs to be updated.
", "kind": "member", "name": "cachedSpriteDirty", "type": { "names": [ "boolean" ] }, "access": "private", "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#cachedSpriteDirty", "scope": "instance", "___id": "T000002R007799", "___s": true, "skip": true, "slug": "PIXI.GraphicscachedSpriteDirty", "filepath": "core\\graphics\\Graphics.js" }, { "comment": "/**\n * When cacheAsBitmap is set to true the graphics object will be rendered as if it was a sprite.\n * This is useful if your graphics element does not change often, as it will speed up the rendering\n * of the object in exchange for taking up texture memory. It is also useful if you need the graphics\n * object to be anti-aliased, because it will be rendered using canvas. This is not recommended if\n * you are constantly redrawing the graphics element.\n *\n * @name cacheAsBitmap\n * @member {boolean}\n * @memberof PIXI.Graphics#\n * @default false\n */", "meta": { "range": [ 5216, 5856 ], "filename": "Graphics.js", "lineno": 184, "path": "C:\\Users\\beaujeup\\projects\\jsdoc-template\\examples\\pixi.js\\pixi.js-repo\\src\\core\\graphics", "code": {} }, "description": "When cacheAsBitmap is set to true the graphics object will be rendered as if it was a sprite.
", "name": "cacheAsBitmap", "kind": "member", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Graphics", "defaultvalue": "false", "longname": "PIXI.Graphics#cacheAsBitmap", "scope": "instance", "overrides": "PIXI.Container#cacheAsBitmap", "___id": "T000002R007803", "___s": true, "skip": true, "slug": "PIXI.GraphicscacheAsBitmap", "filepath": "core\\graphics\\Graphics.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": "
This is useful if your graphics element does not change often, as it will speed up the rendering
of the object in exchange for taking up texture memory. It is also useful if you need the graphics
object to be anti-aliased, because it will be rendered using canvas. This is not recommended if
you are constantly redrawing the graphics element.The array of children of this container.
", "kind": "member", "name": "children", "type": { "names": [ "Array." ] }, "readonly": true, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#children", "scope": "instance", "inherits": "PIXI.Container#children", "inherited": true, "overrides": "PIXI.Container#children", "___id": "T000002R013908", "___s": true, "skip": true, "slug": "PIXI.Graphicschildren", "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.
", "kind": "member", "name": "transform", "type": { "names": [ "PIXI.TransformBase" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#transform", "scope": "instance", "inherits": "PIXI.DisplayObject#transform", "inherited": true, "overrides": "PIXI.Container#transform", "___id": "T000002R013926", "___s": true, "skip": true, "slug": "PIXI.Graphicstransform", "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": "
This will become read-only later, please do not assign anything there unless you know what are you doingThe opacity of the object.
", "kind": "member", "name": "alpha", "type": { "names": [ "number" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#alpha", "scope": "instance", "inherits": "PIXI.DisplayObject#alpha", "inherited": true, "overrides": "PIXI.Container#alpha", "___id": "T000002R013927", "___s": true, "skip": true, "slug": "PIXI.Graphicsalpha", "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
\n
the updateTransform function will not be called.Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually
", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#visible", "scope": "instance", "inherits": "PIXI.DisplayObject#visible", "inherited": true, "overrides": "PIXI.Container#visible", "___id": "T000002R013928", "___s": true, "skip": true, "slug": "PIXI.Graphicsvisible", "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
\n
methods will still be called.Only affects recursive calls from parent. You can ask for bounds manually
", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#renderable", "scope": "instance", "inherits": "PIXI.DisplayObject#renderable", "inherited": true, "overrides": "PIXI.Container#renderable", "___id": "T000002R013929", "___s": true, "skip": true, "slug": "PIXI.Graphicsrenderable", "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.Graphics", "longname": "PIXI.Graphics#parent", "scope": "instance", "inherits": "PIXI.DisplayObject#parent", "inherited": true, "overrides": "PIXI.Container#parent", "___id": "T000002R013930", "___s": true, "skip": true, "slug": "PIXI.Graphicsparent", "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.Graphics", "longname": "PIXI.Graphics#worldAlpha", "scope": "instance", "inherits": "PIXI.DisplayObject#worldAlpha", "inherited": true, "overrides": "PIXI.Container#worldAlpha", "___id": "T000002R013931", "___s": true, "skip": true, "slug": "PIXI.GraphicsworldAlpha", "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
\n
rather than figuring out the dimensions of the displayObject each frame you can set this rectangleAlso works as an interaction mask
", "kind": "member", "name": "filterArea", "type": { "names": [ "PIXI.Rectangle" ] }, "memberof": "PIXI.Graphics", "longname": "PIXI.Graphics#filterArea", "scope": "instance", "inherits": "PIXI.DisplayObject#filterArea", "inherited": true, "overrides": "PIXI.Container#filterArea", "___id": "T000002R013932", "___s": true, "skip": true, "slug": "PIXI.GraphicsfilterArea", "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.Graphics", "longname": "PIXI.Graphics#_bounds", "scope": "instance", "inherits": "PIXI.DisplayObject#_bounds", "inherited": true, "overrides": "PIXI.Container#_bounds", "___id": "T000002R013933", "___s": true, "skip": true, "slug": "PIXI.Graphics_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.Graphics", "longname": "PIXI.Graphics#_mask", "scope": "instance", "inherits": "PIXI.DisplayObject#_mask", "inherited": true, "overrides": "PIXI.Container#_mask", "___id": "T000002R013934", "___s": true, "skip": true, "slug": "PIXI.Graphics_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.Graphics", "longname": "PIXI.Graphics#_destroyed", "scope": "instance", "inherits": "PIXI.DisplayObject#_destroyed", "inherited": true, "overrides": "PIXI.Container#_destroyed", "___id": "T000002R013935", "___s": true, "skip": true, "slug": "PIXI.Graphics_destroyed", "filepath": "core\\display\\DisplayObject.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.
\n
It is the base class of all display objects that act as a container for other objects.", "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": "let container = new PIXI.Container();\ncontainer.addChild(sprite);
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.
\nMultiple items can be added like so:
", "params": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "variable": true, "description": "myContainer.addChild(thingOne, thingTwo, thingThree)
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
", "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": "
calculate the bounds of the specific object (not including children).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.
", "params": [ { "type": { "names": [ "object", "boolean" ] }, "optional": true, "description": "
Do not use a Container after callingdestroy
.Options parameter. A boolean will act as if all options
", "name": "options" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
have been set to that valueif set to true, all the children will have their destroy
", "name": "options.children" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
method called as well. 'options' will be passed on to those calls.Only used for child Sprites if options.children is set to true
", "name": "options.texture" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
Should it destroy the texture of the child spriteOnly used for child Sprites if options.children is set to true
", "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": "
Should it destroy the base texture of the child spriteThe 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.
\nMultiple items can be added like so:
", "params": [ { "type": { "names": [ "PIXI.DisplayObject" ] }, "variable": true, "description": "myContainer.addChild(thingOne, thingTwo, thingThree)
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
", "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": "
calculate the bounds of the specific object (not including children).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.
", "params": [ { "type": { "names": [ "object", "boolean" ] }, "optional": true, "description": "
Do not use a Container after callingdestroy
.Options parameter. A boolean will act as if all options
", "name": "options" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
have been set to that valueif set to true, all the children will have their destroy
", "name": "options.children" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
method called as well. 'options' will be passed on to those calls.Only used for child Sprites if options.children is set to true
", "name": "options.texture" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
Should it destroy the texture of the child spriteOnly used for child Sprites if options.children is set to true
", "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": "
Should it destroy the base texture of the child spriteThe 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
", "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": "
internal function for toLocal()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
", "name": "skipUpdate" }, { "type": { "names": [ "PIXI.Rectangle" ] }, "description": "
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boostOptional 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
", "name": "point" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
(otherwise will create a new Point)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
", "name": "point" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
(otherwise will create a new Point)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.
", "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": "
An alias to position.xThe position of the displayObject on the y axis relative to the local coordinates of the parent.
", "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": "
An alias to position.yCurrent 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.
", "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": "
Assignment by value since pixi-v4.The scale factor of the object.
", "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": "
Assignment by value since pixi-v4.The pivot point of the displayObject that it rotates around
", "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": "
Assignment by value since pixi-v4.The skew factor for the object in radians.
", "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": "
Assignment by value since pixi-v4.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
", "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": "
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.Sets the filters for the displayObject.
\n\n
", "kind": "member", "type": { "names": [ "Array.- 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'" ] }, "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.
", "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": "
This will become read-only later, please do not assign anything there unless you know what are you doingThe 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
\n
the updateTransform function will not be called.Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually
", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.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
\n
methods will still be called.Only affects recursive calls from parent. You can ask for bounds manually
", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.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
\n
rather than figuring out the dimensions of the displayObject each frame you can set this rectangleAlso 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.
\n
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
", "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": "
as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.The base class for all objects that are rendered on the screen.
", "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": "
This is an abstract class and should not be used on its own rather it should be extended.Updates the object transform for rendering
\nTODO - 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
", "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": "
internal function for toLocal()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
", "name": "skipUpdate" }, { "type": { "names": [ "PIXI.Rectangle" ] }, "description": "
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boostOptional 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
", "name": "point" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
(otherwise will create a new Point)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
", "name": "point" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
(otherwise will create a new Point)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
", "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": "
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 callingdestroy
.The position of the displayObject on the x axis relative to the local coordinates of the parent.
", "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": "
An alias to position.xThe position of the displayObject on the y axis relative to the local coordinates of the parent.
", "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": "
An alias to position.yCurrent 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.
", "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": "
Assignment by value since pixi-v4.The scale factor of the object.
", "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": "
Assignment by value since pixi-v4.The pivot point of the displayObject that it rotates around
", "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": "
Assignment by value since pixi-v4.The skew factor for the object in radians.
", "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": "
Assignment by value since pixi-v4.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
", "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": "
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.Sets the filters for the displayObject.
\n\n
", "kind": "member", "type": { "names": [ "Array.- 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'" ] }, "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
\nTODO - 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
", "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": "
internal function for toLocal()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
", "name": "skipUpdate" }, { "type": { "names": [ "PIXI.Rectangle" ] }, "description": "
being updated. This means the calculation returned MAY be out of date BUT will give you a
nice performance boostOptional 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
", "name": "point" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
(otherwise will create a new Point)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
", "name": "point" }, { "type": { "names": [ "boolean" ] }, "optional": true, "defaultvalue": false, "description": "
(otherwise will create a new Point)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
", "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": "
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 callingdestroy
.The position of the displayObject on the x axis relative to the local coordinates of the parent.
", "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": "
An alias to position.xThe position of the displayObject on the y axis relative to the local coordinates of the parent.
", "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": "
An alias to position.yCurrent 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.
", "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": "
Assignment by value since pixi-v4.The scale factor of the object.
", "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": "
Assignment by value since pixi-v4.The pivot point of the displayObject that it rotates around
", "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": "
Assignment by value since pixi-v4.The skew factor for the object in radians.
", "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": "
Assignment by value since pixi-v4.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
", "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": "
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.Sets the filters for the displayObject.
\n\n
", "kind": "member", "type": { "names": [ "Array.- 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'" ] }, "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.
", "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": "
This will become read-only later, please do not assign anything there unless you know what are you doingThe 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
\n
the updateTransform function will not be called.Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually
", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.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
\n
methods will still be called.Only affects recursive calls from parent. You can ask for bounds manually
", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.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
\n
rather than figuring out the dimensions of the displayObject each frame you can set this rectangleAlso 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.
\n
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
", "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": "
as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.World transform and local transform of this object.
", "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": "
This will become read-only later, please do not assign anything there unless you know what are you doingThe 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
\n
the updateTransform function will not be called.Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually
", "kind": "member", "name": "visible", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.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
\n
methods will still be called.Only affects recursive calls from parent. You can ask for bounds manually
", "kind": "member", "name": "renderable", "type": { "names": [ "boolean" ] }, "memberof": "PIXI.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
\n
rather than figuring out the dimensions of the displayObject each frame you can set this rectangleAlso 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.
\n
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
", "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": [], "filepath": "core\\graphics\\Graphics.js" }
as it will take a snapshot of what is currently there. If the textures have not loaded then they will not appear.