diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index 660cb52..b979ff6 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -25,8 +25,8 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.Graphics} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -65,8 +65,8 @@ /** * Removes the last mask from the mask stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.popMask = function (target, maskData) { @@ -92,7 +92,7 @@ * Applies the Mask and adds it to the current filter stack. * * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param maskData {PIXI.Sprite} */ MaskManager.prototype.pushSpriteMask = function (target, maskData) { @@ -127,7 +127,7 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param maskData {any[]} + * @param maskData {*[]} */ MaskManager.prototype.pushStencilMask = function (maskData) { diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index 660cb52..b979ff6 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -25,8 +25,8 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.Graphics} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -65,8 +65,8 @@ /** * Removes the last mask from the mask stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.popMask = function (target, maskData) { @@ -92,7 +92,7 @@ * Applies the Mask and adds it to the current filter stack. * * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param maskData {PIXI.Sprite} */ MaskManager.prototype.pushSpriteMask = function (target, maskData) { @@ -127,7 +127,7 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param maskData {any[]} + * @param maskData {*[]} */ MaskManager.prototype.pushStencilMask = function (maskData) { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 34d1181..15836da 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {any[]} The mask stack + * @param stencilMaskStack {*[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index 660cb52..b979ff6 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -25,8 +25,8 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.Graphics} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -65,8 +65,8 @@ /** * Removes the last mask from the mask stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.popMask = function (target, maskData) { @@ -92,7 +92,7 @@ * Applies the Mask and adds it to the current filter stack. * * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param maskData {PIXI.Sprite} */ MaskManager.prototype.pushSpriteMask = function (target, maskData) { @@ -127,7 +127,7 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param maskData {any[]} + * @param maskData {*[]} */ MaskManager.prototype.pushStencilMask = function (maskData) { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 34d1181..15836da 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {any[]} The mask stack + * @param stencilMaskStack {*[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 195b7c6..ef1c280 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -10,11 +10,11 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} the current WebGL drawing context - * @param width {number} the horizontal range of the filter - * @param height {number} the vertical range of the filter - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the current resolution - * @param root {boolean} Whether this object is the root element or not + * @param [width=0] {number} the horizontal range of the filter + * @param [height=0] {number} the vertical range of the filter + * @param [scaleMode=CONST.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [resolution=CONST.RESOLUTION] {number} the current resolution + * @param [root=false] {boolean} Whether this object is the root element or not */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index 660cb52..b979ff6 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -25,8 +25,8 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.Graphics} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -65,8 +65,8 @@ /** * Removes the last mask from the mask stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.popMask = function (target, maskData) { @@ -92,7 +92,7 @@ * Applies the Mask and adds it to the current filter stack. * * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param maskData {PIXI.Sprite} */ MaskManager.prototype.pushSpriteMask = function (target, maskData) { @@ -127,7 +127,7 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param maskData {any[]} + * @param maskData {*[]} */ MaskManager.prototype.pushStencilMask = function (maskData) { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 34d1181..15836da 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {any[]} The mask stack + * @param stencilMaskStack {*[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 195b7c6..ef1c280 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -10,11 +10,11 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} the current WebGL drawing context - * @param width {number} the horizontal range of the filter - * @param height {number} the vertical range of the filter - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the current resolution - * @param root {boolean} Whether this object is the root element or not + * @param [width=0] {number} the horizontal range of the filter + * @param [height=0] {number} the vertical range of the filter + * @param [scaleMode=CONST.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [resolution=CONST.RESOLUTION] {number} the current resolution + * @param [root=false] {boolean} Whether this object is the root element or not */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index 19cf00c..5c6006e 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,9 +9,9 @@ * * @class * @memberof PIXI - * @param source {Image|HTMLCanvasElement} the source object of the texture. + * @param [source ]{Image|HTMLCanvasElement} the source object of the texture. * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the resolution of the texture for devices with different pixel ratios + * @param [resolution=CONST.resolution] {number} the resolution of the texture for devices with different pixel ratios */ function BaseTexture(source, scaleMode, resolution) { @@ -26,7 +26,7 @@ * * @member {number} */ - this.resolution = resolution || 1; + this.resolution = resolution || CONST.RESOLUTION; /** * The width of the base texture set when the image has loaded diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index 660cb52..b979ff6 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -25,8 +25,8 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.Graphics} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -65,8 +65,8 @@ /** * Removes the last mask from the mask stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.popMask = function (target, maskData) { @@ -92,7 +92,7 @@ * Applies the Mask and adds it to the current filter stack. * * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param maskData {PIXI.Sprite} */ MaskManager.prototype.pushSpriteMask = function (target, maskData) { @@ -127,7 +127,7 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param maskData {any[]} + * @param maskData {*[]} */ MaskManager.prototype.pushStencilMask = function (maskData) { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 34d1181..15836da 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {any[]} The mask stack + * @param stencilMaskStack {*[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 195b7c6..ef1c280 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -10,11 +10,11 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} the current WebGL drawing context - * @param width {number} the horizontal range of the filter - * @param height {number} the vertical range of the filter - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the current resolution - * @param root {boolean} Whether this object is the root element or not + * @param [width=0] {number} the horizontal range of the filter + * @param [height=0] {number} the vertical range of the filter + * @param [scaleMode=CONST.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [resolution=CONST.RESOLUTION] {number} the current resolution + * @param [root=false] {boolean} Whether this object is the root element or not */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index 19cf00c..5c6006e 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,9 +9,9 @@ * * @class * @memberof PIXI - * @param source {Image|HTMLCanvasElement} the source object of the texture. + * @param [source ]{Image|HTMLCanvasElement} the source object of the texture. * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the resolution of the texture for devices with different pixel ratios + * @param [resolution=CONST.resolution] {number} the resolution of the texture for devices with different pixel ratios */ function BaseTexture(source, scaleMode, resolution) { @@ -26,7 +26,7 @@ * * @member {number} */ - this.resolution = resolution || 1; + this.resolution = resolution || CONST.RESOLUTION; /** * The width of the base texture set when the image has loaded diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 1598d1f..6e5f35a 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -327,8 +327,8 @@ * * @static * @param imageUrl {string} The image url of the texture - * @param crossorigin {boolean} Whether requests should be treated as crossorigin - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [crossorigin] {boolean} Whether requests should be treated as crossorigin + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} The newly created texture */ Texture.fromImage = function (imageUrl, crossorigin, scaleMode) @@ -369,7 +369,7 @@ * * @static * @param canvas {HTMLCanvasElement} The canvas element source of the texture - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ Texture.fromCanvas = function (canvas, scaleMode) @@ -381,8 +381,8 @@ * Helper function that creates a new Texture based on the given video element. * * @static - * @param video {HTMLVideoElement} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param video {HTMLVideoElement|string} The URL or actual element of the video + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideo = function (video, scaleMode) @@ -402,7 +402,7 @@ * * @static * @param videoUrl {string} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideoUrl = function (videoUrl, scaleMode) diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index 660cb52..b979ff6 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -25,8 +25,8 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.Graphics} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -65,8 +65,8 @@ /** * Removes the last mask from the mask stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.popMask = function (target, maskData) { @@ -92,7 +92,7 @@ * Applies the Mask and adds it to the current filter stack. * * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param maskData {PIXI.Sprite} */ MaskManager.prototype.pushSpriteMask = function (target, maskData) { @@ -127,7 +127,7 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param maskData {any[]} + * @param maskData {*[]} */ MaskManager.prototype.pushStencilMask = function (maskData) { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 34d1181..15836da 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {any[]} The mask stack + * @param stencilMaskStack {*[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 195b7c6..ef1c280 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -10,11 +10,11 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} the current WebGL drawing context - * @param width {number} the horizontal range of the filter - * @param height {number} the vertical range of the filter - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the current resolution - * @param root {boolean} Whether this object is the root element or not + * @param [width=0] {number} the horizontal range of the filter + * @param [height=0] {number} the vertical range of the filter + * @param [scaleMode=CONST.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [resolution=CONST.RESOLUTION] {number} the current resolution + * @param [root=false] {boolean} Whether this object is the root element or not */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index 19cf00c..5c6006e 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,9 +9,9 @@ * * @class * @memberof PIXI - * @param source {Image|HTMLCanvasElement} the source object of the texture. + * @param [source ]{Image|HTMLCanvasElement} the source object of the texture. * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the resolution of the texture for devices with different pixel ratios + * @param [resolution=CONST.resolution] {number} the resolution of the texture for devices with different pixel ratios */ function BaseTexture(source, scaleMode, resolution) { @@ -26,7 +26,7 @@ * * @member {number} */ - this.resolution = resolution || 1; + this.resolution = resolution || CONST.RESOLUTION; /** * The width of the base texture set when the image has loaded diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 1598d1f..6e5f35a 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -327,8 +327,8 @@ * * @static * @param imageUrl {string} The image url of the texture - * @param crossorigin {boolean} Whether requests should be treated as crossorigin - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [crossorigin] {boolean} Whether requests should be treated as crossorigin + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} The newly created texture */ Texture.fromImage = function (imageUrl, crossorigin, scaleMode) @@ -369,7 +369,7 @@ * * @static * @param canvas {HTMLCanvasElement} The canvas element source of the texture - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ Texture.fromCanvas = function (canvas, scaleMode) @@ -381,8 +381,8 @@ * Helper function that creates a new Texture based on the given video element. * * @static - * @param video {HTMLVideoElement} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param video {HTMLVideoElement|string} The URL or actual element of the video + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideo = function (video, scaleMode) @@ -402,7 +402,7 @@ * * @static * @param videoUrl {string} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideoUrl = function (videoUrl, scaleMode) diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index 5cf17d0..20acc6b 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -9,7 +9,7 @@ * @class * @extends PIXI.Sprite * @memberof PIXI.extras - * @param texture {Texture} the texture of the tiling sprite + * @param texture {core.Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite */ diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index 660cb52..b979ff6 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -25,8 +25,8 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.Graphics} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -65,8 +65,8 @@ /** * Removes the last mask from the mask stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.popMask = function (target, maskData) { @@ -92,7 +92,7 @@ * Applies the Mask and adds it to the current filter stack. * * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param maskData {PIXI.Sprite} */ MaskManager.prototype.pushSpriteMask = function (target, maskData) { @@ -127,7 +127,7 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param maskData {any[]} + * @param maskData {*[]} */ MaskManager.prototype.pushStencilMask = function (maskData) { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 34d1181..15836da 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {any[]} The mask stack + * @param stencilMaskStack {*[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 195b7c6..ef1c280 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -10,11 +10,11 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} the current WebGL drawing context - * @param width {number} the horizontal range of the filter - * @param height {number} the vertical range of the filter - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the current resolution - * @param root {boolean} Whether this object is the root element or not + * @param [width=0] {number} the horizontal range of the filter + * @param [height=0] {number} the vertical range of the filter + * @param [scaleMode=CONST.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [resolution=CONST.RESOLUTION] {number} the current resolution + * @param [root=false] {boolean} Whether this object is the root element or not */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index 19cf00c..5c6006e 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,9 +9,9 @@ * * @class * @memberof PIXI - * @param source {Image|HTMLCanvasElement} the source object of the texture. + * @param [source ]{Image|HTMLCanvasElement} the source object of the texture. * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the resolution of the texture for devices with different pixel ratios + * @param [resolution=CONST.resolution] {number} the resolution of the texture for devices with different pixel ratios */ function BaseTexture(source, scaleMode, resolution) { @@ -26,7 +26,7 @@ * * @member {number} */ - this.resolution = resolution || 1; + this.resolution = resolution || CONST.RESOLUTION; /** * The width of the base texture set when the image has loaded diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 1598d1f..6e5f35a 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -327,8 +327,8 @@ * * @static * @param imageUrl {string} The image url of the texture - * @param crossorigin {boolean} Whether requests should be treated as crossorigin - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [crossorigin] {boolean} Whether requests should be treated as crossorigin + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} The newly created texture */ Texture.fromImage = function (imageUrl, crossorigin, scaleMode) @@ -369,7 +369,7 @@ * * @static * @param canvas {HTMLCanvasElement} The canvas element source of the texture - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ Texture.fromCanvas = function (canvas, scaleMode) @@ -381,8 +381,8 @@ * Helper function that creates a new Texture based on the given video element. * * @static - * @param video {HTMLVideoElement} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param video {HTMLVideoElement|string} The URL or actual element of the video + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideo = function (video, scaleMode) @@ -402,7 +402,7 @@ * * @static * @param videoUrl {string} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideoUrl = function (videoUrl, scaleMode) diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index 5cf17d0..20acc6b 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -9,7 +9,7 @@ * @class * @extends PIXI.Sprite * @memberof PIXI.extras - * @param texture {Texture} the texture of the tiling sprite + * @param texture {core.Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite */ diff --git a/src/extras/cacheAsBitmap.js b/src/extras/cacheAsBitmap.js index eb33116..a6cf681 100644 --- a/src/extras/cacheAsBitmap.js +++ b/src/extras/cacheAsBitmap.js @@ -133,7 +133,7 @@ // this renderTexture will be used to store the cached DisplayObject - var renderTexture = new core.RenderTexture.create(bounds.width | 0, bounds.height | 0); + var renderTexture = core.RenderTexture.create(bounds.width | 0, bounds.height | 0); // need to set // var m = _tempMatrix; diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index 660cb52..b979ff6 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -25,8 +25,8 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.Graphics} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -65,8 +65,8 @@ /** * Removes the last mask from the mask stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.popMask = function (target, maskData) { @@ -92,7 +92,7 @@ * Applies the Mask and adds it to the current filter stack. * * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param maskData {PIXI.Sprite} */ MaskManager.prototype.pushSpriteMask = function (target, maskData) { @@ -127,7 +127,7 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param maskData {any[]} + * @param maskData {*[]} */ MaskManager.prototype.pushStencilMask = function (maskData) { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 34d1181..15836da 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {any[]} The mask stack + * @param stencilMaskStack {*[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 195b7c6..ef1c280 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -10,11 +10,11 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} the current WebGL drawing context - * @param width {number} the horizontal range of the filter - * @param height {number} the vertical range of the filter - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the current resolution - * @param root {boolean} Whether this object is the root element or not + * @param [width=0] {number} the horizontal range of the filter + * @param [height=0] {number} the vertical range of the filter + * @param [scaleMode=CONST.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [resolution=CONST.RESOLUTION] {number} the current resolution + * @param [root=false] {boolean} Whether this object is the root element or not */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index 19cf00c..5c6006e 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,9 +9,9 @@ * * @class * @memberof PIXI - * @param source {Image|HTMLCanvasElement} the source object of the texture. + * @param [source ]{Image|HTMLCanvasElement} the source object of the texture. * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the resolution of the texture for devices with different pixel ratios + * @param [resolution=CONST.resolution] {number} the resolution of the texture for devices with different pixel ratios */ function BaseTexture(source, scaleMode, resolution) { @@ -26,7 +26,7 @@ * * @member {number} */ - this.resolution = resolution || 1; + this.resolution = resolution || CONST.RESOLUTION; /** * The width of the base texture set when the image has loaded diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 1598d1f..6e5f35a 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -327,8 +327,8 @@ * * @static * @param imageUrl {string} The image url of the texture - * @param crossorigin {boolean} Whether requests should be treated as crossorigin - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [crossorigin] {boolean} Whether requests should be treated as crossorigin + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} The newly created texture */ Texture.fromImage = function (imageUrl, crossorigin, scaleMode) @@ -369,7 +369,7 @@ * * @static * @param canvas {HTMLCanvasElement} The canvas element source of the texture - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ Texture.fromCanvas = function (canvas, scaleMode) @@ -381,8 +381,8 @@ * Helper function that creates a new Texture based on the given video element. * * @static - * @param video {HTMLVideoElement} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param video {HTMLVideoElement|string} The URL or actual element of the video + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideo = function (video, scaleMode) @@ -402,7 +402,7 @@ * * @static * @param videoUrl {string} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideoUrl = function (videoUrl, scaleMode) diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index 5cf17d0..20acc6b 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -9,7 +9,7 @@ * @class * @extends PIXI.Sprite * @memberof PIXI.extras - * @param texture {Texture} the texture of the tiling sprite + * @param texture {core.Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite */ diff --git a/src/extras/cacheAsBitmap.js b/src/extras/cacheAsBitmap.js index eb33116..a6cf681 100644 --- a/src/extras/cacheAsBitmap.js +++ b/src/extras/cacheAsBitmap.js @@ -133,7 +133,7 @@ // this renderTexture will be used to store the cached DisplayObject - var renderTexture = new core.RenderTexture.create(bounds.width | 0, bounds.height | 0); + var renderTexture = core.RenderTexture.create(bounds.width | 0, bounds.height | 0); // need to set // var m = _tempMatrix; diff --git a/src/filters/colormatrix/ColorMatrixFilter.js b/src/filters/colormatrix/ColorMatrixFilter.js index fd6639c..1518690 100644 --- a/src/filters/colormatrix/ColorMatrixFilter.js +++ b/src/filters/colormatrix/ColorMatrixFilter.js @@ -233,8 +233,8 @@ * Set the saturation matrix, increase the separation between colors * Increase saturation : increase contrast, brightness, and sharpness * - * @param amount {number} - * @param multiply {boolean} refer to ._loadMatrix() method + * @param [amount=0] {number} + * @param [multiply] {boolean} refer to ._loadMatrix() method */ ColorMatrixFilter.prototype.saturate = function (amount, multiply) { @@ -256,9 +256,8 @@ * * Call the saturate function * - * @param multiply {boolean} refer to ._loadMatrix() method */ -ColorMatrixFilter.prototype.desaturate = function (multiply) // jshint unused:false +ColorMatrixFilter.prototype.desaturate = function () // jshint unused:false { this.saturate(-1); }; diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index 660cb52..b979ff6 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -25,8 +25,8 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.Graphics} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -65,8 +65,8 @@ /** * Removes the last mask from the mask stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.popMask = function (target, maskData) { @@ -92,7 +92,7 @@ * Applies the Mask and adds it to the current filter stack. * * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param maskData {PIXI.Sprite} */ MaskManager.prototype.pushSpriteMask = function (target, maskData) { @@ -127,7 +127,7 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param maskData {any[]} + * @param maskData {*[]} */ MaskManager.prototype.pushStencilMask = function (maskData) { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 34d1181..15836da 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {any[]} The mask stack + * @param stencilMaskStack {*[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 195b7c6..ef1c280 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -10,11 +10,11 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} the current WebGL drawing context - * @param width {number} the horizontal range of the filter - * @param height {number} the vertical range of the filter - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the current resolution - * @param root {boolean} Whether this object is the root element or not + * @param [width=0] {number} the horizontal range of the filter + * @param [height=0] {number} the vertical range of the filter + * @param [scaleMode=CONST.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [resolution=CONST.RESOLUTION] {number} the current resolution + * @param [root=false] {boolean} Whether this object is the root element or not */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index 19cf00c..5c6006e 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,9 +9,9 @@ * * @class * @memberof PIXI - * @param source {Image|HTMLCanvasElement} the source object of the texture. + * @param [source ]{Image|HTMLCanvasElement} the source object of the texture. * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the resolution of the texture for devices with different pixel ratios + * @param [resolution=CONST.resolution] {number} the resolution of the texture for devices with different pixel ratios */ function BaseTexture(source, scaleMode, resolution) { @@ -26,7 +26,7 @@ * * @member {number} */ - this.resolution = resolution || 1; + this.resolution = resolution || CONST.RESOLUTION; /** * The width of the base texture set when the image has loaded diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 1598d1f..6e5f35a 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -327,8 +327,8 @@ * * @static * @param imageUrl {string} The image url of the texture - * @param crossorigin {boolean} Whether requests should be treated as crossorigin - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [crossorigin] {boolean} Whether requests should be treated as crossorigin + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} The newly created texture */ Texture.fromImage = function (imageUrl, crossorigin, scaleMode) @@ -369,7 +369,7 @@ * * @static * @param canvas {HTMLCanvasElement} The canvas element source of the texture - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ Texture.fromCanvas = function (canvas, scaleMode) @@ -381,8 +381,8 @@ * Helper function that creates a new Texture based on the given video element. * * @static - * @param video {HTMLVideoElement} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param video {HTMLVideoElement|string} The URL or actual element of the video + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideo = function (video, scaleMode) @@ -402,7 +402,7 @@ * * @static * @param videoUrl {string} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideoUrl = function (videoUrl, scaleMode) diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index 5cf17d0..20acc6b 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -9,7 +9,7 @@ * @class * @extends PIXI.Sprite * @memberof PIXI.extras - * @param texture {Texture} the texture of the tiling sprite + * @param texture {core.Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite */ diff --git a/src/extras/cacheAsBitmap.js b/src/extras/cacheAsBitmap.js index eb33116..a6cf681 100644 --- a/src/extras/cacheAsBitmap.js +++ b/src/extras/cacheAsBitmap.js @@ -133,7 +133,7 @@ // this renderTexture will be used to store the cached DisplayObject - var renderTexture = new core.RenderTexture.create(bounds.width | 0, bounds.height | 0); + var renderTexture = core.RenderTexture.create(bounds.width | 0, bounds.height | 0); // need to set // var m = _tempMatrix; diff --git a/src/filters/colormatrix/ColorMatrixFilter.js b/src/filters/colormatrix/ColorMatrixFilter.js index fd6639c..1518690 100644 --- a/src/filters/colormatrix/ColorMatrixFilter.js +++ b/src/filters/colormatrix/ColorMatrixFilter.js @@ -233,8 +233,8 @@ * Set the saturation matrix, increase the separation between colors * Increase saturation : increase contrast, brightness, and sharpness * - * @param amount {number} - * @param multiply {boolean} refer to ._loadMatrix() method + * @param [amount=0] {number} + * @param [multiply] {boolean} refer to ._loadMatrix() method */ ColorMatrixFilter.prototype.saturate = function (amount, multiply) { @@ -256,9 +256,8 @@ * * Call the saturate function * - * @param multiply {boolean} refer to ._loadMatrix() method */ -ColorMatrixFilter.prototype.desaturate = function (multiply) // jshint unused:false +ColorMatrixFilter.prototype.desaturate = function () // jshint unused:false { this.saturate(-1); }; diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index ed630cf..1afce6b 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -359,11 +359,11 @@ * This function is provides a neat way of crawling through the scene graph and running a specified function on all interactive objects it finds. * It will also take care of hit testing the interactive objects and passes the hit across in the function. * - * @param point {PIXI.Point} point the point that is tested for collision - * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject the displayObject that will be hit test (recurcsivly crawls its children) - * @param func {Function} func the function that will be called on each interactive object. The displayObject and hit will be passed to the function - * @param hitTest {boolean} hitTest this indicates if the objects inside should be hit test against the point - * @param interactive {boolean} Whether the displayObject is interactive + * @param point {PIXI.Point} the point that is tested for collision + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the displayObject that will be hit test (recurcsivly crawls its children) + * @param [func] {Function} the function that will be called on each interactive object. The displayObject and hit will be passed to the function + * @param [hitTest] {boolean} this indicates if the objects inside should be hit test against the point + * @param [interactive] {boolean} Whether the displayObject is interactive * @return {boolean} returns true if the displayObject hit the point */ InteractionManager.prototype.processInteractive = function (point, displayObject, func, hitTest, interactive) diff --git a/src/core/display/Container.js b/src/core/display/Container.js index 67b79b9..8f22145 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -316,8 +316,8 @@ /** * Removes all children from this container that are within the begin and end indexes. * - * @param beginIndex {number} The beginning position. Default value is 0. - * @param endIndex {number} The ending position. Default value is size of the container. + * @param [beginIndex=0] {number} The beginning position. + * @param [endIndex=this.children.length] {number} The ending position. Default value is size of the container. */ Container.prototype.removeChildren = function (beginIndex, endIndex) { @@ -478,7 +478,7 @@ this._currentBounds = null; - return this.getBounds( math.Matrix.IDENTITY ); + return this.getBounds(); }; /** @@ -589,7 +589,7 @@ if (this._mask) { - renderer.maskManager.pushMask(this._mask, renderer); + renderer.maskManager.pushMask(this._mask); } this._renderCanvas(renderer); diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 018cec8..95d69f9 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -341,10 +341,9 @@ * * Retrieves the bounds of the displayObject as a rectangle object * - * @param matrix {PIXI.Matrix} * @return {PIXI.Rectangle} the rectangular bounding area */ -DisplayObject.prototype.getBounds = function (matrix) // jshint unused:false +DisplayObject.prototype.getBounds = function () // jshint unused:false { return math.Rectangle.EMPTY; }; diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index 841acb3..4d65964 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -5,7 +5,7 @@ * @memberof PIXI * * @param cb {function} The function to be called when the point changes - * @param scope {any} The scope to be applied to the cb + * @param scope {*} The scope to be applied to the cb * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index 5bdecf4..5e3afa2 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -981,7 +981,7 @@ /** * Draws the given shape to this Graphics object. Can be any of Circle, Rectangle, Ellipse, Line or Polygon. * - * @param shape {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Ellipse|PIXI.math.Polygon|PIXI.math.Rectangle|PIXI.math.RoundedRectangle} The shape object to draw. * @return {PIXI.GraphicsData} The generated GraphicsData object. */ Graphics.prototype.drawShape = function (shape) diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 7fe1176..d73d089 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -9,7 +9,7 @@ * @param fillColor {number} the color of the fill * @param fillAlpha {number} the alpha of the fill * @param fill {boolean} whether or not the shape is filled with a colour - * @param shape {Circle|Rectangle|Ellipse|Line|Polygon} The shape object to draw. + * @param shape {PIXI.math.Circle|PIXI.math.Rectangle|PIXI.math.Ellipse|PIXI.math.Line|PIXI.math.Polygon} The shape object to draw. */ function GraphicsData(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, shape) { diff --git a/src/core/graphics/webgl/utils/buildCircle.js b/src/core/graphics/webgl/utils/buildCircle.js index 238f1ea..22daa8f 100644 --- a/src/core/graphics/webgl/utils/buildCircle.js +++ b/src/core/graphics/webgl/utils/buildCircle.js @@ -6,7 +6,7 @@ * Builds a circle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object to draw + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object to draw * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildCircle = function (graphicsData, webGLData) diff --git a/src/core/graphics/webgl/utils/buildLine.js b/src/core/graphics/webgl/utils/buildLine.js index 5e2b985..d2b9e5b 100644 --- a/src/core/graphics/webgl/utils/buildLine.js +++ b/src/core/graphics/webgl/utils/buildLine.js @@ -5,7 +5,7 @@ * Builds a line to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildLine = function (graphicsData, webGLData) @@ -216,4 +216,4 @@ indices.push(indexStart-1); }; -module.exports = buildLine; \ No newline at end of file +module.exports = buildLine; diff --git a/src/core/graphics/webgl/utils/buildRectangle.js b/src/core/graphics/webgl/utils/buildRectangle.js index 5b3f32b..965e421 100644 --- a/src/core/graphics/webgl/utils/buildRectangle.js +++ b/src/core/graphics/webgl/utils/buildRectangle.js @@ -5,7 +5,7 @@ * Builds a rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRectangle = function (graphicsData, webGLData) @@ -67,4 +67,4 @@ } }; -module.exports = buildRectangle; \ No newline at end of file +module.exports = buildRectangle; diff --git a/src/core/graphics/webgl/utils/buildRoundedRectangle.js b/src/core/graphics/webgl/utils/buildRoundedRectangle.js index 5d9ff67..c7ac216 100644 --- a/src/core/graphics/webgl/utils/buildRoundedRectangle.js +++ b/src/core/graphics/webgl/utils/buildRoundedRectangle.js @@ -6,7 +6,7 @@ * Builds a rounded rectangle to draw * * @private - * @param graphicsData {PIXI.Graphics} The graphics object containing all the necessary properties + * @param graphicsData {PIXI.WebGLGraphicsData} The graphics object containing all the necessary properties * @param webGLData {object} an object containing all the webGL-specific information to create this shape */ var buildRoundedRectangle = function (graphicsData, webGLData) diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 899e7cf..502b83d 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,7 @@ /** * Renders the object to this canvas view * - * @param displayObject {PIXI.DisplayObject} The object to be rendered + * @param displayObject {core.DisplayObject} The object to be rendered * @param [renderTexture] {PIXI.RenderTexture} A render texture to be rendered to. If unset, it will render to the root context. * @param [clear=false] {boolean} Whether to clear the canvas before drawing * @param [transform] {PIXI.Transform} A transformation to be applied diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 7a5b705..3b40f53 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -194,10 +194,10 @@ /** * Renders the object to its webGL view * - * @param displayObject {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.RenderTexture} + * @param displayObject {core.DisplayObject} the object to be rendered + * @param renderTexture {core.RenderTexture} * @param clear {Boolean} - * @param transform {PIXI.Transform} + * @param transform {core.Matrix} * @param skipUpdateTransform {Boolean} */ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) @@ -314,7 +314,7 @@ /** * Erases the active render target and fills the drawing area with a colour * - * @param clearColor {number} The colour + * @param [clearColor] {number} The colour */ WebGLRenderer.prototype.clear = function (clearColor) { @@ -335,8 +335,8 @@ /** * Binds a render texture for rendering * - * @param renderTexture {PIXI.RenderTexture} The render texture to render - * @param transform {PIXI.Transform} The transform to be applied to the render texture + * @param renderTexture {core.RenderTexture} The render texture to render + * @param transform {core.Matrix} The transform to be applied to the render texture */ WebGLRenderer.prototype.bindRenderTexture = function (renderTexture, transform) { diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index 660cb52..b979ff6 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -25,8 +25,8 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.Graphics} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -65,8 +65,8 @@ /** * Removes the last mask from the mask stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param target {PIXI.DisplayObject} + * @param maskData {*[]} */ MaskManager.prototype.popMask = function (target, maskData) { @@ -92,7 +92,7 @@ * Applies the Mask and adds it to the current filter stack. * * @param target {PIXI.RenderTarget} - * @param maskData {any[]} + * @param maskData {PIXI.Sprite} */ MaskManager.prototype.pushSpriteMask = function (target, maskData) { @@ -127,7 +127,7 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param maskData {any[]} + * @param maskData {*[]} */ MaskManager.prototype.pushStencilMask = function (maskData) { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 34d1181..15836da 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -18,7 +18,7 @@ /** * Changes the mask stack that is used by this manager. * - * @param stencilMaskStack {any[]} The mask stack + * @param stencilMaskStack {*[]} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 195b7c6..ef1c280 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -10,11 +10,11 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} the current WebGL drawing context - * @param width {number} the horizontal range of the filter - * @param height {number} the vertical range of the filter - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the current resolution - * @param root {boolean} Whether this object is the root element or not + * @param [width=0] {number} the horizontal range of the filter + * @param [height=0] {number} the vertical range of the filter + * @param [scaleMode=CONST.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [resolution=CONST.RESOLUTION] {number} the current resolution + * @param [root=false] {boolean} Whether this object is the root element or not */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index 19cf00c..5c6006e 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,9 +9,9 @@ * * @class * @memberof PIXI - * @param source {Image|HTMLCanvasElement} the source object of the texture. + * @param [source ]{Image|HTMLCanvasElement} the source object of the texture. * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} See {@link PIXI.SCALE_MODES} for possible values - * @param resolution {number} the resolution of the texture for devices with different pixel ratios + * @param [resolution=CONST.resolution] {number} the resolution of the texture for devices with different pixel ratios */ function BaseTexture(source, scaleMode, resolution) { @@ -26,7 +26,7 @@ * * @member {number} */ - this.resolution = resolution || 1; + this.resolution = resolution || CONST.RESOLUTION; /** * The width of the base texture set when the image has loaded diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 1598d1f..6e5f35a 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -327,8 +327,8 @@ * * @static * @param imageUrl {string} The image url of the texture - * @param crossorigin {boolean} Whether requests should be treated as crossorigin - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [crossorigin] {boolean} Whether requests should be treated as crossorigin + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} The newly created texture */ Texture.fromImage = function (imageUrl, crossorigin, scaleMode) @@ -369,7 +369,7 @@ * * @static * @param canvas {HTMLCanvasElement} The canvas element source of the texture - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ Texture.fromCanvas = function (canvas, scaleMode) @@ -381,8 +381,8 @@ * Helper function that creates a new Texture based on the given video element. * * @static - * @param video {HTMLVideoElement} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param video {HTMLVideoElement|string} The URL or actual element of the video + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideo = function (video, scaleMode) @@ -402,7 +402,7 @@ * * @static * @param videoUrl {string} - * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values + * @param [scaleMode] {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} A Texture */ Texture.fromVideoUrl = function (videoUrl, scaleMode) diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index 5cf17d0..20acc6b 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -9,7 +9,7 @@ * @class * @extends PIXI.Sprite * @memberof PIXI.extras - * @param texture {Texture} the texture of the tiling sprite + * @param texture {core.Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite */ diff --git a/src/extras/cacheAsBitmap.js b/src/extras/cacheAsBitmap.js index eb33116..a6cf681 100644 --- a/src/extras/cacheAsBitmap.js +++ b/src/extras/cacheAsBitmap.js @@ -133,7 +133,7 @@ // this renderTexture will be used to store the cached DisplayObject - var renderTexture = new core.RenderTexture.create(bounds.width | 0, bounds.height | 0); + var renderTexture = core.RenderTexture.create(bounds.width | 0, bounds.height | 0); // need to set // var m = _tempMatrix; diff --git a/src/filters/colormatrix/ColorMatrixFilter.js b/src/filters/colormatrix/ColorMatrixFilter.js index fd6639c..1518690 100644 --- a/src/filters/colormatrix/ColorMatrixFilter.js +++ b/src/filters/colormatrix/ColorMatrixFilter.js @@ -233,8 +233,8 @@ * Set the saturation matrix, increase the separation between colors * Increase saturation : increase contrast, brightness, and sharpness * - * @param amount {number} - * @param multiply {boolean} refer to ._loadMatrix() method + * @param [amount=0] {number} + * @param [multiply] {boolean} refer to ._loadMatrix() method */ ColorMatrixFilter.prototype.saturate = function (amount, multiply) { @@ -256,9 +256,8 @@ * * Call the saturate function * - * @param multiply {boolean} refer to ._loadMatrix() method */ -ColorMatrixFilter.prototype.desaturate = function (multiply) // jshint unused:false +ColorMatrixFilter.prototype.desaturate = function () // jshint unused:false { this.saturate(-1); }; diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index ed630cf..1afce6b 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -359,11 +359,11 @@ * This function is provides a neat way of crawling through the scene graph and running a specified function on all interactive objects it finds. * It will also take care of hit testing the interactive objects and passes the hit across in the function. * - * @param point {PIXI.Point} point the point that is tested for collision - * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject the displayObject that will be hit test (recurcsivly crawls its children) - * @param func {Function} func the function that will be called on each interactive object. The displayObject and hit will be passed to the function - * @param hitTest {boolean} hitTest this indicates if the objects inside should be hit test against the point - * @param interactive {boolean} Whether the displayObject is interactive + * @param point {PIXI.Point} the point that is tested for collision + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the displayObject that will be hit test (recurcsivly crawls its children) + * @param [func] {Function} the function that will be called on each interactive object. The displayObject and hit will be passed to the function + * @param [hitTest] {boolean} this indicates if the objects inside should be hit test against the point + * @param [interactive] {boolean} Whether the displayObject is interactive * @return {boolean} returns true if the displayObject hit the point */ InteractionManager.prototype.processInteractive = function (point, displayObject, func, hitTest, interactive) diff --git a/src/mesh/Mesh.js b/src/mesh/Mesh.js index 1837475..fd60ae2 100644 --- a/src/mesh/Mesh.js +++ b/src/mesh/Mesh.js @@ -418,7 +418,7 @@ /** * Returns the bounds of the mesh as a rectangle. The bounds calculation takes the worldTransform into account. * - * @param matrix {PIXI.Matrix} the transformation matrix of the sprite + * @param [matrix=this.worldTransform] {PIXI.Matrix} the transformation matrix of the sprite * @return {PIXI.Rectangle} the framing rectangle */ Mesh.prototype.getBounds = function (matrix)