diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/filters/twist/TwistFilter.js b/src/filters/twist/TwistFilter.js index 4aed6b2..766a633 100644 --- a/src/filters/twist/TwistFilter.js +++ b/src/filters/twist/TwistFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TwistFilter() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/filters/twist/TwistFilter.js b/src/filters/twist/TwistFilter.js index 4aed6b2..766a633 100644 --- a/src/filters/twist/TwistFilter.js +++ b/src/filters/twist/TwistFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TwistFilter() { diff --git a/src/interaction/InteractionData.js b/src/interaction/InteractionData.js index 07bae0f..e40be15 100644 --- a/src/interaction/InteractionData.js +++ b/src/interaction/InteractionData.js @@ -4,7 +4,7 @@ * Holds all information related to an Interaction event * * @class - * @namespace PIXI + * @memberof PIXI.interaction */ function InteractionData() { diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/filters/twist/TwistFilter.js b/src/filters/twist/TwistFilter.js index 4aed6b2..766a633 100644 --- a/src/filters/twist/TwistFilter.js +++ b/src/filters/twist/TwistFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TwistFilter() { diff --git a/src/interaction/InteractionData.js b/src/interaction/InteractionData.js index 07bae0f..e40be15 100644 --- a/src/interaction/InteractionData.js +++ b/src/interaction/InteractionData.js @@ -4,7 +4,7 @@ * Holds all information related to an Interaction event * * @class - * @namespace PIXI + * @memberof PIXI.interaction */ function InteractionData() { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index 94c52e0..0680bf9 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -12,7 +12,7 @@ * This manager also supports multitouch. * * @class - * @namespace PIXI + * @memberof PIXI.interaction * @param renderer {CanvasRenderer|WebGLRenderer} A reference to the current renderer */ function InteractionManager( renderer ) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/filters/twist/TwistFilter.js b/src/filters/twist/TwistFilter.js index 4aed6b2..766a633 100644 --- a/src/filters/twist/TwistFilter.js +++ b/src/filters/twist/TwistFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TwistFilter() { diff --git a/src/interaction/InteractionData.js b/src/interaction/InteractionData.js index 07bae0f..e40be15 100644 --- a/src/interaction/InteractionData.js +++ b/src/interaction/InteractionData.js @@ -4,7 +4,7 @@ * Holds all information related to an Interaction event * * @class - * @namespace PIXI + * @memberof PIXI.interaction */ function InteractionData() { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index 94c52e0..0680bf9 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -12,7 +12,7 @@ * This manager also supports multitouch. * * @class - * @namespace PIXI + * @memberof PIXI.interaction * @param renderer {CanvasRenderer|WebGLRenderer} A reference to the current renderer */ function InteractionManager( renderer ) diff --git a/src/interaction/index.js b/src/interaction/index.js index b2b446f..e83df25 100644 --- a/src/interaction/index.js +++ b/src/interaction/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.interaction */ module.exports = { InteractionData: require('./InteractionData'), diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/filters/twist/TwistFilter.js b/src/filters/twist/TwistFilter.js index 4aed6b2..766a633 100644 --- a/src/filters/twist/TwistFilter.js +++ b/src/filters/twist/TwistFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TwistFilter() { diff --git a/src/interaction/InteractionData.js b/src/interaction/InteractionData.js index 07bae0f..e40be15 100644 --- a/src/interaction/InteractionData.js +++ b/src/interaction/InteractionData.js @@ -4,7 +4,7 @@ * Holds all information related to an Interaction event * * @class - * @namespace PIXI + * @memberof PIXI.interaction */ function InteractionData() { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index 94c52e0..0680bf9 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -12,7 +12,7 @@ * This manager also supports multitouch. * * @class - * @namespace PIXI + * @memberof PIXI.interaction * @param renderer {CanvasRenderer|WebGLRenderer} A reference to the current renderer */ function InteractionManager( renderer ) diff --git a/src/interaction/index.js b/src/interaction/index.js index b2b446f..e83df25 100644 --- a/src/interaction/index.js +++ b/src/interaction/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.interaction */ module.exports = { InteractionData: require('./InteractionData'), diff --git a/src/loaders/index.js b/src/loaders/index.js index 7781074..cac93fd 100644 --- a/src/loaders/index.js +++ b/src/loaders/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.loaders */ module.exports = { // Loader: require('resource-loader'), diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/filters/twist/TwistFilter.js b/src/filters/twist/TwistFilter.js index 4aed6b2..766a633 100644 --- a/src/filters/twist/TwistFilter.js +++ b/src/filters/twist/TwistFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TwistFilter() { diff --git a/src/interaction/InteractionData.js b/src/interaction/InteractionData.js index 07bae0f..e40be15 100644 --- a/src/interaction/InteractionData.js +++ b/src/interaction/InteractionData.js @@ -4,7 +4,7 @@ * Holds all information related to an Interaction event * * @class - * @namespace PIXI + * @memberof PIXI.interaction */ function InteractionData() { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index 94c52e0..0680bf9 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -12,7 +12,7 @@ * This manager also supports multitouch. * * @class - * @namespace PIXI + * @memberof PIXI.interaction * @param renderer {CanvasRenderer|WebGLRenderer} A reference to the current renderer */ function InteractionManager( renderer ) diff --git a/src/interaction/index.js b/src/interaction/index.js index b2b446f..e83df25 100644 --- a/src/interaction/index.js +++ b/src/interaction/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.interaction */ module.exports = { InteractionData: require('./InteractionData'), diff --git a/src/loaders/index.js b/src/loaders/index.js index 7781074..cac93fd 100644 --- a/src/loaders/index.js +++ b/src/loaders/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.loaders */ module.exports = { // Loader: require('resource-loader'), diff --git a/src/spine/Spine.js b/src/spine/Spine.js index 9595333..6636d33 100644 --- a/src/spine/Spine.js +++ b/src/spine/Spine.js @@ -12,7 +12,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.spine * @param spineData {object} The spine data loaded from a spine atlas. */ function Spine(spineData) diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/filters/twist/TwistFilter.js b/src/filters/twist/TwistFilter.js index 4aed6b2..766a633 100644 --- a/src/filters/twist/TwistFilter.js +++ b/src/filters/twist/TwistFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TwistFilter() { diff --git a/src/interaction/InteractionData.js b/src/interaction/InteractionData.js index 07bae0f..e40be15 100644 --- a/src/interaction/InteractionData.js +++ b/src/interaction/InteractionData.js @@ -4,7 +4,7 @@ * Holds all information related to an Interaction event * * @class - * @namespace PIXI + * @memberof PIXI.interaction */ function InteractionData() { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index 94c52e0..0680bf9 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -12,7 +12,7 @@ * This manager also supports multitouch. * * @class - * @namespace PIXI + * @memberof PIXI.interaction * @param renderer {CanvasRenderer|WebGLRenderer} A reference to the current renderer */ function InteractionManager( renderer ) diff --git a/src/interaction/index.js b/src/interaction/index.js index b2b446f..e83df25 100644 --- a/src/interaction/index.js +++ b/src/interaction/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.interaction */ module.exports = { InteractionData: require('./InteractionData'), diff --git a/src/loaders/index.js b/src/loaders/index.js index 7781074..cac93fd 100644 --- a/src/loaders/index.js +++ b/src/loaders/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.loaders */ module.exports = { // Loader: require('resource-loader'), diff --git a/src/spine/Spine.js b/src/spine/Spine.js index 9595333..6636d33 100644 --- a/src/spine/Spine.js +++ b/src/spine/Spine.js @@ -12,7 +12,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.spine * @param spineData {object} The spine data loaded from a spine atlas. */ function Spine(spineData) diff --git a/src/spine/index.js b/src/spine/index.js index 401c473..838d6aa 100644 --- a/src/spine/index.js +++ b/src/spine/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.spine */ module.exports = { Spine: require('./Spine'), diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/filters/twist/TwistFilter.js b/src/filters/twist/TwistFilter.js index 4aed6b2..766a633 100644 --- a/src/filters/twist/TwistFilter.js +++ b/src/filters/twist/TwistFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TwistFilter() { diff --git a/src/interaction/InteractionData.js b/src/interaction/InteractionData.js index 07bae0f..e40be15 100644 --- a/src/interaction/InteractionData.js +++ b/src/interaction/InteractionData.js @@ -4,7 +4,7 @@ * Holds all information related to an Interaction event * * @class - * @namespace PIXI + * @memberof PIXI.interaction */ function InteractionData() { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index 94c52e0..0680bf9 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -12,7 +12,7 @@ * This manager also supports multitouch. * * @class - * @namespace PIXI + * @memberof PIXI.interaction * @param renderer {CanvasRenderer|WebGLRenderer} A reference to the current renderer */ function InteractionManager( renderer ) diff --git a/src/interaction/index.js b/src/interaction/index.js index b2b446f..e83df25 100644 --- a/src/interaction/index.js +++ b/src/interaction/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.interaction */ module.exports = { InteractionData: require('./InteractionData'), diff --git a/src/loaders/index.js b/src/loaders/index.js index 7781074..cac93fd 100644 --- a/src/loaders/index.js +++ b/src/loaders/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.loaders */ module.exports = { // Loader: require('resource-loader'), diff --git a/src/spine/Spine.js b/src/spine/Spine.js index 9595333..6636d33 100644 --- a/src/spine/Spine.js +++ b/src/spine/Spine.js @@ -12,7 +12,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.spine * @param spineData {object} The spine data loaded from a spine atlas. */ function Spine(spineData) diff --git a/src/spine/index.js b/src/spine/index.js index 401c473..838d6aa 100644 --- a/src/spine/index.js +++ b/src/spine/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.spine */ module.exports = { Spine: require('./Spine'), diff --git a/src/text/BitmapText.js b/src/text/BitmapText.js index bd5e1eb..9ccba8b 100644 --- a/src/text/BitmapText.js +++ b/src/text/BitmapText.js @@ -9,7 +9,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.text * @param text {string} The copy that you would like the text to display * @param style {object} The style parameters * @param style.font {string|object} The font descriptor for the object, can be passed as a string of form diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/filters/twist/TwistFilter.js b/src/filters/twist/TwistFilter.js index 4aed6b2..766a633 100644 --- a/src/filters/twist/TwistFilter.js +++ b/src/filters/twist/TwistFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TwistFilter() { diff --git a/src/interaction/InteractionData.js b/src/interaction/InteractionData.js index 07bae0f..e40be15 100644 --- a/src/interaction/InteractionData.js +++ b/src/interaction/InteractionData.js @@ -4,7 +4,7 @@ * Holds all information related to an Interaction event * * @class - * @namespace PIXI + * @memberof PIXI.interaction */ function InteractionData() { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index 94c52e0..0680bf9 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -12,7 +12,7 @@ * This manager also supports multitouch. * * @class - * @namespace PIXI + * @memberof PIXI.interaction * @param renderer {CanvasRenderer|WebGLRenderer} A reference to the current renderer */ function InteractionManager( renderer ) diff --git a/src/interaction/index.js b/src/interaction/index.js index b2b446f..e83df25 100644 --- a/src/interaction/index.js +++ b/src/interaction/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.interaction */ module.exports = { InteractionData: require('./InteractionData'), diff --git a/src/loaders/index.js b/src/loaders/index.js index 7781074..cac93fd 100644 --- a/src/loaders/index.js +++ b/src/loaders/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.loaders */ module.exports = { // Loader: require('resource-loader'), diff --git a/src/spine/Spine.js b/src/spine/Spine.js index 9595333..6636d33 100644 --- a/src/spine/Spine.js +++ b/src/spine/Spine.js @@ -12,7 +12,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.spine * @param spineData {object} The spine data loaded from a spine atlas. */ function Spine(spineData) diff --git a/src/spine/index.js b/src/spine/index.js index 401c473..838d6aa 100644 --- a/src/spine/index.js +++ b/src/spine/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.spine */ module.exports = { Spine: require('./Spine'), diff --git a/src/text/BitmapText.js b/src/text/BitmapText.js index bd5e1eb..9ccba8b 100644 --- a/src/text/BitmapText.js +++ b/src/text/BitmapText.js @@ -9,7 +9,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.text * @param text {string} The copy that you would like the text to display * @param style {object} The style parameters * @param style.font {string|object} The font descriptor for the object, can be passed as a string of form diff --git a/src/text/Text.js b/src/text/Text.js index 08a8c04..08d9c7f 100644 --- a/src/text/Text.js +++ b/src/text/Text.js @@ -6,7 +6,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.text * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font diff --git a/src/core/const.js b/src/core/const.js index 8f98ee0..614ba0b 100644 --- a/src/core/const.js +++ b/src/core/const.js @@ -1,7 +1,7 @@ /** * Constant values used in pixi * - * @namespace PIXI + * @memberof PIXI */ module.exports = { /** diff --git a/src/core/display/Container.js b/src/core/display/Container.js index ef16ae1..0c2fe16 100644 --- a/src/core/display/Container.js +++ b/src/core/display/Container.js @@ -9,7 +9,7 @@ * * @class * @extends DisplayObject - * @namespace PIXI + * @memberof PIXI */ function Container() { diff --git a/src/core/display/DisplayObject.js b/src/core/display/DisplayObject.js index 9b45b73..d4dcb35 100644 --- a/src/core/display/DisplayObject.js +++ b/src/core/display/DisplayObject.js @@ -8,7 +8,7 @@ * This is an abstract class and should not be used on its own rather it should be extended. * * @class - * @namespace PIXI + * @memberof PIXI */ function DisplayObject() { diff --git a/src/core/graphics/Graphics.js b/src/core/graphics/Graphics.js index bb1c13e..86cdf2f 100644 --- a/src/core/graphics/Graphics.js +++ b/src/core/graphics/Graphics.js @@ -13,7 +13,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI */ function Graphics() { diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index 809d8c3..e92eaef 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -2,7 +2,7 @@ * A GraphicsData object. * * @class - * @namespace PIXI + * @memberof PIXI * @param lineWidth {number} the width of the line to draw * @param lineColor {number} the color of the line to draw * @param lineAlpha {number} the alpha of the line to draw diff --git a/src/core/graphics/webgl/GraphicsRenderer.js b/src/core/graphics/webgl/GraphicsRenderer.js index 9dfcaad..5f11fef 100644 --- a/src/core/graphics/webgl/GraphicsRenderer.js +++ b/src/core/graphics/webgl/GraphicsRenderer.js @@ -10,7 +10,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ diff --git a/src/core/graphics/webgl/WebGLGraphicsData.js b/src/core/graphics/webgl/WebGLGraphicsData.js index 45132d8..f93e589 100644 --- a/src/core/graphics/webgl/WebGLGraphicsData.js +++ b/src/core/graphics/webgl/WebGLGraphicsData.js @@ -1,53 +1,53 @@ /** * An object containing WebGL specific properties to be used by the WebGL renderer - * - * @class + * + * @class * @param gl {WebGLRenderingContext} the current WebGL drawing context * @private */ function WebGLGraphicsData(gl) { - /* + /* * @member {WebGLRenderingContext} the current WebGL drawing context */ this.gl = gl; //TODO does this need to be split before uploding?? - /* + /* * @member {Array} An array of color components (r,g,b) */ this.color = [0,0,0]; // color split! - /* - * @member {Array} An array of points to draw + /* + * @member {Array} An array of points to draw */ this.points = []; - /* + /* * @member {Array} The indices of the vertices */ this.indices = []; - /* + /* * @member {WebGLBuffer} The main buffer */ this.buffer = gl.createBuffer(); - /* + /* * @member {WebGLBuffer} The index buffer */ this.indexBuffer = gl.createBuffer(); - /* + /* * @member {number} todo @alvin */ this.mode = 1; - /* + /* * @member {number} The alpha of the graphics */ this.alpha = 1; - /* + /* * @member {boolean} Whether this graphics is dirty or not */ this.dirty = true; diff --git a/src/core/math/Matrix.js b/src/core/math/Matrix.js index e625842..4357e19 100644 --- a/src/core/math/Matrix.js +++ b/src/core/math/Matrix.js @@ -8,7 +8,7 @@ * | 0 | 0 | 1 | * * @class - * @namespace PIXI + * @memberof PIXI.math */ function Matrix() { diff --git a/src/core/math/Point.js b/src/core/math/Point.js index 632f346..09c129f 100644 --- a/src/core/math/Point.js +++ b/src/core/math/Point.js @@ -3,7 +3,7 @@ * the horizontal axis and y represents the vertical axis. * * @class - * @namespace PIXI + * @memberof PIXI.math * @param [x=0] {number} position of the point on the x axis * @param [y=0] {number} position of the point on the y axis */ diff --git a/src/core/math/shapes/Circle.js b/src/core/math/shapes/Circle.js index 4d76efc..e5c8fc9 100644 --- a/src/core/math/shapes/Circle.js +++ b/src/core/math/shapes/Circle.js @@ -5,7 +5,7 @@ * The Circle object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of this circle * @param y {number} The Y coordinate of the center of this circle * @param radius {number} The radius of the circle diff --git a/src/core/math/shapes/Ellipse.js b/src/core/math/shapes/Ellipse.js index fefd01a..67cf13e 100644 --- a/src/core/math/shapes/Ellipse.js +++ b/src/core/math/shapes/Ellipse.js @@ -5,7 +5,7 @@ * The Ellipse object can be used to specify a hit area for displayObjects * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the center of the ellipse * @param y {number} The Y coordinate of the center of the ellipse * @param width {number} The half width of this ellipse diff --git a/src/core/math/shapes/Polygon.js b/src/core/math/shapes/Polygon.js index 193d31a..07a9e31 100644 --- a/src/core/math/shapes/Polygon.js +++ b/src/core/math/shapes/Polygon.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param points* {Point[]|number[]|...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 Polygon(new Point(), new Point(), ...)`, or the diff --git a/src/core/math/shapes/Rectangle.js b/src/core/math/shapes/Rectangle.js index 2958e07..8fdb579 100644 --- a/src/core/math/shapes/Rectangle.js +++ b/src/core/math/shapes/Rectangle.js @@ -4,7 +4,7 @@ * the Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rectangle * @param y {number} The Y coordinate of the upper-left corner of the rectangle * @param width {number} The overall width of this rectangle diff --git a/src/core/math/shapes/RoundedRectangle.js b/src/core/math/shapes/RoundedRectangle.js index 7ec1eb4..9d8fa97 100644 --- a/src/core/math/shapes/RoundedRectangle.js +++ b/src/core/math/shapes/RoundedRectangle.js @@ -4,7 +4,7 @@ * The Rounded Rectangle object is an area that has nice rounded corners, as indicated by its top-left corner point (x, y) and by its width and its height and its radius. * * @class - * @namespace PIXI + * @memberof PIXI * @param x {number} The X coordinate of the upper-left corner of the rounded rectangle * @param y {number} The Y coordinate of the upper-left corner of the rounded rectangle * @param width {number} The overall width of this rounded rectangle diff --git a/src/core/particles/ParticleContainer.js b/src/core/particles/ParticleContainer.js index 27664c2..5d52916 100644 --- a/src/core/particles/ParticleContainer.js +++ b/src/core/particles/ParticleContainer.js @@ -22,9 +22,9 @@ * * @class * @extends Container - * @namespace PIXI - * - * @param size {number} The number of images in the SpriteBatch before it flushes. + * @memberof PIXI + * + * @param size {number} The number of images in the SpriteBatch before it flushes. */ function ParticleContainer(size, properties) { diff --git a/src/core/particles/webgl/ParticleBuffer.js b/src/core/particles/webgl/ParticleBuffer.js index 73eae2e..75be710 100644 --- a/src/core/particles/webgl/ParticleBuffer.js +++ b/src/core/particles/webgl/ParticleBuffer.js @@ -14,7 +14,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleBuffer(gl, properties, size) diff --git a/src/core/particles/webgl/ParticleRenderer.js b/src/core/particles/webgl/ParticleRenderer.js index 446af7e..cf40b2f 100644 --- a/src/core/particles/webgl/ParticleRenderer.js +++ b/src/core/particles/webgl/ParticleRenderer.js @@ -19,7 +19,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ function ParticleRenderer(renderer) diff --git a/src/core/particles/webgl/ParticleShader.js b/src/core/particles/webgl/ParticleShader.js index 096aef6..5bf9313 100644 --- a/src/core/particles/webgl/ParticleShader.js +++ b/src/core/particles/webgl/ParticleShader.js @@ -3,7 +3,7 @@ /** * @class * @extends TextureShader - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ParticleShader(shaderManager) diff --git a/src/core/renderers/SystemRenderer.js b/src/core/renderers/SystemRenderer.js index 7db135e..7390be4 100644 --- a/src/core/renderers/SystemRenderer.js +++ b/src/core/renderers/SystemRenderer.js @@ -7,7 +7,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param system {string} The name of the system this renderer is for. * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view diff --git a/src/core/renderers/canvas/CanvasRenderer.js b/src/core/renderers/canvas/CanvasRenderer.js index 84b841a..24eafc9 100644 --- a/src/core/renderers/canvas/CanvasRenderer.js +++ b/src/core/renderers/canvas/CanvasRenderer.js @@ -9,7 +9,7 @@ * Don't forget to add the CanvasRenderer.view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=800] {number} the width of the canvas view * @param [height=600] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/canvas/utils/CanvasBuffer.js b/src/core/renderers/canvas/utils/CanvasBuffer.js index 7d06c36..2cb6dc9 100644 --- a/src/core/renderers/canvas/utils/CanvasBuffer.js +++ b/src/core/renderers/canvas/utils/CanvasBuffer.js @@ -2,7 +2,7 @@ * Creates a Canvas element of the given size. * * @class - * @namespace PIXI + * @memberof PIXI * @param width {number} the width for the newly created canvas * @param height {number} the height for the newly created canvas */ diff --git a/src/core/renderers/canvas/utils/CanvasGraphics.js b/src/core/renderers/canvas/utils/CanvasGraphics.js index f0bccfd..092cf1c 100644 --- a/src/core/renderers/canvas/utils/CanvasGraphics.js +++ b/src/core/renderers/canvas/utils/CanvasGraphics.js @@ -3,7 +3,7 @@ /** * A set of functions used by the canvas renderer to draw the primitive graphics data. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasGraphics = module.exports = {}; diff --git a/src/core/renderers/canvas/utils/CanvasMaskManager.js b/src/core/renderers/canvas/utils/CanvasMaskManager.js index 49749d3..5a96d73 100644 --- a/src/core/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/core/renderers/canvas/utils/CanvasMaskManager.js @@ -4,7 +4,7 @@ * A set of functions used to handle masking. * * @class - * @namespace PIXI + * @memberof PIXI */ function CanvasMaskManager() {} diff --git a/src/core/renderers/canvas/utils/CanvasTinter.js b/src/core/renderers/canvas/utils/CanvasTinter.js index 272c7c2..1e42e72 100644 --- a/src/core/renderers/canvas/utils/CanvasTinter.js +++ b/src/core/renderers/canvas/utils/CanvasTinter.js @@ -3,7 +3,7 @@ /** * Utility methods for Sprite/Texture tinting. * @static - * @namespace PIXI + * @memberof PIXI */ var CanvasTinter = module.exports = {}; diff --git a/src/core/renderers/webgl/WebGLRenderer.js b/src/core/renderers/webgl/WebGLRenderer.js index 9e56169..fefbeb3 100644 --- a/src/core/renderers/webgl/WebGLRenderer.js +++ b/src/core/renderers/webgl/WebGLRenderer.js @@ -18,7 +18,7 @@ * Don't forget to add the view to your DOM or you will not see anything :) * * @class - * @namespace PIXI + * @memberof PIXI * @param [width=0] {number} the width of the canvas view * @param [height=0] {number} the height of the canvas view * @param [options] {object} The optional renderer parameters diff --git a/src/core/renderers/webgl/filters/AbstractFilter.js b/src/core/renderers/webgl/filters/AbstractFilter.js index 8bda36d..6d71106 100644 --- a/src/core/renderers/webgl/filters/AbstractFilter.js +++ b/src/core/renderers/webgl/filters/AbstractFilter.js @@ -5,7 +5,7 @@ * If you want to make a custom filter this should be your base class. * * @class - * @namespace PIXI + * @memberof PIXI * @param fragmentSrc {string|string[]} The fragment source in an array of strings. * @param uniforms {object} An object containing the uniforms for this filter. */ diff --git a/src/core/renderers/webgl/filters/FXAAFilter.js b/src/core/renderers/webgl/filters/FXAAFilter.js index 4e24487..f9398d1 100644 --- a/src/core/renderers/webgl/filters/FXAAFilter.js +++ b/src/core/renderers/webgl/filters/FXAAFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function FXAAFilter() diff --git a/src/core/renderers/webgl/filters/SpriteMaskFilter.js b/src/core/renderers/webgl/filters/SpriteMaskFilter.js index d97e797..4b09a8c 100644 --- a/src/core/renderers/webgl/filters/SpriteMaskFilter.js +++ b/src/core/renderers/webgl/filters/SpriteMaskFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture used for the displacement map * must be power of 2 texture at the moment */ function SpriteMaskFilter(sprite) diff --git a/src/core/renderers/webgl/managers/BlendModeManager.js b/src/core/renderers/webgl/managers/BlendModeManager.js index ec57910..be51394 100644 --- a/src/core/renderers/webgl/managers/BlendModeManager.js +++ b/src/core/renderers/webgl/managers/BlendModeManager.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function BlendModeManager(renderer) diff --git a/src/core/renderers/webgl/managers/FilterManager.js b/src/core/renderers/webgl/managers/FilterManager.js index 62a8ad0..b22513d 100644 --- a/src/core/renderers/webgl/managers/FilterManager.js +++ b/src/core/renderers/webgl/managers/FilterManager.js @@ -5,7 +5,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function FilterManager(renderer) diff --git a/src/core/renderers/webgl/managers/MaskManager.js b/src/core/renderers/webgl/managers/MaskManager.js index dc0d630..472eea1 100644 --- a/src/core/renderers/webgl/managers/MaskManager.js +++ b/src/core/renderers/webgl/managers/MaskManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function MaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/ShaderManager.js b/src/core/renderers/webgl/managers/ShaderManager.js index b01d537..32dabf0 100644 --- a/src/core/renderers/webgl/managers/ShaderManager.js +++ b/src/core/renderers/webgl/managers/ShaderManager.js @@ -6,7 +6,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function ShaderManager(renderer) diff --git a/src/core/renderers/webgl/managers/StencilManager.js b/src/core/renderers/webgl/managers/StencilManager.js index db2383a..7b7de67 100644 --- a/src/core/renderers/webgl/managers/StencilManager.js +++ b/src/core/renderers/webgl/managers/StencilManager.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLMaskManager(renderer) diff --git a/src/core/renderers/webgl/managers/WebGLManager.js b/src/core/renderers/webgl/managers/WebGLManager.js index fd544b3..41ddec2 100644 --- a/src/core/renderers/webgl/managers/WebGLManager.js +++ b/src/core/renderers/webgl/managers/WebGLManager.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function WebGLManager(renderer) diff --git a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js index e1fb45b..e3b06ac 100644 --- a/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/ComplexPrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function ComplexPrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/PrimitiveShader.js b/src/core/renderers/webgl/shaders/PrimitiveShader.js index 89ce005..b7eed82 100644 --- a/src/core/renderers/webgl/shaders/PrimitiveShader.js +++ b/src/core/renderers/webgl/shaders/PrimitiveShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {ShaderManager} The webgl shader manager this shader works for. */ function PrimitiveShader(shaderManager) diff --git a/src/core/renderers/webgl/shaders/Shader.js b/src/core/renderers/webgl/shaders/Shader.js index 931da21..9f25245 100644 --- a/src/core/renderers/webgl/shaders/Shader.js +++ b/src/core/renderers/webgl/shaders/Shader.js @@ -3,7 +3,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/shaders/TextureShader.js b/src/core/renderers/webgl/shaders/TextureShader.js index a255d52..7e30f83 100644 --- a/src/core/renderers/webgl/shaders/TextureShader.js +++ b/src/core/renderers/webgl/shaders/TextureShader.js @@ -2,7 +2,7 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param shaderManager {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. diff --git a/src/core/renderers/webgl/utils/ObjectRenderer.js b/src/core/renderers/webgl/utils/ObjectRenderer.js index cf5b4e7..b90a4d5 100644 --- a/src/core/renderers/webgl/utils/ObjectRenderer.js +++ b/src/core/renderers/webgl/utils/ObjectRenderer.js @@ -1,11 +1,10 @@ - var WebGLManager = require('../managers/WebGLManager'); /** + * Base for a common object renderer that can be used as a system renderer plugin. * * @class - * @private - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this object renderer works for. */ function ObjectRenderer(renderer) @@ -36,4 +35,4 @@ ObjectRenderer.prototype.render = function (/* object */) { // render the object -}; \ No newline at end of file +}; diff --git a/src/core/renderers/webgl/utils/Quad.js b/src/core/renderers/webgl/utils/Quad.js index 39e1313..c135ec3 100644 --- a/src/core/renderers/webgl/utils/Quad.js +++ b/src/core/renderers/webgl/utils/Quad.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param gl {WebGLRenderingContext} The gl context for this quad to use. */ function Quad(gl) diff --git a/src/core/renderers/webgl/utils/RenderTarget.js b/src/core/renderers/webgl/utils/RenderTarget.js index c64e306..44345fa 100644 --- a/src/core/renderers/webgl/utils/RenderTarget.js +++ b/src/core/renderers/webgl/utils/RenderTarget.js @@ -9,13 +9,13 @@ */ /** -* @class FrameBuffer -* @constructor -* @param gl {WebGLRenderingContext} the current WebGL drawing context -* @param width {Number} the horizontal range of the filter -* @param height {Number} the vertical range of the filter -* @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values -*/ + * @class + * @memberof PIXI + * @param gl {WebGLRenderingContext} the current WebGL drawing context + * @param width {Number} the horizontal range of the filter + * @param height {Number} the vertical range of the filter + * @param scaleMode {Number} See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values + */ var RenderTarget = function(gl, width, height, scaleMode, resolution, root) { //TODO Resolution could go here ( eg low res blurs ) diff --git a/src/core/renderers/webgl/utils/StencilMaskStack.js b/src/core/renderers/webgl/utils/StencilMaskStack.js index 7cf5dff..fb8940e 100644 --- a/src/core/renderers/webgl/utils/StencilMaskStack.js +++ b/src/core/renderers/webgl/utils/StencilMaskStack.js @@ -1,6 +1,6 @@ /** * @class - * @namespace PIXI + * @memberof PIXI * @param renderer {WebGLRenderer} The renderer this manager works for. */ function StencilMaskStack() diff --git a/src/core/sprites/Sprite.js b/src/core/sprites/Sprite.js index 32a7bf2..75cdd8e 100644 --- a/src/core/sprites/Sprite.js +++ b/src/core/sprites/Sprite.js @@ -16,7 +16,7 @@ * * @class Sprite * @extends Container - * @namespace PIXI + * @memberof PIXI * @param texture {Texture} The texture for this sprite */ function Sprite(texture) diff --git a/src/core/sprites/webgl/SpriteRenderer.js b/src/core/sprites/webgl/SpriteRenderer.js index e90d550..9b601b7 100644 --- a/src/core/sprites/webgl/SpriteRenderer.js +++ b/src/core/sprites/webgl/SpriteRenderer.js @@ -18,7 +18,7 @@ * * @class * @private - * @namespace PIXI + * @memberof PIXI * @extends ObjectRenderer * @param renderer {WebGLRenderer} The renderer this sprite batch works for. */ diff --git a/src/core/textures/BaseTexture.js b/src/core/textures/BaseTexture.js index f28bdfa..4d4d9ab 100644 --- a/src/core/textures/BaseTexture.js +++ b/src/core/textures/BaseTexture.js @@ -6,7 +6,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param source {Image|Canvas} the source object of the texture. * @param [scaleMode=scaleModes.DEFAULT] {number} See {@link SCALE_MODES} for possible values * @param resolution {number} the resolution of the texture for devices with different pixel ratios diff --git a/src/core/textures/RenderTexture.js b/src/core/textures/RenderTexture.js index 8958dfc..5317c3e 100644 --- a/src/core/textures/RenderTexture.js +++ b/src/core/textures/RenderTexture.js @@ -41,7 +41,7 @@ * * @class * @extends Texture - * @namespace PIXI + * @memberof PIXI * @param renderer {CanvasRenderer|WebGLRenderer} The renderer used for this RenderTexture * @param [width=100] {number} The width of the render texture * @param [height=100] {number} The height of the render texture diff --git a/src/core/textures/Texture.js b/src/core/textures/Texture.js index 83bc702..74433ab 100644 --- a/src/core/textures/Texture.js +++ b/src/core/textures/Texture.js @@ -19,7 +19,7 @@ * * @class * @mixes eventTarget - * @namespace PIXI + * @memberof PIXI * @param baseTexture {BaseTexture} The base texture source to create the texture from * @param [frame] {Rectangle} The rectangle frame of the texture to show * @param [crop] {Rectangle} The area of original texture diff --git a/src/core/textures/TextureUvs.js b/src/core/textures/TextureUvs.js index cdfbbd7..853f33d 100644 --- a/src/core/textures/TextureUvs.js +++ b/src/core/textures/TextureUvs.js @@ -3,6 +3,7 @@ * A standard object to store the Uvs of a texture * * @class + * @private */ function TextureUvs() { @@ -23,8 +24,8 @@ /** * Sets the texture Uvs based on the given frame information - * @param frame {Rectangle} - * @param baseFrame {Rectangle} + * @param frame {Rectangle} + * @param baseFrame {Rectangle} * @param rotate {boolean} Whether or not the frame is rotated * @private */ diff --git a/src/core/textures/VideoBaseTexture.js b/src/core/textures/VideoBaseTexture.js index 319d85c..4475bc8 100644 --- a/src/core/textures/VideoBaseTexture.js +++ b/src/core/textures/VideoBaseTexture.js @@ -25,7 +25,7 @@ * * @class * @extends BaseTexture - * @namespace PIXI + * @memberof PIXI * @param source {HTMLVideoElement} * @param [scaleMode] {number} See {@link SCALE_MODES} for possible values */ diff --git a/src/core/utils/EventData.js b/src/core/utils/EventData.js index 8cdf701..42e34e6 100644 --- a/src/core/utils/EventData.js +++ b/src/core/utils/EventData.js @@ -2,7 +2,7 @@ * Creates an homogenous object for tracking events so users can know what to expect. * * @class - * @namespace PIXI + * @memberof PIXI.utils * @param target {object} The target object that the event is called on * @param name {string} The string name of the event that was triggered * @param data {object} Arbitrary event data to pass along diff --git a/src/core/utils/PolyK.js b/src/core/utils/PolyK.js index a9c4185..2f26d36 100644 --- a/src/core/utils/PolyK.js +++ b/src/core/utils/PolyK.js @@ -39,7 +39,7 @@ * This is an amazing lib! * Slightly modified by Mat Groves (matgroves.com); * - * @namespace PIXI + * @memberof PIXI.utils */ var PolyK = module.exports = {}; diff --git a/src/core/utils/Ticker.js b/src/core/utils/Ticker.js index 1016986..ae797c4 100644 --- a/src/core/utils/Ticker.js +++ b/src/core/utils/Ticker.js @@ -1,4 +1,3 @@ - var eventTarget = require('./eventTarget'), EventData = require('./EventData'); @@ -6,7 +5,7 @@ * A Ticker class that runs the main update loop that other objects listen to * * @class - * + * @memberof PIXI.utils */ var Ticker = function() { diff --git a/src/core/utils/eventTarget.js b/src/core/utils/eventTarget.js index 0c1026c..95d23ca 100644 --- a/src/core/utils/eventTarget.js +++ b/src/core/utils/eventTarget.js @@ -1,10 +1,12 @@ var EventData = require('./EventData'); +var tempEventObject = new EventData(null, null, {}); + /** * Mixins event emitter functionality to an object. * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @example * function MyEmitter() {} * @@ -13,14 +15,12 @@ * var em = new MyEmitter(); * em.emit('eventName', 'some data', 'some more data', {}, null, ...); */ - -var tempEventObject = new EventData(null, null, {}); - function eventTarget(obj) { /** * Return a list of assigned event listeners. * + * @memberof eventTarget * @param eventName {string} The events that should be listed. * @return {Array} An array of listener functions */ @@ -34,6 +34,7 @@ /** * Emit an event to all registered event listeners. * + * @memberof eventTarget * @alias dispatchEvent * @param eventName {string} The name of the event. * @return {boolean} Indication if we've emitted an event. @@ -100,6 +101,7 @@ /** * Register a new EventListener for the given event. * + * @memberof eventTarget * @alias addEventListener * @param eventName {string} Name of the event. * @param callback {Functon} fn Callback function. @@ -117,6 +119,7 @@ /** * Add an EventListener that's only called once. * + * @memberof eventTarget * @param eventName {string} Name of the event. * @param callback {Function} Callback function. */ @@ -137,6 +140,7 @@ /** * Remove event listeners. * + * @memberof eventTarget * @alias removeEventListener * @param eventName {string} The event we want to remove. * @param callback {Function} The listener that we need to find. @@ -174,6 +178,7 @@ /** * Remove all listeners or only the listeners for the specified event. * + * @memberof eventTarget * @param eventName {string} The event you want to remove all listeners for. */ obj.removeAllListeners = function removeAllListeners(eventName) diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 70eb1ae..af2e7d9 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -1,7 +1,7 @@ var CONST = require('../const'); /** - * @namespace PIXI + * @namespace PIXI.utils */ var utils = module.exports = { _uid: 0, diff --git a/src/core/utils/pluginTarget.js b/src/core/utils/pluginTarget.js index 3157f89..b291718 100644 --- a/src/core/utils/pluginTarget.js +++ b/src/core/utils/pluginTarget.js @@ -2,7 +2,7 @@ * Mixins functionality to make an object have "plugins". * * @mixin - * @namespace PIXI + * @memberof PIXI.utils * @param obj {object} The object to mix into. * @example * function MyObject() {} diff --git a/src/extras/MovieClip.js b/src/extras/MovieClip.js index 9c961c3..433b49c 100644 --- a/src/extras/MovieClip.js +++ b/src/extras/MovieClip.js @@ -8,7 +8,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param textures {Texture[]} an array of {Texture} objects that make up the animation */ function MovieClip(textures) diff --git a/src/extras/Rope.js b/src/extras/Rope.js index 8b85d60..28e74f4 100644 --- a/src/extras/Rope.js +++ b/src/extras/Rope.js @@ -3,8 +3,8 @@ /** * * @class - * @namespace PIXI * @extends Strip + * @memberof PIXI.extras * @param {Texture} texture - The texture to use on the rope. * @param {Array} points - An array of {Point} objects. * @@ -13,27 +13,27 @@ { Strip.call(this, texture); - /* + /* * @member {Array} An array of points that determine the rope */ this.points = points; - /* + /* * @member {Float32Array} An array of vertices used to construct this rope. */ this.vertices = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} The WebGL Uvs of the rope. */ this.uvs = new Float32Array(points.length * 4); - /* + /* * @member {Float32Array} An array containing the color components */ this.colors = new Float32Array(points.length * 2); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array(points.length * 2); diff --git a/src/extras/Strip.js b/src/extras/Strip.js index 519821f..3e0ef1b 100644 --- a/src/extras/Strip.js +++ b/src/extras/Strip.js @@ -4,7 +4,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} The texture to use * @param width {number} the width * @param height {number} the height @@ -48,7 +48,7 @@ */ this.colors = new Float32Array([1, 1, 1, 1]); - /* + /* * @member {Uint16Array} An array containing the indices of the vertices */ this.indices = new Uint16Array([0, 1, 2, 3]); @@ -283,7 +283,7 @@ /** * Draws the object in TRIANGLE_STRIP mode using canvas * - * @param context {CanvasRenderingContext2D} the current drawing context + * @param context {CanvasRenderingContext2D} the current drawing context * @private */ Strip.prototype._renderCanvasTriangleStrip = function (context) @@ -333,9 +333,9 @@ * @param context {CanvasRenderingContext2D} the current drawing context * @param vertices {Float32Array} a reference to the the vertices of the strip * @param uvs {Float32Array} a reference to the the vertices of the strip - * @param index0 {number} the index of the first vertex - * @param index1 {number} the index of the second vertex - * @param index2 {number} the index of the third vertex + * @param index0 {number} the index of the first vertex + * @param index1 {number} the index of the second vertex + * @param index2 {number} the index of the third vertex * @private */ Strip.prototype._renderCanvasDrawTriangle = function (context, vertices, uvs, index0, index1, index2) diff --git a/src/extras/StripShader.js b/src/extras/StripShader.js index acbe147..59e6811 100644 --- a/src/extras/StripShader.js +++ b/src/extras/StripShader.js @@ -2,9 +2,9 @@ /** * @class - * @namespace PIXI - * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. * @extends Shader + * @memberof PIXI.extras + * @param shaderManager {ShaderManager} The WebGL shader manager this shader works for. */ function StripShader(shaderManager) { diff --git a/src/extras/TilingSprite.js b/src/extras/TilingSprite.js index bbd1f56..ff34740 100644 --- a/src/extras/TilingSprite.js +++ b/src/extras/TilingSprite.js @@ -10,7 +10,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.extras * @param texture {Texture} the texture of the tiling sprite * @param width {number} the width of the tiling sprite * @param height {number} the height of the tiling sprite @@ -62,7 +62,7 @@ /** - * + * * * @member {boolean} * @private @@ -70,7 +70,7 @@ this._tilingTexture = null; /** - * + * * * @member {boolean} * @private @@ -469,7 +469,7 @@ /** * Destroys this tiling sprite - * + * */ TilingSprite.prototype.destroy = function () { core.Sprite.prototype.destroy.call(this); diff --git a/src/extras/index.js b/src/extras/index.js index aceeb3b..87a8eb0 100644 --- a/src/extras/index.js +++ b/src/extras/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.extras */ module.exports = { MovieClip: require('./MovieClip'), diff --git a/src/filters/ascii/AsciiFilter.js b/src/filters/ascii/AsciiFilter.js index af2646a..691bfbc 100644 --- a/src/filters/ascii/AsciiFilter.js +++ b/src/filters/ascii/AsciiFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function AsciiFilter() { diff --git a/src/filters/bloom/BloomFilter.js b/src/filters/bloom/BloomFilter.js index 83a3c1a..729ce7a 100644 --- a/src/filters/bloom/BloomFilter.js +++ b/src/filters/bloom/BloomFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BloomFilter() { diff --git a/src/filters/blur/BlurFilter.js b/src/filters/blur/BlurFilter.js index fe8cc41..a0d14a5 100644 --- a/src/filters/blur/BlurFilter.js +++ b/src/filters/blur/BlurFilter.js @@ -8,7 +8,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurFilter() { diff --git a/src/filters/blur/BlurXFilter.js b/src/filters/blur/BlurXFilter.js index 152a15b..962d41c 100644 --- a/src/filters/blur/BlurXFilter.js +++ b/src/filters/blur/BlurXFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurXFilter() { diff --git a/src/filters/blur/BlurYFilter.js b/src/filters/blur/BlurYFilter.js index 9514934..3a84a7d 100644 --- a/src/filters/blur/BlurYFilter.js +++ b/src/filters/blur/BlurYFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function BlurYFilter() { diff --git a/src/filters/blur/SmartBlurFilter.js b/src/filters/blur/SmartBlurFilter.js index 7948ac1..2743a29 100644 --- a/src/filters/blur/SmartBlurFilter.js +++ b/src/filters/blur/SmartBlurFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SmartBlurFilter() { diff --git a/src/filters/color/ColorMatrixFilter.js b/src/filters/color/ColorMatrixFilter.js index 330730f..f907bfa 100644 --- a/src/filters/color/ColorMatrixFilter.js +++ b/src/filters/color/ColorMatrixFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorMatrixFilter() { diff --git a/src/filters/color/ColorStepFilter.js b/src/filters/color/ColorStepFilter.js index 8faf794..d25f7f4 100644 --- a/src/filters/color/ColorStepFilter.js +++ b/src/filters/color/ColorStepFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ColorStepFilter() { diff --git a/src/filters/convolution/ConvolutionFilter.js b/src/filters/convolution/ConvolutionFilter.js index 694571f..a31887a 100644 --- a/src/filters/convolution/ConvolutionFilter.js +++ b/src/filters/convolution/ConvolutionFilter.js @@ -9,7 +9,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param matrix {number[]} An array of values used for matrix transformation. Specified as a 9 point Array. * @param width {number} Width of the object you are transforming * @param height {number} Height of the object you are transforming diff --git a/src/filters/crosshatch/CrossHatchFilter.js b/src/filters/crosshatch/CrossHatchFilter.js index 340eb91..4cd132d 100644 --- a/src/filters/crosshatch/CrossHatchFilter.js +++ b/src/filters/crosshatch/CrossHatchFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function CrossHatchFilter() { diff --git a/src/filters/dot/DotScreenFilter.js b/src/filters/dot/DotScreenFilter.js index 7273936..bc8009a 100644 --- a/src/filters/dot/DotScreenFilter.js +++ b/src/filters/dot/DotScreenFilter.js @@ -11,7 +11,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function DotScreenFilter() { diff --git a/src/filters/gray/GrayFilter.js b/src/filters/gray/GrayFilter.js index 4b67b66..7ae0e5e 100644 --- a/src/filters/gray/GrayFilter.js +++ b/src/filters/gray/GrayFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function GrayFilter() { diff --git a/src/filters/index.js b/src/filters/index.js index 6c6c7f8..9c8a75f 100644 --- a/src/filters/index.js +++ b/src/filters/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.filters */ module.exports = { AsciiFilter: require('./ascii/AsciiFilter'), diff --git a/src/filters/invert/InvertFilter.js b/src/filters/invert/InvertFilter.js index 0db32a2..f5347a4 100644 --- a/src/filters/invert/InvertFilter.js +++ b/src/filters/invert/InvertFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function InvertFilter() { diff --git a/src/filters/noise/NoiseFilter.js b/src/filters/noise/NoiseFilter.js index 7121d09..70bc9e9 100644 --- a/src/filters/noise/NoiseFilter.js +++ b/src/filters/noise/NoiseFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function NoiseFilter() { diff --git a/src/filters/normal/NormalMapFilter.js b/src/filters/normal/NormalMapFilter.js index fdd9abd..d1a3f58 100644 --- a/src/filters/normal/NormalMapFilter.js +++ b/src/filters/normal/NormalMapFilter.js @@ -6,7 +6,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters * @param texture {Texture} The texture used for the normal map, must be power of 2 texture at the moment */ function NormalMapFilter(texture) diff --git a/src/filters/pixelate/PixelateFilter.js b/src/filters/pixelate/PixelateFilter.js index d80e35c..29bbc4e 100644 --- a/src/filters/pixelate/PixelateFilter.js +++ b/src/filters/pixelate/PixelateFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function PixelateFilter() { diff --git a/src/filters/sepia/SepiaFilter.js b/src/filters/sepia/SepiaFilter.js index b07c47c..3ea474e 100644 --- a/src/filters/sepia/SepiaFilter.js +++ b/src/filters/sepia/SepiaFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function SepiaFilter() { diff --git a/src/filters/shockwave/ShockwaveFilter.js b/src/filters/shockwave/ShockwaveFilter.js index b6f33c2..28b9563 100644 --- a/src/filters/shockwave/ShockwaveFilter.js +++ b/src/filters/shockwave/ShockwaveFilter.js @@ -7,7 +7,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function ShockwaveFilter() { diff --git a/src/filters/tiltshift/TiltShiftAxisFilter.js b/src/filters/tiltshift/TiltShiftAxisFilter.js index 8577586..5d3937f 100644 --- a/src/filters/tiltshift/TiltShiftAxisFilter.js +++ b/src/filters/tiltshift/TiltShiftAxisFilter.js @@ -10,7 +10,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftAxisFilter() { diff --git a/src/filters/tiltshift/TiltShiftFilter.js b/src/filters/tiltshift/TiltShiftFilter.js index 24359a8..8890e4b 100644 --- a/src/filters/tiltshift/TiltShiftFilter.js +++ b/src/filters/tiltshift/TiltShiftFilter.js @@ -12,7 +12,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftFilter() { diff --git a/src/filters/tiltshift/TiltShiftXFilter.js b/src/filters/tiltshift/TiltShiftXFilter.js index 54e0daa..a593350 100644 --- a/src/filters/tiltshift/TiltShiftXFilter.js +++ b/src/filters/tiltshift/TiltShiftXFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftXFilter() { diff --git a/src/filters/tiltshift/TiltShiftYFilter.js b/src/filters/tiltshift/TiltShiftYFilter.js index 651860e..d4a1ffe 100644 --- a/src/filters/tiltshift/TiltShiftYFilter.js +++ b/src/filters/tiltshift/TiltShiftYFilter.js @@ -10,7 +10,7 @@ * * @class * @extends TiltShiftAxisFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TiltShiftYFilter() { diff --git a/src/filters/twist/TwistFilter.js b/src/filters/twist/TwistFilter.js index 4aed6b2..766a633 100644 --- a/src/filters/twist/TwistFilter.js +++ b/src/filters/twist/TwistFilter.js @@ -5,7 +5,7 @@ * * @class * @extends AbstractFilter - * @namespace PIXI.filters + * @memberof PIXI.filters */ function TwistFilter() { diff --git a/src/interaction/InteractionData.js b/src/interaction/InteractionData.js index 07bae0f..e40be15 100644 --- a/src/interaction/InteractionData.js +++ b/src/interaction/InteractionData.js @@ -4,7 +4,7 @@ * Holds all information related to an Interaction event * * @class - * @namespace PIXI + * @memberof PIXI.interaction */ function InteractionData() { diff --git a/src/interaction/InteractionManager.js b/src/interaction/InteractionManager.js index 94c52e0..0680bf9 100644 --- a/src/interaction/InteractionManager.js +++ b/src/interaction/InteractionManager.js @@ -12,7 +12,7 @@ * This manager also supports multitouch. * * @class - * @namespace PIXI + * @memberof PIXI.interaction * @param renderer {CanvasRenderer|WebGLRenderer} A reference to the current renderer */ function InteractionManager( renderer ) diff --git a/src/interaction/index.js b/src/interaction/index.js index b2b446f..e83df25 100644 --- a/src/interaction/index.js +++ b/src/interaction/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.interaction */ module.exports = { InteractionData: require('./InteractionData'), diff --git a/src/loaders/index.js b/src/loaders/index.js index 7781074..cac93fd 100644 --- a/src/loaders/index.js +++ b/src/loaders/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.loaders */ module.exports = { // Loader: require('resource-loader'), diff --git a/src/spine/Spine.js b/src/spine/Spine.js index 9595333..6636d33 100644 --- a/src/spine/Spine.js +++ b/src/spine/Spine.js @@ -12,7 +12,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.spine * @param spineData {object} The spine data loaded from a spine atlas. */ function Spine(spineData) diff --git a/src/spine/index.js b/src/spine/index.js index 401c473..838d6aa 100644 --- a/src/spine/index.js +++ b/src/spine/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.spine */ module.exports = { Spine: require('./Spine'), diff --git a/src/text/BitmapText.js b/src/text/BitmapText.js index bd5e1eb..9ccba8b 100644 --- a/src/text/BitmapText.js +++ b/src/text/BitmapText.js @@ -9,7 +9,7 @@ * * @class * @extends Container - * @namespace PIXI + * @memberof PIXI.text * @param text {string} The copy that you would like the text to display * @param style {object} The style parameters * @param style.font {string|object} The font descriptor for the object, can be passed as a string of form diff --git a/src/text/Text.js b/src/text/Text.js index 08a8c04..08d9c7f 100644 --- a/src/text/Text.js +++ b/src/text/Text.js @@ -6,7 +6,7 @@ * * @class * @extends Sprite - * @namespace PIXI + * @memberof PIXI.text * @param text {string} The copy that you would like the text to display * @param [style] {object} The style parameters * @param [style.font] {string} default 'bold 20px Arial' The style and size of the font diff --git a/src/text/index.js b/src/text/index.js index 90972c4..22d4562 100644 --- a/src/text/index.js +++ b/src/text/index.js @@ -6,7 +6,7 @@ */ /** - * @namespace PIXI + * @namespace PIXI.text */ module.exports = { Text: require('./Text'),