@pixi/display
Advanced tools
Comparing version 5.0.0-alpha.2 to 5.0.0-alpha.3
/*! | ||
* @pixi/display - v5.0.0-alpha.2 | ||
* Compiled Sat, 17 Mar 2018 17:48:48 UTC | ||
* @pixi/display - v5.0.0-alpha.3 | ||
* Compiled Tue, 03 Jul 2018 04:08:21 UTC | ||
* | ||
@@ -350,3 +350,3 @@ * @pixi/display is licensed under the MIT License. | ||
* World transform and local transform of this object. | ||
* This will become read-only later, please do not assign anything there unless you know what are you doing | ||
* This will become read-only later, please do not assign anything there unless you know what are you doing. | ||
* | ||
@@ -368,3 +368,3 @@ * @member {PIXI.TransformBase} | ||
* | ||
* Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually | ||
* Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually. | ||
* | ||
@@ -379,3 +379,3 @@ * @member {boolean} | ||
* | ||
* Only affects recursive calls from parent. You can ask for bounds manually | ||
* Only affects recursive calls from parent. You can ask for bounds manually. | ||
* | ||
@@ -395,3 +395,3 @@ * @member {boolean} | ||
/** | ||
* The multiplied alpha of the displayObject | ||
* The multiplied alpha of the displayObject. | ||
* | ||
@@ -404,6 +404,6 @@ * @member {number} | ||
/** | ||
* The area the filter is applied to. This is used as more of an optimisation | ||
* rather than figuring out the dimensions of the displayObject each frame you can set this rectangle | ||
* The area the filter is applied to. This is used as more of an optimization | ||
* rather than figuring out the dimensions of the displayObject each frame you can set this rectangle. | ||
* | ||
* Also works as an interaction mask | ||
* Also works as an interaction mask. | ||
* | ||
@@ -416,4 +416,4 @@ * @member {PIXI.Rectangle} | ||
* Sets the filters for the displayObject. | ||
* * IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer. | ||
* To remove filters simply set this property to 'null' | ||
* * IMPORTANT: This is a WebGL only feature and will be ignored by the canvas renderer. | ||
* To remove filters simply set this property to `'null'`. | ||
* | ||
@@ -426,3 +426,3 @@ * @member {PIXI.Filter[]} | ||
/** | ||
* The bounds object, this is used to calculate and store the bounds of the displayObject | ||
* The bounds object, this is used to calculate and store the bounds of the displayObject. | ||
* | ||
@@ -439,3 +439,3 @@ * @member {PIXI.Rectangle} | ||
/** | ||
* The original, cached mask of the object | ||
* The original, cached mask of the object. | ||
* | ||
@@ -492,3 +492,3 @@ * @member {PIXI.Graphics|PIXI.Sprite} | ||
/** | ||
* Updates the object transform for rendering | ||
* Updates the object transform for rendering. | ||
* | ||
@@ -507,3 +507,3 @@ * TODO - Optimization pass! | ||
/** | ||
* recursively updates transform of all objects from the root to this one | ||
* Recursively updates transform of all objects from the root to this one | ||
* internal function for toLocal() | ||
@@ -527,7 +527,7 @@ */ | ||
* | ||
* @param {boolean} skipUpdate - setting to true will stop the transforms of the scene graph from | ||
* @param {boolean} skipUpdate - Setting to `true` will stop the transforms of the scene graph from | ||
* being updated. This means the calculation returned MAY be out of date BUT will give you a | ||
* nice performance boost | ||
* @param {PIXI.Rectangle} rect - Optional rectangle to store the result of the bounds calculation | ||
* @return {PIXI.Rectangle} the rectangular bounding area | ||
* nice performance boost. | ||
* @param {PIXI.Rectangle} rect - Optional rectangle to store the result of the bounds calculation. | ||
* @return {PIXI.Rectangle} The rectangular bounding area. | ||
*/ | ||
@@ -570,6 +570,6 @@ DisplayObject.prototype.getBounds = function getBounds (skipUpdate, rect) | ||
/** | ||
* Retrieves the local bounds of the displayObject as a rectangle object | ||
* Retrieves the local bounds of the displayObject as a rectangle object. | ||
* | ||
* @param {PIXI.Rectangle} [rect] - Optional rectangle to store the result of the bounds calculation | ||
* @return {PIXI.Rectangle} the rectangular bounding area | ||
* @param {PIXI.Rectangle} [rect] - Optional rectangle to store the result of the bounds calculation. | ||
* @return {PIXI.Rectangle} The rectangular bounding area. | ||
*/ | ||
@@ -603,9 +603,9 @@ DisplayObject.prototype.getLocalBounds = function getLocalBounds (rect) | ||
/** | ||
* Calculates the global position of the display object | ||
* Calculates the global position of the display object. | ||
* | ||
* @param {PIXI.Point} position - The world origin to calculate from | ||
* @param {PIXI.Point} position - The world origin to calculate from. | ||
* @param {PIXI.Point} [point] - A Point object in which to store the value, optional | ||
* (otherwise will create a new Point) | ||
* (otherwise will create a new Point). | ||
* @param {boolean} [skipUpdate=false] - Should we skip the update transform. | ||
* @return {PIXI.Point} A point object representing the position of this object | ||
* @return {PIXI.Point} A point object representing the position of this object. | ||
*/ | ||
@@ -640,8 +640,8 @@ DisplayObject.prototype.toGlobal = function toGlobal (position, point, skipUpdate) | ||
/** | ||
* Calculates the local position of the display object relative to another point | ||
* Calculates the local position of the display object relative to another point. | ||
* | ||
* @param {PIXI.Point} position - The world origin to calculate from | ||
* @param {PIXI.DisplayObject} [from] - The DisplayObject to calculate the global position from | ||
* @param {PIXI.Point} position - The world origin to calculate from. | ||
* @param {PIXI.DisplayObject} [from] - The DisplayObject to calculate the global position from. | ||
* @param {PIXI.Point} [point] - A Point object in which to store the value, optional | ||
* (otherwise will create a new Point) | ||
* (otherwise will create a new Point). | ||
* @param {boolean} [skipUpdate=false] - Should we skip the update transform | ||
@@ -681,5 +681,5 @@ * @return {PIXI.Point} A point object representing the position of this object | ||
/** | ||
* Renders the object using the WebGL renderer | ||
* Renders the object using the WebGL renderer. | ||
* | ||
* @param {PIXI.Renderer} renderer - The renderer | ||
* @param {PIXI.Renderer} renderer - The renderer. | ||
*/ | ||
@@ -692,6 +692,6 @@ DisplayObject.prototype.render = function render (renderer) // eslint-disable-line no-unused-vars | ||
/** | ||
* Set the parent Container of this DisplayObject | ||
* Set the parent Container of this DisplayObject. | ||
* | ||
* @param {PIXI.Container} container - The Container to add this DisplayObject to | ||
* @return {PIXI.Container} The Container that this DisplayObject was added to | ||
* @param {PIXI.Container} container - The Container to add this DisplayObject to. | ||
* @return {PIXI.Container} The Container that this DisplayObject was added to. | ||
*/ | ||
@@ -753,3 +753,3 @@ DisplayObject.prototype.setParent = function setParent (container) | ||
* all current event listeners and internal references. Do not use a DisplayObject | ||
* after calling `destroy`. | ||
* after calling `destroy()`. | ||
* | ||
@@ -813,3 +813,3 @@ */ | ||
/** | ||
* Current transform of the object based on world (parent) factors | ||
* Current transform of the object based on world (parent) factors. | ||
* | ||
@@ -825,3 +825,3 @@ * @member {PIXI.Matrix} | ||
/** | ||
* Current transform of the object based on local factors: position, scale, other stuff | ||
* Current transform of the object based on local factors: position, scale, other stuff. | ||
* | ||
@@ -869,3 +869,3 @@ * @member {PIXI.Matrix} | ||
/** | ||
* The pivot point of the displayObject that it rotates around | ||
* The pivot point of the displayObject that it rotates around. | ||
* Assignment by value since pixi-v4. | ||
@@ -942,8 +942,15 @@ * | ||
* 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. | ||
* {@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it | ||
* utilities shape clipping. To remove a mask, set this property to `null`. | ||
* | ||
* For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask. | ||
* @example | ||
* const graphics = new PIXI.Graphics(); | ||
* graphics.beginFill(0xFF3300); | ||
* graphics.drawRect(50, 250, 100, 100); | ||
* graphics.endFill(); | ||
* | ||
* @todo For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask. | ||
* const sprite = new PIXI.Sprite(texture); | ||
* sprite.mask = graphics; | ||
* @todo At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask. | ||
* | ||
@@ -1044,3 +1051,3 @@ * @member {PIXI.Graphics|PIXI.Sprite} | ||
// loop through the arguments property and add all children | ||
// use it the right way (.length and [i]) so that this function can still be optimised by JS runtimes | ||
// use it the right way (.length and [i]) so that this function can still be optimized by JS runtimes | ||
for (var i = 0; i < argumentsLength; i++) | ||
@@ -1204,3 +1211,3 @@ { | ||
// loop through the arguments property and add all children | ||
// use it the right way (.length and [i]) so that this function can still be optimised by JS runtimes | ||
// use it the right way (.length and [i]) so that this function can still be optimized by JS runtimes | ||
for (var i = 0; i < argumentsLength; i++) | ||
@@ -1207,0 +1214,0 @@ { |
/*! | ||
* @pixi/display - v5.0.0-alpha.2 | ||
* Compiled Sat, 17 Mar 2018 17:48:48 UTC | ||
* @pixi/display - v5.0.0-alpha.3 | ||
* Compiled Tue, 03 Jul 2018 04:08:21 UTC | ||
* | ||
@@ -356,3 +356,3 @@ * @pixi/display is licensed under the MIT License. | ||
* World transform and local transform of this object. | ||
* This will become read-only later, please do not assign anything there unless you know what are you doing | ||
* This will become read-only later, please do not assign anything there unless you know what are you doing. | ||
* | ||
@@ -374,3 +374,3 @@ * @member {PIXI.TransformBase} | ||
* | ||
* Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually | ||
* Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually. | ||
* | ||
@@ -385,3 +385,3 @@ * @member {boolean} | ||
* | ||
* Only affects recursive calls from parent. You can ask for bounds manually | ||
* Only affects recursive calls from parent. You can ask for bounds manually. | ||
* | ||
@@ -401,3 +401,3 @@ * @member {boolean} | ||
/** | ||
* The multiplied alpha of the displayObject | ||
* The multiplied alpha of the displayObject. | ||
* | ||
@@ -410,6 +410,6 @@ * @member {number} | ||
/** | ||
* The area the filter is applied to. This is used as more of an optimisation | ||
* rather than figuring out the dimensions of the displayObject each frame you can set this rectangle | ||
* The area the filter is applied to. This is used as more of an optimization | ||
* rather than figuring out the dimensions of the displayObject each frame you can set this rectangle. | ||
* | ||
* Also works as an interaction mask | ||
* Also works as an interaction mask. | ||
* | ||
@@ -422,4 +422,4 @@ * @member {PIXI.Rectangle} | ||
* Sets the filters for the displayObject. | ||
* * IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer. | ||
* To remove filters simply set this property to 'null' | ||
* * IMPORTANT: This is a WebGL only feature and will be ignored by the canvas renderer. | ||
* To remove filters simply set this property to `'null'`. | ||
* | ||
@@ -432,3 +432,3 @@ * @member {PIXI.Filter[]} | ||
/** | ||
* The bounds object, this is used to calculate and store the bounds of the displayObject | ||
* The bounds object, this is used to calculate and store the bounds of the displayObject. | ||
* | ||
@@ -445,3 +445,3 @@ * @member {PIXI.Rectangle} | ||
/** | ||
* The original, cached mask of the object | ||
* The original, cached mask of the object. | ||
* | ||
@@ -498,3 +498,3 @@ * @member {PIXI.Graphics|PIXI.Sprite} | ||
/** | ||
* Updates the object transform for rendering | ||
* Updates the object transform for rendering. | ||
* | ||
@@ -513,3 +513,3 @@ * TODO - Optimization pass! | ||
/** | ||
* recursively updates transform of all objects from the root to this one | ||
* Recursively updates transform of all objects from the root to this one | ||
* internal function for toLocal() | ||
@@ -533,7 +533,7 @@ */ | ||
* | ||
* @param {boolean} skipUpdate - setting to true will stop the transforms of the scene graph from | ||
* @param {boolean} skipUpdate - Setting to `true` will stop the transforms of the scene graph from | ||
* being updated. This means the calculation returned MAY be out of date BUT will give you a | ||
* nice performance boost | ||
* @param {PIXI.Rectangle} rect - Optional rectangle to store the result of the bounds calculation | ||
* @return {PIXI.Rectangle} the rectangular bounding area | ||
* nice performance boost. | ||
* @param {PIXI.Rectangle} rect - Optional rectangle to store the result of the bounds calculation. | ||
* @return {PIXI.Rectangle} The rectangular bounding area. | ||
*/ | ||
@@ -576,6 +576,6 @@ DisplayObject.prototype.getBounds = function getBounds (skipUpdate, rect) | ||
/** | ||
* Retrieves the local bounds of the displayObject as a rectangle object | ||
* Retrieves the local bounds of the displayObject as a rectangle object. | ||
* | ||
* @param {PIXI.Rectangle} [rect] - Optional rectangle to store the result of the bounds calculation | ||
* @return {PIXI.Rectangle} the rectangular bounding area | ||
* @param {PIXI.Rectangle} [rect] - Optional rectangle to store the result of the bounds calculation. | ||
* @return {PIXI.Rectangle} The rectangular bounding area. | ||
*/ | ||
@@ -609,9 +609,9 @@ DisplayObject.prototype.getLocalBounds = function getLocalBounds (rect) | ||
/** | ||
* Calculates the global position of the display object | ||
* Calculates the global position of the display object. | ||
* | ||
* @param {PIXI.Point} position - The world origin to calculate from | ||
* @param {PIXI.Point} position - The world origin to calculate from. | ||
* @param {PIXI.Point} [point] - A Point object in which to store the value, optional | ||
* (otherwise will create a new Point) | ||
* (otherwise will create a new Point). | ||
* @param {boolean} [skipUpdate=false] - Should we skip the update transform. | ||
* @return {PIXI.Point} A point object representing the position of this object | ||
* @return {PIXI.Point} A point object representing the position of this object. | ||
*/ | ||
@@ -646,8 +646,8 @@ DisplayObject.prototype.toGlobal = function toGlobal (position, point, skipUpdate) | ||
/** | ||
* Calculates the local position of the display object relative to another point | ||
* Calculates the local position of the display object relative to another point. | ||
* | ||
* @param {PIXI.Point} position - The world origin to calculate from | ||
* @param {PIXI.DisplayObject} [from] - The DisplayObject to calculate the global position from | ||
* @param {PIXI.Point} position - The world origin to calculate from. | ||
* @param {PIXI.DisplayObject} [from] - The DisplayObject to calculate the global position from. | ||
* @param {PIXI.Point} [point] - A Point object in which to store the value, optional | ||
* (otherwise will create a new Point) | ||
* (otherwise will create a new Point). | ||
* @param {boolean} [skipUpdate=false] - Should we skip the update transform | ||
@@ -687,5 +687,5 @@ * @return {PIXI.Point} A point object representing the position of this object | ||
/** | ||
* Renders the object using the WebGL renderer | ||
* Renders the object using the WebGL renderer. | ||
* | ||
* @param {PIXI.Renderer} renderer - The renderer | ||
* @param {PIXI.Renderer} renderer - The renderer. | ||
*/ | ||
@@ -698,6 +698,6 @@ DisplayObject.prototype.render = function render (renderer) // eslint-disable-line no-unused-vars | ||
/** | ||
* Set the parent Container of this DisplayObject | ||
* Set the parent Container of this DisplayObject. | ||
* | ||
* @param {PIXI.Container} container - The Container to add this DisplayObject to | ||
* @return {PIXI.Container} The Container that this DisplayObject was added to | ||
* @param {PIXI.Container} container - The Container to add this DisplayObject to. | ||
* @return {PIXI.Container} The Container that this DisplayObject was added to. | ||
*/ | ||
@@ -759,3 +759,3 @@ DisplayObject.prototype.setParent = function setParent (container) | ||
* all current event listeners and internal references. Do not use a DisplayObject | ||
* after calling `destroy`. | ||
* after calling `destroy()`. | ||
* | ||
@@ -819,3 +819,3 @@ */ | ||
/** | ||
* Current transform of the object based on world (parent) factors | ||
* Current transform of the object based on world (parent) factors. | ||
* | ||
@@ -831,3 +831,3 @@ * @member {PIXI.Matrix} | ||
/** | ||
* Current transform of the object based on local factors: position, scale, other stuff | ||
* Current transform of the object based on local factors: position, scale, other stuff. | ||
* | ||
@@ -875,3 +875,3 @@ * @member {PIXI.Matrix} | ||
/** | ||
* The pivot point of the displayObject that it rotates around | ||
* The pivot point of the displayObject that it rotates around. | ||
* Assignment by value since pixi-v4. | ||
@@ -948,8 +948,15 @@ * | ||
* 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. | ||
* {@link PIXI.Graphics} or a {@link PIXI.Sprite} object. This allows for much faster masking in canvas as it | ||
* utilities shape clipping. To remove a mask, set this property to `null`. | ||
* | ||
* For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask. | ||
* @example | ||
* const graphics = new PIXI.Graphics(); | ||
* graphics.beginFill(0xFF3300); | ||
* graphics.drawRect(50, 250, 100, 100); | ||
* graphics.endFill(); | ||
* | ||
* @todo For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask. | ||
* const sprite = new PIXI.Sprite(texture); | ||
* sprite.mask = graphics; | ||
* @todo At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask. | ||
* | ||
@@ -1050,3 +1057,3 @@ * @member {PIXI.Graphics|PIXI.Sprite} | ||
// loop through the arguments property and add all children | ||
// use it the right way (.length and [i]) so that this function can still be optimised by JS runtimes | ||
// use it the right way (.length and [i]) so that this function can still be optimized by JS runtimes | ||
for (var i = 0; i < argumentsLength; i++) | ||
@@ -1210,3 +1217,3 @@ { | ||
// loop through the arguments property and add all children | ||
// use it the right way (.length and [i]) so that this function can still be optimised by JS runtimes | ||
// use it the right way (.length and [i]) so that this function can still be optimized by JS runtimes | ||
for (var i = 0; i < argumentsLength; i++) | ||
@@ -1213,0 +1220,0 @@ { |
{ | ||
"name": "@pixi/display", | ||
"version": "5.0.0-alpha.2", | ||
"version": "5.0.0-alpha.3", | ||
"main": "lib/display.js", | ||
@@ -28,4 +28,4 @@ "module": "lib/display.es.js", | ||
"dependencies": { | ||
"@pixi/math": "^5.0.0-alpha.2", | ||
"@pixi/utils": "^5.0.0-alpha.2", | ||
"@pixi/math": "^5.0.0-alpha.3", | ||
"@pixi/utils": "^5.0.0-alpha.3", | ||
"eventemitter3": "^2.0.0", | ||
@@ -32,0 +32,0 @@ "remove-array-items": "^1.0.0" |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
231588
2689
Updated@pixi/math@^5.0.0-alpha.3
Updated@pixi/utils@^5.0.0-alpha.3