diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index caf54c3..deef319 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ Extract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ Extract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ Extract.prototype.canvas = function ( target ) @@ -63,7 +63,7 @@ else { renderTexture = this.renderer.generateTexture(target); - + } } @@ -83,16 +83,16 @@ frame = tempRect; frame.width = textureBuffer.size.width; frame.height = textureBuffer.size.height; - + } - + var width = frame.width * resolution; var height = frame.height * resolution; var canvasBuffer = new core.CanvasRenderTarget(width, height); - + if(textureBuffer) { // bind the buffer @@ -100,7 +100,7 @@ // set up an array of pixels var webGLPixels = new Uint8Array(4 * width * height); - + // read pixels to the array var gl = renderer.gl; gl.readPixels(frame.x * resolution, frame.y * resolution, width, height, gl.RGBA, gl.UNSIGNED_BYTE, webGLPixels); @@ -125,10 +125,10 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ -Extract.prototype.pixels = function ( renderTexture, area ) +Extract.prototype.pixels = function ( renderTexture ) { var renderer = this.renderer; var textureBuffer; @@ -157,7 +157,7 @@ var gl = this.renderer.gl; var webGLPixels = new Uint8Array(4 * width * height); - + if(textureBuffer) { // bind the buffer diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index caf54c3..deef319 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ Extract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ Extract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ Extract.prototype.canvas = function ( target ) @@ -63,7 +63,7 @@ else { renderTexture = this.renderer.generateTexture(target); - + } } @@ -83,16 +83,16 @@ frame = tempRect; frame.width = textureBuffer.size.width; frame.height = textureBuffer.size.height; - + } - + var width = frame.width * resolution; var height = frame.height * resolution; var canvasBuffer = new core.CanvasRenderTarget(width, height); - + if(textureBuffer) { // bind the buffer @@ -100,7 +100,7 @@ // set up an array of pixels var webGLPixels = new Uint8Array(4 * width * height); - + // read pixels to the array var gl = renderer.gl; gl.readPixels(frame.x * resolution, frame.y * resolution, width, height, gl.RGBA, gl.UNSIGNED_BYTE, webGLPixels); @@ -125,10 +125,10 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ -Extract.prototype.pixels = function ( renderTexture, area ) +Extract.prototype.pixels = function ( renderTexture ) { var renderer = this.renderer; var textureBuffer; @@ -157,7 +157,7 @@ var gl = this.renderer.gl; var webGLPixels = new Uint8Array(4 * width * height); - + if(textureBuffer) { // bind the buffer diff --git a/src/extras/BitmapText.js b/src/extras/BitmapText.js index 42ae05c..041e39c 100644 --- a/src/extras/BitmapText.js +++ b/src/extras/BitmapText.js @@ -162,7 +162,7 @@ /** * The font descriptor of the BitmapText object * - * @member {Font} + * @member {string|object} * @memberof PIXI.extras.BitmapText# */ font: { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index caf54c3..deef319 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ Extract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ Extract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ Extract.prototype.canvas = function ( target ) @@ -63,7 +63,7 @@ else { renderTexture = this.renderer.generateTexture(target); - + } } @@ -83,16 +83,16 @@ frame = tempRect; frame.width = textureBuffer.size.width; frame.height = textureBuffer.size.height; - + } - + var width = frame.width * resolution; var height = frame.height * resolution; var canvasBuffer = new core.CanvasRenderTarget(width, height); - + if(textureBuffer) { // bind the buffer @@ -100,7 +100,7 @@ // set up an array of pixels var webGLPixels = new Uint8Array(4 * width * height); - + // read pixels to the array var gl = renderer.gl; gl.readPixels(frame.x * resolution, frame.y * resolution, width, height, gl.RGBA, gl.UNSIGNED_BYTE, webGLPixels); @@ -125,10 +125,10 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ -Extract.prototype.pixels = function ( renderTexture, area ) +Extract.prototype.pixels = function ( renderTexture ) { var renderer = this.renderer; var textureBuffer; @@ -157,7 +157,7 @@ var gl = this.renderer.gl; var webGLPixels = new Uint8Array(4 * width * height); - + if(textureBuffer) { // bind the buffer diff --git a/src/extras/BitmapText.js b/src/extras/BitmapText.js index 42ae05c..041e39c 100644 --- a/src/extras/BitmapText.js +++ b/src/extras/BitmapText.js @@ -162,7 +162,7 @@ /** * The font descriptor of the BitmapText object * - * @member {Font} + * @member {string|object} * @memberof PIXI.extras.BitmapText# */ font: { diff --git a/src/extras/webgl/TilingShader.js b/src/extras/webgl/TilingShader.js index 4be2d40..19b33b6 100644 --- a/src/extras/webgl/TilingShader.js +++ b/src/extras/webgl/TilingShader.js @@ -5,7 +5,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {PIXI.Shader} The WebGL shader manager this shader works for. */ function TilingShader(gl) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index caf54c3..deef319 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ Extract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ Extract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ Extract.prototype.canvas = function ( target ) @@ -63,7 +63,7 @@ else { renderTexture = this.renderer.generateTexture(target); - + } } @@ -83,16 +83,16 @@ frame = tempRect; frame.width = textureBuffer.size.width; frame.height = textureBuffer.size.height; - + } - + var width = frame.width * resolution; var height = frame.height * resolution; var canvasBuffer = new core.CanvasRenderTarget(width, height); - + if(textureBuffer) { // bind the buffer @@ -100,7 +100,7 @@ // set up an array of pixels var webGLPixels = new Uint8Array(4 * width * height); - + // read pixels to the array var gl = renderer.gl; gl.readPixels(frame.x * resolution, frame.y * resolution, width, height, gl.RGBA, gl.UNSIGNED_BYTE, webGLPixels); @@ -125,10 +125,10 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ -Extract.prototype.pixels = function ( renderTexture, area ) +Extract.prototype.pixels = function ( renderTexture ) { var renderer = this.renderer; var textureBuffer; @@ -157,7 +157,7 @@ var gl = this.renderer.gl; var webGLPixels = new Uint8Array(4 * width * height); - + if(textureBuffer) { // bind the buffer diff --git a/src/extras/BitmapText.js b/src/extras/BitmapText.js index 42ae05c..041e39c 100644 --- a/src/extras/BitmapText.js +++ b/src/extras/BitmapText.js @@ -162,7 +162,7 @@ /** * The font descriptor of the BitmapText object * - * @member {Font} + * @member {string|object} * @memberof PIXI.extras.BitmapText# */ font: { diff --git a/src/extras/webgl/TilingShader.js b/src/extras/webgl/TilingShader.js index 4be2d40..19b33b6 100644 --- a/src/extras/webgl/TilingShader.js +++ b/src/extras/webgl/TilingShader.js @@ -5,7 +5,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {PIXI.Shader} The WebGL shader manager this shader works for. */ function TilingShader(gl) { diff --git a/src/filters/displacement/DisplacementFilter.js b/src/filters/displacement/DisplacementFilter.js index 079077c..aa18fda 100644 --- a/src/filters/displacement/DisplacementFilter.js +++ b/src/filters/displacement/DisplacementFilter.js @@ -9,7 +9,8 @@ * @class * @extends PIXI.Filter * @memberof PIXI.filters - * @param sprite {PIXI.Sprite} the sprite used for the displacement map. (make sure its added to the scene!) + * @param sprite {PIXI.Sprite} The sprite used for the displacement map. (make sure its added to the scene!) + * @param scale {number} The scale of the displacement */ function DisplacementFilter(sprite, scale) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index caf54c3..deef319 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ Extract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ Extract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ Extract.prototype.canvas = function ( target ) @@ -63,7 +63,7 @@ else { renderTexture = this.renderer.generateTexture(target); - + } } @@ -83,16 +83,16 @@ frame = tempRect; frame.width = textureBuffer.size.width; frame.height = textureBuffer.size.height; - + } - + var width = frame.width * resolution; var height = frame.height * resolution; var canvasBuffer = new core.CanvasRenderTarget(width, height); - + if(textureBuffer) { // bind the buffer @@ -100,7 +100,7 @@ // set up an array of pixels var webGLPixels = new Uint8Array(4 * width * height); - + // read pixels to the array var gl = renderer.gl; gl.readPixels(frame.x * resolution, frame.y * resolution, width, height, gl.RGBA, gl.UNSIGNED_BYTE, webGLPixels); @@ -125,10 +125,10 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ -Extract.prototype.pixels = function ( renderTexture, area ) +Extract.prototype.pixels = function ( renderTexture ) { var renderer = this.renderer; var textureBuffer; @@ -157,7 +157,7 @@ var gl = this.renderer.gl; var webGLPixels = new Uint8Array(4 * width * height); - + if(textureBuffer) { // bind the buffer diff --git a/src/extras/BitmapText.js b/src/extras/BitmapText.js index 42ae05c..041e39c 100644 --- a/src/extras/BitmapText.js +++ b/src/extras/BitmapText.js @@ -162,7 +162,7 @@ /** * The font descriptor of the BitmapText object * - * @member {Font} + * @member {string|object} * @memberof PIXI.extras.BitmapText# */ font: { diff --git a/src/extras/webgl/TilingShader.js b/src/extras/webgl/TilingShader.js index 4be2d40..19b33b6 100644 --- a/src/extras/webgl/TilingShader.js +++ b/src/extras/webgl/TilingShader.js @@ -5,7 +5,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {PIXI.Shader} The WebGL shader manager this shader works for. */ function TilingShader(gl) { diff --git a/src/filters/displacement/DisplacementFilter.js b/src/filters/displacement/DisplacementFilter.js index 079077c..aa18fda 100644 --- a/src/filters/displacement/DisplacementFilter.js +++ b/src/filters/displacement/DisplacementFilter.js @@ -9,7 +9,8 @@ * @class * @extends PIXI.Filter * @memberof PIXI.filters - * @param sprite {PIXI.Sprite} the sprite used for the displacement map. (make sure its added to the scene!) + * @param sprite {PIXI.Sprite} The sprite used for the displacement map. (make sure its added to the scene!) + * @param scale {number} The scale of the displacement */ function DisplacementFilter(sprite, scale) { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index c9e877f..fb078e8 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -358,10 +358,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 {PIXI.Point} point the point that is tested for collision - * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject the displayObject that will be hit test (recurcsivly crawls its children) - * @param {Function} func the function that will be called on each interactive object. The displayObject and hit will be passed to the function - * @param {boolean} hitTest this indicates if the objects inside should be hit test against the point + * @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 * @return {boolean} returns true if the displayObject hit the point */ InteractionManager.prototype.processInteractive = function (point, displayObject, func, hitTest, interactive) @@ -850,7 +851,7 @@ /** * Grabs an interaction data object from the internal pool * - * @param touchEvent {EventData} The touch event we need to pair with an interactionData object + * @param touchEvent {object} The touch event we need to pair with an interactionData object * * @private */ diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index caf54c3..deef319 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ Extract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ Extract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ Extract.prototype.canvas = function ( target ) @@ -63,7 +63,7 @@ else { renderTexture = this.renderer.generateTexture(target); - + } } @@ -83,16 +83,16 @@ frame = tempRect; frame.width = textureBuffer.size.width; frame.height = textureBuffer.size.height; - + } - + var width = frame.width * resolution; var height = frame.height * resolution; var canvasBuffer = new core.CanvasRenderTarget(width, height); - + if(textureBuffer) { // bind the buffer @@ -100,7 +100,7 @@ // set up an array of pixels var webGLPixels = new Uint8Array(4 * width * height); - + // read pixels to the array var gl = renderer.gl; gl.readPixels(frame.x * resolution, frame.y * resolution, width, height, gl.RGBA, gl.UNSIGNED_BYTE, webGLPixels); @@ -125,10 +125,10 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ -Extract.prototype.pixels = function ( renderTexture, area ) +Extract.prototype.pixels = function ( renderTexture ) { var renderer = this.renderer; var textureBuffer; @@ -157,7 +157,7 @@ var gl = this.renderer.gl; var webGLPixels = new Uint8Array(4 * width * height); - + if(textureBuffer) { // bind the buffer diff --git a/src/extras/BitmapText.js b/src/extras/BitmapText.js index 42ae05c..041e39c 100644 --- a/src/extras/BitmapText.js +++ b/src/extras/BitmapText.js @@ -162,7 +162,7 @@ /** * The font descriptor of the BitmapText object * - * @member {Font} + * @member {string|object} * @memberof PIXI.extras.BitmapText# */ font: { diff --git a/src/extras/webgl/TilingShader.js b/src/extras/webgl/TilingShader.js index 4be2d40..19b33b6 100644 --- a/src/extras/webgl/TilingShader.js +++ b/src/extras/webgl/TilingShader.js @@ -5,7 +5,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {PIXI.Shader} The WebGL shader manager this shader works for. */ function TilingShader(gl) { diff --git a/src/filters/displacement/DisplacementFilter.js b/src/filters/displacement/DisplacementFilter.js index 079077c..aa18fda 100644 --- a/src/filters/displacement/DisplacementFilter.js +++ b/src/filters/displacement/DisplacementFilter.js @@ -9,7 +9,8 @@ * @class * @extends PIXI.Filter * @memberof PIXI.filters - * @param sprite {PIXI.Sprite} the sprite used for the displacement map. (make sure its added to the scene!) + * @param sprite {PIXI.Sprite} The sprite used for the displacement map. (make sure its added to the scene!) + * @param scale {number} The scale of the displacement */ function DisplacementFilter(sprite, scale) { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index c9e877f..fb078e8 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -358,10 +358,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 {PIXI.Point} point the point that is tested for collision - * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject the displayObject that will be hit test (recurcsivly crawls its children) - * @param {Function} func the function that will be called on each interactive object. The displayObject and hit will be passed to the function - * @param {boolean} hitTest this indicates if the objects inside should be hit test against the point + * @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 * @return {boolean} returns true if the displayObject hit the point */ InteractionManager.prototype.processInteractive = function (point, displayObject, func, hitTest, interactive) @@ -850,7 +851,7 @@ /** * Grabs an interaction data object from the internal pool * - * @param touchEvent {EventData} The touch event we need to pair with an interactionData object + * @param touchEvent {object} The touch event we need to pair with an interactionData object * * @private */ diff --git a/src/loaders/loader.js b/src/loaders/loader.js index 8842e3a..07ca093 100644 --- a/src/loaders/loader.js +++ b/src/loaders/loader.js @@ -20,7 +20,7 @@ * ``` * * @class - * @extends PIXI.ResourceLoader + * @extends module:resource-loader.ResourceLoader * @memberof PIXI.loaders * @param [baseUrl=''] {string} The base url for all resources loaded by this loader. * @param [concurrency=10] {number} The number of resources to load concurrently. diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index caf54c3..deef319 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ Extract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ Extract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ Extract.prototype.canvas = function ( target ) @@ -63,7 +63,7 @@ else { renderTexture = this.renderer.generateTexture(target); - + } } @@ -83,16 +83,16 @@ frame = tempRect; frame.width = textureBuffer.size.width; frame.height = textureBuffer.size.height; - + } - + var width = frame.width * resolution; var height = frame.height * resolution; var canvasBuffer = new core.CanvasRenderTarget(width, height); - + if(textureBuffer) { // bind the buffer @@ -100,7 +100,7 @@ // set up an array of pixels var webGLPixels = new Uint8Array(4 * width * height); - + // read pixels to the array var gl = renderer.gl; gl.readPixels(frame.x * resolution, frame.y * resolution, width, height, gl.RGBA, gl.UNSIGNED_BYTE, webGLPixels); @@ -125,10 +125,10 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ -Extract.prototype.pixels = function ( renderTexture, area ) +Extract.prototype.pixels = function ( renderTexture ) { var renderer = this.renderer; var textureBuffer; @@ -157,7 +157,7 @@ var gl = this.renderer.gl; var webGLPixels = new Uint8Array(4 * width * height); - + if(textureBuffer) { // bind the buffer diff --git a/src/extras/BitmapText.js b/src/extras/BitmapText.js index 42ae05c..041e39c 100644 --- a/src/extras/BitmapText.js +++ b/src/extras/BitmapText.js @@ -162,7 +162,7 @@ /** * The font descriptor of the BitmapText object * - * @member {Font} + * @member {string|object} * @memberof PIXI.extras.BitmapText# */ font: { diff --git a/src/extras/webgl/TilingShader.js b/src/extras/webgl/TilingShader.js index 4be2d40..19b33b6 100644 --- a/src/extras/webgl/TilingShader.js +++ b/src/extras/webgl/TilingShader.js @@ -5,7 +5,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {PIXI.Shader} The WebGL shader manager this shader works for. */ function TilingShader(gl) { diff --git a/src/filters/displacement/DisplacementFilter.js b/src/filters/displacement/DisplacementFilter.js index 079077c..aa18fda 100644 --- a/src/filters/displacement/DisplacementFilter.js +++ b/src/filters/displacement/DisplacementFilter.js @@ -9,7 +9,8 @@ * @class * @extends PIXI.Filter * @memberof PIXI.filters - * @param sprite {PIXI.Sprite} the sprite used for the displacement map. (make sure its added to the scene!) + * @param sprite {PIXI.Sprite} The sprite used for the displacement map. (make sure its added to the scene!) + * @param scale {number} The scale of the displacement */ function DisplacementFilter(sprite, scale) { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index c9e877f..fb078e8 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -358,10 +358,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 {PIXI.Point} point the point that is tested for collision - * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject the displayObject that will be hit test (recurcsivly crawls its children) - * @param {Function} func the function that will be called on each interactive object. The displayObject and hit will be passed to the function - * @param {boolean} hitTest this indicates if the objects inside should be hit test against the point + * @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 * @return {boolean} returns true if the displayObject hit the point */ InteractionManager.prototype.processInteractive = function (point, displayObject, func, hitTest, interactive) @@ -850,7 +851,7 @@ /** * Grabs an interaction data object from the internal pool * - * @param touchEvent {EventData} The touch event we need to pair with an interactionData object + * @param touchEvent {object} The touch event we need to pair with an interactionData object * * @private */ diff --git a/src/loaders/loader.js b/src/loaders/loader.js index 8842e3a..07ca093 100644 --- a/src/loaders/loader.js +++ b/src/loaders/loader.js @@ -20,7 +20,7 @@ * ``` * * @class - * @extends PIXI.ResourceLoader + * @extends module:resource-loader.ResourceLoader * @memberof PIXI.loaders * @param [baseUrl=''] {string} The base url for all resources loaded by this loader. * @param [concurrency=10] {number} The number of resources to load concurrently. diff --git a/src/mesh/Mesh.js b/src/mesh/Mesh.js index f6490b4..a2f65c7 100644 --- a/src/mesh/Mesh.js +++ b/src/mesh/Mesh.js @@ -406,7 +406,6 @@ /** * When the texture is updated, this event will fire to update the scale and frame * - * @param event * @private */ Mesh.prototype._onTextureUpdate = function () diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index caf54c3..deef319 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ Extract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ Extract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ Extract.prototype.canvas = function ( target ) @@ -63,7 +63,7 @@ else { renderTexture = this.renderer.generateTexture(target); - + } } @@ -83,16 +83,16 @@ frame = tempRect; frame.width = textureBuffer.size.width; frame.height = textureBuffer.size.height; - + } - + var width = frame.width * resolution; var height = frame.height * resolution; var canvasBuffer = new core.CanvasRenderTarget(width, height); - + if(textureBuffer) { // bind the buffer @@ -100,7 +100,7 @@ // set up an array of pixels var webGLPixels = new Uint8Array(4 * width * height); - + // read pixels to the array var gl = renderer.gl; gl.readPixels(frame.x * resolution, frame.y * resolution, width, height, gl.RGBA, gl.UNSIGNED_BYTE, webGLPixels); @@ -125,10 +125,10 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ -Extract.prototype.pixels = function ( renderTexture, area ) +Extract.prototype.pixels = function ( renderTexture ) { var renderer = this.renderer; var textureBuffer; @@ -157,7 +157,7 @@ var gl = this.renderer.gl; var webGLPixels = new Uint8Array(4 * width * height); - + if(textureBuffer) { // bind the buffer diff --git a/src/extras/BitmapText.js b/src/extras/BitmapText.js index 42ae05c..041e39c 100644 --- a/src/extras/BitmapText.js +++ b/src/extras/BitmapText.js @@ -162,7 +162,7 @@ /** * The font descriptor of the BitmapText object * - * @member {Font} + * @member {string|object} * @memberof PIXI.extras.BitmapText# */ font: { diff --git a/src/extras/webgl/TilingShader.js b/src/extras/webgl/TilingShader.js index 4be2d40..19b33b6 100644 --- a/src/extras/webgl/TilingShader.js +++ b/src/extras/webgl/TilingShader.js @@ -5,7 +5,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {PIXI.Shader} The WebGL shader manager this shader works for. */ function TilingShader(gl) { diff --git a/src/filters/displacement/DisplacementFilter.js b/src/filters/displacement/DisplacementFilter.js index 079077c..aa18fda 100644 --- a/src/filters/displacement/DisplacementFilter.js +++ b/src/filters/displacement/DisplacementFilter.js @@ -9,7 +9,8 @@ * @class * @extends PIXI.Filter * @memberof PIXI.filters - * @param sprite {PIXI.Sprite} the sprite used for the displacement map. (make sure its added to the scene!) + * @param sprite {PIXI.Sprite} The sprite used for the displacement map. (make sure its added to the scene!) + * @param scale {number} The scale of the displacement */ function DisplacementFilter(sprite, scale) { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index c9e877f..fb078e8 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -358,10 +358,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 {PIXI.Point} point the point that is tested for collision - * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject the displayObject that will be hit test (recurcsivly crawls its children) - * @param {Function} func the function that will be called on each interactive object. The displayObject and hit will be passed to the function - * @param {boolean} hitTest this indicates if the objects inside should be hit test against the point + * @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 * @return {boolean} returns true if the displayObject hit the point */ InteractionManager.prototype.processInteractive = function (point, displayObject, func, hitTest, interactive) @@ -850,7 +851,7 @@ /** * Grabs an interaction data object from the internal pool * - * @param touchEvent {EventData} The touch event we need to pair with an interactionData object + * @param touchEvent {object} The touch event we need to pair with an interactionData object * * @private */ diff --git a/src/loaders/loader.js b/src/loaders/loader.js index 8842e3a..07ca093 100644 --- a/src/loaders/loader.js +++ b/src/loaders/loader.js @@ -20,7 +20,7 @@ * ``` * * @class - * @extends PIXI.ResourceLoader + * @extends module:resource-loader.ResourceLoader * @memberof PIXI.loaders * @param [baseUrl=''] {string} The base url for all resources loaded by this loader. * @param [concurrency=10] {number} The number of resources to load concurrently. diff --git a/src/mesh/Mesh.js b/src/mesh/Mesh.js index f6490b4..a2f65c7 100644 --- a/src/mesh/Mesh.js +++ b/src/mesh/Mesh.js @@ -406,7 +406,6 @@ /** * When the texture is updated, this event will fire to update the scale and frame * - * @param event * @private */ Mesh.prototype._onTextureUpdate = function () diff --git a/src/mesh/webgl/MeshShader.js b/src/mesh/webgl/MeshShader.js index 29d2862..065300c 100644 --- a/src/mesh/webgl/MeshShader.js +++ b/src/mesh/webgl/MeshShader.js @@ -4,7 +4,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {Shader} TODO: Find a good explanation for this. */ function MeshShader(gl) { diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index caf54c3..deef319 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ Extract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ Extract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ Extract.prototype.canvas = function ( target ) @@ -63,7 +63,7 @@ else { renderTexture = this.renderer.generateTexture(target); - + } } @@ -83,16 +83,16 @@ frame = tempRect; frame.width = textureBuffer.size.width; frame.height = textureBuffer.size.height; - + } - + var width = frame.width * resolution; var height = frame.height * resolution; var canvasBuffer = new core.CanvasRenderTarget(width, height); - + if(textureBuffer) { // bind the buffer @@ -100,7 +100,7 @@ // set up an array of pixels var webGLPixels = new Uint8Array(4 * width * height); - + // read pixels to the array var gl = renderer.gl; gl.readPixels(frame.x * resolution, frame.y * resolution, width, height, gl.RGBA, gl.UNSIGNED_BYTE, webGLPixels); @@ -125,10 +125,10 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ -Extract.prototype.pixels = function ( renderTexture, area ) +Extract.prototype.pixels = function ( renderTexture ) { var renderer = this.renderer; var textureBuffer; @@ -157,7 +157,7 @@ var gl = this.renderer.gl; var webGLPixels = new Uint8Array(4 * width * height); - + if(textureBuffer) { // bind the buffer diff --git a/src/extras/BitmapText.js b/src/extras/BitmapText.js index 42ae05c..041e39c 100644 --- a/src/extras/BitmapText.js +++ b/src/extras/BitmapText.js @@ -162,7 +162,7 @@ /** * The font descriptor of the BitmapText object * - * @member {Font} + * @member {string|object} * @memberof PIXI.extras.BitmapText# */ font: { diff --git a/src/extras/webgl/TilingShader.js b/src/extras/webgl/TilingShader.js index 4be2d40..19b33b6 100644 --- a/src/extras/webgl/TilingShader.js +++ b/src/extras/webgl/TilingShader.js @@ -5,7 +5,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {PIXI.Shader} The WebGL shader manager this shader works for. */ function TilingShader(gl) { diff --git a/src/filters/displacement/DisplacementFilter.js b/src/filters/displacement/DisplacementFilter.js index 079077c..aa18fda 100644 --- a/src/filters/displacement/DisplacementFilter.js +++ b/src/filters/displacement/DisplacementFilter.js @@ -9,7 +9,8 @@ * @class * @extends PIXI.Filter * @memberof PIXI.filters - * @param sprite {PIXI.Sprite} the sprite used for the displacement map. (make sure its added to the scene!) + * @param sprite {PIXI.Sprite} The sprite used for the displacement map. (make sure its added to the scene!) + * @param scale {number} The scale of the displacement */ function DisplacementFilter(sprite, scale) { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index c9e877f..fb078e8 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -358,10 +358,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 {PIXI.Point} point the point that is tested for collision - * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject the displayObject that will be hit test (recurcsivly crawls its children) - * @param {Function} func the function that will be called on each interactive object. The displayObject and hit will be passed to the function - * @param {boolean} hitTest this indicates if the objects inside should be hit test against the point + * @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 * @return {boolean} returns true if the displayObject hit the point */ InteractionManager.prototype.processInteractive = function (point, displayObject, func, hitTest, interactive) @@ -850,7 +851,7 @@ /** * Grabs an interaction data object from the internal pool * - * @param touchEvent {EventData} The touch event we need to pair with an interactionData object + * @param touchEvent {object} The touch event we need to pair with an interactionData object * * @private */ diff --git a/src/loaders/loader.js b/src/loaders/loader.js index 8842e3a..07ca093 100644 --- a/src/loaders/loader.js +++ b/src/loaders/loader.js @@ -20,7 +20,7 @@ * ``` * * @class - * @extends PIXI.ResourceLoader + * @extends module:resource-loader.ResourceLoader * @memberof PIXI.loaders * @param [baseUrl=''] {string} The base url for all resources loaded by this loader. * @param [concurrency=10] {number} The number of resources to load concurrently. diff --git a/src/mesh/Mesh.js b/src/mesh/Mesh.js index f6490b4..a2f65c7 100644 --- a/src/mesh/Mesh.js +++ b/src/mesh/Mesh.js @@ -406,7 +406,6 @@ /** * When the texture is updated, this event will fire to update the scale and frame * - * @param event * @private */ Mesh.prototype._onTextureUpdate = function () diff --git a/src/mesh/webgl/MeshShader.js b/src/mesh/webgl/MeshShader.js index 29d2862..065300c 100644 --- a/src/mesh/webgl/MeshShader.js +++ b/src/mesh/webgl/MeshShader.js @@ -4,7 +4,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {Shader} TODO: Find a good explanation for this. */ function MeshShader(gl) { diff --git a/src/particles/ParticleContainer.js b/src/particles/ParticleContainer.js index ab7752a..6dad8cb 100644 --- a/src/particles/ParticleContainer.js +++ b/src/particles/ParticleContainer.js @@ -315,7 +315,6 @@ /** * Destroys the container * - * @param [destroyChildren=false] {boolean} if set to true, all the children will have their destroy method called as well */ ParticleContainer.prototype.destroy = function () { core.Container.prototype.destroy.apply(this, arguments); diff --git a/src/accessibility/AccessibilityManager.js b/src/accessibility/AccessibilityManager.js index c066adc..d9b2ffd 100644 --- a/src/accessibility/AccessibilityManager.js +++ b/src/accessibility/AccessibilityManager.js @@ -142,7 +142,7 @@ /** * This recursive function will run throught he scene graph and add any new accessible objects to the DOM layer. - * @param element {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. + * @param displayObject {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} the DisplayObject to check. * @private */ AccessibilityManager.prototype.updateAccessibleObjects = function(displayObject) diff --git a/src/core/display/ObservablePoint.js b/src/core/display/ObservablePoint.js index dbc2edb..3af1330 100644 --- a/src/core/display/ObservablePoint.js +++ b/src/core/display/ObservablePoint.js @@ -1,10 +1,11 @@ /** - * The Point object represents a location in a two-dimensional coordinate system, where x represents - * the horizontal axis and y represents the vertical axis. + * An observable point is a point that triggers a callback when the point's position is changed. * * @class * @memberof PIXI - * @param transform {PIXI.Transform} the transform object @mat + * + * @param cb {function} The function to be called when the point changes + * @param scope {object} 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 */ @@ -71,5 +72,5 @@ this._x = x || 0; this._y = y || ( (y !== 0) ? this._x : 0 ); - this.transform._versionLocal++; + this.transform._versionLocal++; // TODO: Pretty sure this doesn't exist. }; diff --git a/src/core/display/Transform.js b/src/core/display/Transform.js index 58abcc0..5bd3e5e 100644 --- a/src/core/display/Transform.js +++ b/src/core/display/Transform.js @@ -7,8 +7,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function Transform() { diff --git a/src/core/display/TransformStatic.js b/src/core/display/TransformStatic.js index d7c632d..4b935c1 100644 --- a/src/core/display/TransformStatic.js +++ b/src/core/display/TransformStatic.js @@ -8,8 +8,6 @@ * * @class * @memberof PIXI - * @param [x=0] {number} position of the point on the x axis - * @param [y=0] {number} position of the point on the y axis */ function TransformStatic() { diff --git a/src/core/graphics/utils/bezierCurveTo.js b/src/core/graphics/utils/bezierCurveTo.js index d186d77..f1b1599 100644 --- a/src/core/graphics/utils/bezierCurveTo.js +++ b/src/core/graphics/utils/bezierCurveTo.js @@ -2,12 +2,15 @@ /** * Calculate the points for a bezier curve and then draws it. * + * @param fromX {number} Starting point x + * @param fromY {number} Starting point y * @param cpX {number} Control point x * @param cpY {number} Control point y * @param cpX2 {number} Second Control point x * @param cpY2 {number} Second Control point y * @param toX {number} Destination point x * @param toY {number} Destination point y + * @param [path=[]] {array} Path array to push points into * @return {PIXI.Graphics} */ var bezierCurveTo = function (fromX, fromY, cpX, cpY, cpX2, cpY2, toX, toY, path) diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index d4649b3..0461934 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -6,7 +6,9 @@ * * @class * @memberof PIXI - * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param gl {WebGLRenderingContext} The current WebGL drawing context + * @param shader {PIXI.Shader} The shader + * @param attribsState {object} The state for the VAO * @private */ function WebGLGraphicsData(gl, shader, attribsState) @@ -68,7 +70,7 @@ .addIndex(this.indexBuffer) .addAttribute(this.buffer, shader.attributes.aVertexPosition, gl.FLOAT, false, 4 * 6, 0) .addAttribute(this.buffer, shader.attributes.aColor, gl.FLOAT, false, 4 * 6, 2 * 4); - + } diff --git a/src/core/graphics/webgl/shaders/PrimitiveShader.js b/src/core/graphics/webgl/shaders/PrimitiveShader.js index 9a1a043..6c25bb3 100644 --- a/src/core/graphics/webgl/shaders/PrimitiveShader.js +++ b/src/core/graphics/webgl/shaders/PrimitiveShader.js @@ -6,7 +6,7 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {Shader} The webgl shader manager this shader works for. */ function PrimitiveShader(gl) { diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 3119ac9..417af4c 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -4,7 +4,7 @@ /** * @class * @memberof PIXI - * @param points {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, + * @param points_ {PIXI.Point[]|number[]|...PIXI.Point|...number} This can be an array of Points that form the polygon, * a flat array of numbers that will be interpreted as [x,y, x,y, ...], or the arguments passed can be * all the points of the polygon e.g. `new PIXI.Polygon(new PIXI.Point(), new PIXI.Point(), ...)`, or the * arguments passed can be flat x,y values e.g. `new Polygon(x,y, x,y, x,y, ...)` where `x` and `y` are diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index e3f56e4..eaca541 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -102,7 +102,11 @@ /** * Renders the object to this canvas view * - * @param object {PIXI.DisplayObject} the object to be rendered + * @param displayObject {PIXI.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 + * @param skipUpdateTransform {boolean} Whether to skip the update transform */ CanvasRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { @@ -119,7 +123,7 @@ if(renderTexture) { renderTexture = renderTexture.baseTexture || renderTexture; - + if(!renderTexture._canvasRenderTarget) { diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 6b5dc23..27ab912 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -17,7 +17,6 @@ * This method adds it to the current stack of masks. * * @param maskData {object} the maskData that will be pushed - * @param renderer {PIXI.WebGLRenderer|PIXI.CanvasRenderer} The renderer context to use. */ CanvasMaskManager.prototype.pushMask = function (maskData) { diff --git a/src/core/renderers/canvas/utils/CanvasRenderTarget.js b/src/core/renderers/canvas/utils/CanvasRenderTarget.js index a30c35b..84aae27 100644 --- a/src/core/renderers/canvas/utils/CanvasRenderTarget.js +++ b/src/core/renderers/canvas/utils/CanvasRenderTarget.js @@ -7,6 +7,7 @@ * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas + * @param [resolution=CONST.RESOLUTION] The resolution of the canvas */ function CanvasRenderTarget(width, height, resolution) { diff --git a/src/core/renderers/webgl/TextureManager.js b/src/core/renderers/webgl/TextureManager.js index 50bcc6b..e2b8f6f 100644 --- a/src/core/renderers/webgl/TextureManager.js +++ b/src/core/renderers/webgl/TextureManager.js @@ -139,6 +139,7 @@ * Deletes the texture from WebGL * * @param texture {PIXI.BaseTexture|PIXI.Texture} the texture to destroy + * @param [_skipRemove=false] {boolean} Whether to skip removing the texture from the TextureManager. */ TextureManager.prototype.destroyTexture = function(texture, _skipRemove) { diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 86fc3aa..95f0ef1 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -84,7 +84,7 @@ /** * Manages the stencil buffer. * - * @member {PIXI.StencilManager} + * @member {StencilManager} */ this.stencilManager = new StencilManager(this); @@ -111,13 +111,13 @@ */ // initialize the context so it is ready for the managers. this.gl = options.context || createContext(this.view, this._contextOptions); - + this.CONTEXT_UID = CONTEXT_UID++; /** * The currently active ObjectRenderer. * - * @member {PIXI.WebGLState} + * @member {WebGLState} */ this.state = new WebGLState(this.gl); @@ -155,7 +155,7 @@ this.setBlendMode(0); - + } // constructor @@ -181,7 +181,7 @@ this.rootRenderTarget = new RenderTarget(gl, this.width, this.height, null, this.resolution, true); this.rootRenderTarget.clearColor = this._backgroundColorRgba; - + this.bindRenderTarget(this.rootRenderTarget); @@ -194,8 +194,8 @@ /** * Renders the object to its webGL view * - * @param object {PIXI.DisplayObject} the object to be rendered - * @param renderTexture {PIXI.renderTexture} + * @param displayObject {PIXI.DisplayObject} the object to be rendered + * @param renderTexture {PIXI.RenderTexture} * @param clear {Boolean} * @param transform {PIXI.Transform} * @param skipUpdateTransform {Boolean} @@ -203,7 +203,7 @@ WebGLRenderer.prototype.render = function (displayObject, renderTexture, clear, transform, skipUpdateTransform) { - + // can be handy to know! this.renderingToScreen = !renderTexture; @@ -239,7 +239,7 @@ renderTarget.clear(); } - + displayObject.renderWebGL(this); @@ -449,7 +449,7 @@ { // this will also bind the texture.. this.textureManager.updateTexture(texture); - + } else { diff --git a/src/core/renderers/webgl/filters/Filter.js b/src/core/renderers/webgl/filters/Filter.js index 16b2cec..b64ace7 100644 --- a/src/core/renderers/webgl/filters/Filter.js +++ b/src/core/renderers/webgl/filters/Filter.js @@ -7,10 +7,9 @@ * @class * @memberof PIXI * @extends PIXI.Shader - * @param shaderManager {PIXI.ShaderManager} The webgl shader manager this shader works for. * @param [vertexSrc] {string} The source of the vertex shader. * @param [fragmentSrc] {string} The source of the fragment shader. - * @param [customUniforms] {object} Custom uniforms to use to augment the built-in ones. + * @param [uniforms] {object} Custom uniforms to use to augment the built-in ones. * @param [fragmentSrc] {string} The source of the fragment shader. */ function Filter(vertexSrc, fragmentSrc, uniforms) diff --git a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js index 6666aa1..cd1edfc 100644 --- a/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/spriteMask/SpriteMaskFilter.js @@ -21,7 +21,7 @@ ); sprite.renderable = false; - + this.maskSprite = sprite; this.maskMatrix = maskMatrix; } @@ -33,14 +33,14 @@ /** * Applies the filter * - * @param renderer {PIXI.WebGLRenderer} The renderer to retrieve the filter from + * @param filterManager {PIXI.FilterManager} The renderer to retrieve the filter from * @param input {PIXI.RenderTarget} * @param output {PIXI.RenderTarget} */ SpriteMaskFilter.prototype.apply = function (filterManager, input, output) { var maskSprite = this.maskSprite; - + this.uniforms.mask = maskSprite._texture; this.uniforms.otherMatrix = filterManager.calculateSpriteMatrix(this.maskMatrix, maskSprite ); this.uniforms.alpha = maskSprite.worldAlpha; diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index 0112a9d..5c9eca9 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -3,7 +3,7 @@ /** * @class * @memberof PIXI - * @extends PIXI.WebGlManager + * @extends PIXI.WebGLManager * @param renderer {PIXI.WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index d586cdc..660cb52 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 graphics {PIXI.Graphics} - * @param webGLData {any[]} + * @param target {PIXI.Graphics} + * @param maskData {any[]} */ MaskManager.prototype.pushMask = function (target, maskData) { @@ -127,7 +127,6 @@ /** * Applies the Mask and adds it to the current filter stack. * - * @param target {PIXI.RenderTarget} * @param maskData {any[]} */ MaskManager.prototype.pushStencilMask = function (maskData) @@ -139,8 +138,6 @@ /** * Removes the last filter from the filter stack and doesn't return it. * - * @param target {PIXI.RenderTarget} - * @param maskData {any[]} */ MaskManager.prototype.popStencilMask = function () { diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index 815cbc8..cf3f068 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 {PIXI.StencilMaskStack} The mask stack + * @param stencilMaskStack {array} The mask stack */ StencilMaskManager.prototype.setMaskStack = function ( stencilMaskStack ) { @@ -40,7 +40,6 @@ * Applies the Mask and adds it to the current filter stack. @alvin * * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.pushStencil = function (graphics) { @@ -72,8 +71,6 @@ /** * TODO @alvin - * @param graphics {PIXI.Graphics} - * @param webGLData {any[]} */ StencilMaskManager.prototype.popStencil = function () { diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 10e8f4b..e6cdd4e 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -7,6 +7,7 @@ * @class * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. + * @param state {object} TODO: Description */ function Quad(gl, state) { @@ -88,8 +89,8 @@ /** * Maps two Rectangle to the quad - * @param rect {PIXI.Rectangle} the first rectangle - * @param rect2 {PIXI.Rectangle} the second rectangle + * @param targetTextureFrame {PIXI.Rectangle} the first rectangle + * @param destinationFrame {PIXI.Rectangle} the second rectangle */ Quad.prototype.map = function(targetTextureFrame, destinationFrame) { diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index 77b46b2..378b08f 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -33,7 +33,7 @@ /** * A frame buffer * - * @member {WebGLFrameBuffer} + * @member {glCore.GLFramebuffer} */ this.frameBuffer = null; @@ -89,7 +89,7 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.defaultFrame = new PIXI.Rectangle(); this.destinationFrame = null; @@ -98,14 +98,14 @@ /** * The stencil buffer stores masking data for the render target * - * @member {WebGLRenderBuffer} + * @member {glCore.GLBuffer} */ this.stencilBuffer = null; /** * The data structure for the stencil masks * - * @member {PIXI.StencilMaskStack} + * @member {array} */ this.stencilMaskStack = []; @@ -180,7 +180,7 @@ /** * Clears the filter texture. * - * @param [bind=false] {boolean} Should we bind our framebuffer before clearing? + * @param [clearColor=this.clearColor] {array} Array of [r,g,b,a] to clear the framebuffer */ RenderTarget.prototype.clear = function(clearColor) { diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 43d2d61..2d7a9d7 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -22,7 +22,7 @@ function Sprite(texture) { Container.call(this); - + /** * The anchor sets the origin point of the texture. * The default is 0,0 this means the texture's origin is the top left @@ -448,8 +448,6 @@ * * @static * @param frameId {string} The frame Id of the texture in the cache - * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter - * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the frameId */ Sprite.fromFrame = function (frameId) @@ -470,6 +468,8 @@ * * @static * @param imageId {string} The image url of the texture + * @param [crossorigin=(auto)] {boolean} if you want to specify the cross-origin parameter + * @param [scaleMode=PIXI.SCALE_MODES.DEFAULT] {number} if you want to specify the scale mode, see {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Sprite} A new Sprite using a texture from the texture cache matching the image id */ Sprite.fromImage = function (imageId, crossorigin, scaleMode) diff --git a/src/core/sprites/canvas/CanvasTinter.js b/src/core/sprites/canvas/CanvasTinter.js index 009567d..9642499 100644 --- a/src/core/sprites/canvas/CanvasTinter.js +++ b/src/core/sprites/canvas/CanvasTinter.js @@ -206,21 +206,21 @@ /** * Number of steps which will be used as a cap when rounding colors. * - * @member + * @member CanvasTinter */ CanvasTinter.cacheStepsPerColorChannel = 8; /** * Tint cache boolean flag. * - * @member + * @member CanvasTinter */ CanvasTinter.convertTintToImage = false; /** * Whether or not the Canvas BlendModes are supported, consequently the ability to tint using the multiply method. * - * @member + * @member CanvasTinter */ CanvasTinter.canUseMultiply = canUseNewCanvasBlendModes(); diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index 9da302e..b21a5a0 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -96,7 +96,6 @@ * Sets up the renderer context and necessary buffers. * * @private - * @param gl {WebGLRenderingContext} the current WebGL drawing context */ SpriteRenderer.prototype.onContextChange = function () { @@ -104,12 +103,12 @@ this.MAX_TEXTURES = Math.min(gl.getParameter(gl.MAX_TEXTURE_IMAGE_UNITS), CONST.SPRITE_MAX_TEXTURES); - + this.shader = generateMultiTextureShader(gl, this.MAX_TEXTURES); // create a couple of buffers this.indexBuffer = glCore.GLBuffer.createIndexBuffer(gl, this.indices, gl.STATIC_DRAW); - + for (var i = 0; i < this.vaoMax; i++) { this.vertexBuffers[i] = glCore.GLBuffer.createVertexBuffer(gl, null, gl.STREAM_DRAW); @@ -121,7 +120,7 @@ .addAttribute(this.vertexBuffers[i], this.shader.attributes.aColor, gl.UNSIGNED_BYTE, true, this.vertByteSize, 3 * 4) .addAttribute(this.vertexBuffers[i], this.shader.attributes.aTextureId, gl.FLOAT, false, this.vertByteSize, 4 * 4); } - + this.vao = this.vaos[0]; this.currentBlendMode = 99999; }; @@ -285,7 +284,7 @@ this.vertexBuffers[this.vertexCount].upload(buffer.vertices, 0); this.vao = this.vaos[this.vertexCount].bind(); - + /// render the groups.. for (i = 0; i < groupCount; i++) { diff --git a/src/core/text/Text.js b/src/core/text/Text.js index a726742..ebcfba8 100644 --- a/src/core/text/Text.js +++ b/src/core/text/Text.js @@ -19,6 +19,7 @@ * @memberof PIXI * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters + * @param resolution {number} The resolution of the canvas * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font * @param [style.fill='black'] {String|Number} A canvas fillstyle that will be used on the text e.g 'red', '#00FF00' * @param [style.align='left'] {string} Alignment for multiline text ('left', 'center' or 'right'), does not affect single line text @@ -229,7 +230,7 @@ text = text || ' '; text = text.toString(); - + if (this._text === text) { return; diff --git a/src/core/textures/BaseRenderTexture.js b/src/core/textures/BaseRenderTexture.js index 2928363..10e339a 100644 --- a/src/core/textures/BaseRenderTexture.js +++ b/src/core/textures/BaseRenderTexture.js @@ -34,7 +34,7 @@ * * var baseRenderTexture = new PIXI.BaserenderTexture(100, 100); * var renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * + * * renderer.render(doc, renderTexture); // Renders to center of RenderTexture * ``` * @@ -88,7 +88,6 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? */ BaseRenderTexture.prototype.resize = function (width, height) { @@ -120,7 +119,6 @@ /** * Destroys this texture * - * @param destroyBase {boolean} Whether to destroy the base texture as well */ BaseRenderTexture.prototype.destroy = function () { diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index c894448..1cb9813 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -9,7 +9,7 @@ * * @class * @memberof PIXI - * @param source {Image|Canvas} 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 */ @@ -18,7 +18,7 @@ EventEmitter.call(this); this.uid = utils.uid(); - + this.touched = 0; /** @@ -97,7 +97,7 @@ * * TODO: Make this a setter that calls loadSource(); * - * @member {Image|Canvas} + * @member {Image|HTMLCanvasElement} * @readonly */ this.source = null; // set in loadSource, if at all @@ -153,7 +153,7 @@ this._glTextures = []; this._enabled = 0; this._id = 0; - + // if no source passed don't try to load if (source) { @@ -220,7 +220,7 @@ * } * * @protected - * @param source {Image|Canvas} the source object of the texture. + * @param source {Image|HTMLCanvasElement} the source object of the texture. */ BaseTexture.prototype.loadSource = function (source) { @@ -399,7 +399,7 @@ // new Image() breaks tex loading in some versions of Chrome. // See https://code.google.com/p/chromium/issues/detail?id=238071 var image = new Image();//document.createElement('img'); - + if (crossorigin === undefined && imageUrl.indexOf('data:') !== 0) { @@ -424,7 +424,7 @@ * Helper function that creates a base texture from the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return PIXI.BaseTexture */ diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 0e0fcf1..b03446f 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -38,6 +38,7 @@ * @extends PIXI.Texture * @memberof PIXI * @param baseRenderTexture {PIXI.BaseRenderTexture} The renderer used for this RenderTexture + * @param [frame] {PIXI.Rectangle} The rectangle frame of the texture to show */ function RenderTexture(baseRenderTexture, frame) { @@ -87,7 +88,7 @@ * * @param width {number} The width to resize to. * @param height {number} The height to resize to. - * @param updateBase {boolean} Should the baseTexture.width and height values be resized as well? + * @param doNotResizeBaseTexture {boolean} Should the baseTexture.width and height values be resized as well? */ RenderTexture.prototype.resize = function (width, height, doNotResizeBaseTexture) { diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index bc89a4f..daab921 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -309,7 +309,7 @@ /** * Updates the internal WebGL UV cache. * - * @private + * @protected */ Texture.prototype._updateUvs = function () { @@ -368,7 +368,7 @@ * Helper function that creates a new Texture based on the given canvas element. * * @static - * @param canvas {Canvas} The canvas element source of the texture + * @param canvas {HTMLCanvasElement} The canvas element source of the texture * @param scaleMode {number} See {@link PIXI.SCALE_MODES} for possible values * @return {PIXI.Texture} */ diff --git a/src/core/ticker/Ticker.js b/src/core/ticker/Ticker.js index 970c82e..762caf6 100644 --- a/src/core/ticker/Ticker.js +++ b/src/core/ticker/Ticker.js @@ -141,7 +141,6 @@ * {@link PIXI.ticker.Ticker#speed}, which is specific * to scaling {@link PIXI.ticker.Ticker#deltaTime}. * - * @member * @memberof PIXI.ticker.Ticker# * @readonly */ @@ -160,7 +159,6 @@ * When setting this property it is clamped to a value between * `0` and `PIXI.TARGET_FPMS * 1000`. * - * @member * @memberof PIXI.ticker.Ticker# * @default 10 */ diff --git a/src/core/utils/determineCrossOrigin.js b/src/core/utils/determineCrossOrigin.js index e80c9bd..0761753 100644 --- a/src/core/utils/determineCrossOrigin.js +++ b/src/core/utils/determineCrossOrigin.js @@ -8,7 +8,7 @@ * Nipped from the resource loader! * @private * @param url {string} The url to test. - * @param [location=window.location] {object} The location object to test against. + * @param loc [location=window.location] {object} The location object to test against. * @return {string} The crossOrigin value to use (or empty string for none). */ var determineCrossOrigin = function (url, loc) { @@ -40,4 +40,4 @@ return ''; }; -module.exports = determineCrossOrigin; \ No newline at end of file +module.exports = determineCrossOrigin; diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 77fe44b..f68740c 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -59,7 +59,7 @@ /** * Mixes in the properties of the pluginTarget into another object * - * @param object {object} The obj to mix into + * @param obj {object} The obj to mix into */ mixin: function mixin(obj) { diff --git a/src/extract/canvas/CanvasExtract.js b/src/extract/canvas/CanvasExtract.js index 8c901c8..74595ff 100644 --- a/src/extract/canvas/CanvasExtract.js +++ b/src/extract/canvas/CanvasExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ WebGLExtract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ WebGLExtract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ WebGLExtract.prototype.canvas = function ( target ) @@ -61,7 +61,7 @@ } else { - renderTexture = this.renderer.generateTexture(target); + renderTexture = this.renderer.generateTexture(target); } } @@ -84,7 +84,7 @@ var width = frame.width * resolution; var height = frame.height * resolution; - var canvasBuffer = new core.CanvasRenderTarget(width, height); + var canvasBuffer = new core.CanvasRenderTarget(width, height); var canvasData = context.getImageData(frame.x * resolution, frame.y * resolution, width, height); canvasBuffer.context.putImageData(canvasData, 0, 0); @@ -95,7 +95,7 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ WebGLExtract.prototype.pixels = function ( renderTexture ) diff --git a/src/extract/webgl/WebGLExtract.js b/src/extract/webgl/WebGLExtract.js index caf54c3..deef319 100644 --- a/src/extract/webgl/WebGLExtract.js +++ b/src/extract/webgl/WebGLExtract.js @@ -21,7 +21,7 @@ * Will return a HTML Image of the target * * @return {Image} - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer */ Extract.prototype.image = function ( target ) { @@ -32,7 +32,7 @@ /** * Will return a a base64 encoded string of this target. It works by calling WebGLExtract.getCanvas and then running toDataURL on that. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {string} A base64 encoded string of the texture. */ Extract.prototype.base64 = function ( target ) @@ -42,7 +42,7 @@ /** * Creates a Canvas element, renders this target to it and then returns it. - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {HTMLCanvasElement} A Canvas element with the texture rendered on. */ Extract.prototype.canvas = function ( target ) @@ -63,7 +63,7 @@ else { renderTexture = this.renderer.generateTexture(target); - + } } @@ -83,16 +83,16 @@ frame = tempRect; frame.width = textureBuffer.size.width; frame.height = textureBuffer.size.height; - + } - + var width = frame.width * resolution; var height = frame.height * resolution; var canvasBuffer = new core.CanvasRenderTarget(width, height); - + if(textureBuffer) { // bind the buffer @@ -100,7 +100,7 @@ // set up an array of pixels var webGLPixels = new Uint8Array(4 * width * height); - + // read pixels to the array var gl = renderer.gl; gl.readPixels(frame.x * resolution, frame.y * resolution, width, height, gl.RGBA, gl.UNSIGNED_BYTE, webGLPixels); @@ -125,10 +125,10 @@ /** * Will return a one-dimensional array containing the pixel data of the entire texture in RGBA order, with integer values between 0 and 255 (included). - * @param target {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer + * @param renderTexture {PIXI.DisplayObject|PIXI.RenderTexture} A displayObject or renderTexture to convert. If left empty will use use the main renderer * @return {Uint8ClampedArray} */ -Extract.prototype.pixels = function ( renderTexture, area ) +Extract.prototype.pixels = function ( renderTexture ) { var renderer = this.renderer; var textureBuffer; @@ -157,7 +157,7 @@ var gl = this.renderer.gl; var webGLPixels = new Uint8Array(4 * width * height); - + if(textureBuffer) { // bind the buffer diff --git a/src/extras/BitmapText.js b/src/extras/BitmapText.js index 42ae05c..041e39c 100644 --- a/src/extras/BitmapText.js +++ b/src/extras/BitmapText.js @@ -162,7 +162,7 @@ /** * The font descriptor of the BitmapText object * - * @member {Font} + * @member {string|object} * @memberof PIXI.extras.BitmapText# */ font: { diff --git a/src/extras/webgl/TilingShader.js b/src/extras/webgl/TilingShader.js index 4be2d40..19b33b6 100644 --- a/src/extras/webgl/TilingShader.js +++ b/src/extras/webgl/TilingShader.js @@ -5,7 +5,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {PIXI.Shader} The WebGL shader manager this shader works for. */ function TilingShader(gl) { diff --git a/src/filters/displacement/DisplacementFilter.js b/src/filters/displacement/DisplacementFilter.js index 079077c..aa18fda 100644 --- a/src/filters/displacement/DisplacementFilter.js +++ b/src/filters/displacement/DisplacementFilter.js @@ -9,7 +9,8 @@ * @class * @extends PIXI.Filter * @memberof PIXI.filters - * @param sprite {PIXI.Sprite} the sprite used for the displacement map. (make sure its added to the scene!) + * @param sprite {PIXI.Sprite} The sprite used for the displacement map. (make sure its added to the scene!) + * @param scale {number} The scale of the displacement */ function DisplacementFilter(sprite, scale) { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index c9e877f..fb078e8 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -358,10 +358,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 {PIXI.Point} point the point that is tested for collision - * @param {PIXI.Container|PIXI.Sprite|PIXI.extras.TilingSprite} displayObject the displayObject that will be hit test (recurcsivly crawls its children) - * @param {Function} func the function that will be called on each interactive object. The displayObject and hit will be passed to the function - * @param {boolean} hitTest this indicates if the objects inside should be hit test against the point + * @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 * @return {boolean} returns true if the displayObject hit the point */ InteractionManager.prototype.processInteractive = function (point, displayObject, func, hitTest, interactive) @@ -850,7 +851,7 @@ /** * Grabs an interaction data object from the internal pool * - * @param touchEvent {EventData} The touch event we need to pair with an interactionData object + * @param touchEvent {object} The touch event we need to pair with an interactionData object * * @private */ diff --git a/src/loaders/loader.js b/src/loaders/loader.js index 8842e3a..07ca093 100644 --- a/src/loaders/loader.js +++ b/src/loaders/loader.js @@ -20,7 +20,7 @@ * ``` * * @class - * @extends PIXI.ResourceLoader + * @extends module:resource-loader.ResourceLoader * @memberof PIXI.loaders * @param [baseUrl=''] {string} The base url for all resources loaded by this loader. * @param [concurrency=10] {number} The number of resources to load concurrently. diff --git a/src/mesh/Mesh.js b/src/mesh/Mesh.js index f6490b4..a2f65c7 100644 --- a/src/mesh/Mesh.js +++ b/src/mesh/Mesh.js @@ -406,7 +406,6 @@ /** * When the texture is updated, this event will fire to update the scale and frame * - * @param event * @private */ Mesh.prototype._onTextureUpdate = function () diff --git a/src/mesh/webgl/MeshShader.js b/src/mesh/webgl/MeshShader.js index 29d2862..065300c 100644 --- a/src/mesh/webgl/MeshShader.js +++ b/src/mesh/webgl/MeshShader.js @@ -4,7 +4,7 @@ * @class * @extends PIXI.Shader * @memberof PIXI.mesh - * @param shaderManager {PIXI.ShaderManager} The WebGL shader manager this shader works for. + * @param gl {Shader} TODO: Find a good explanation for this. */ function MeshShader(gl) { diff --git a/src/particles/ParticleContainer.js b/src/particles/ParticleContainer.js index ab7752a..6dad8cb 100644 --- a/src/particles/ParticleContainer.js +++ b/src/particles/ParticleContainer.js @@ -315,7 +315,6 @@ /** * Destroys the container * - * @param [destroyChildren=false] {boolean} if set to true, all the children will have their destroy method called as well */ ParticleContainer.prototype.destroy = function () { core.Container.prototype.destroy.apply(this, arguments); diff --git a/src/particles/webgl/ParticleShader.js b/src/particles/webgl/ParticleShader.js index 950e612..59814ca 100644 --- a/src/particles/webgl/ParticleShader.js +++ b/src/particles/webgl/ParticleShader.js @@ -2,9 +2,9 @@ /** * @class - * @extends PIXI.TextureShader + * @extends PIXI.Shader * @memberof PIXI - * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. + * @param gl {PIXI.Shader} The webgl shader manager this shader works for. */ function ParticleShader(gl) {