diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index b6f03c0..f9ff7ed 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -20,58 +20,72 @@ constructor(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, nativeLines, shape) { /** - * @member {number} the width of the line to draw + * the width of the line to draw + * @member {number} */ this.lineWidth = lineWidth; + /** - * @member {boolean} if true the liens will be draw using LINES instead of TRIANGLE_STRIP + * if true the liens will be draw using LINES instead of TRIANGLE_STRIP + * @member {boolean} */ this.nativeLines = nativeLines; /** - * @member {number} the color of the line to draw + * the color of the line to draw + * @member {number} */ this.lineColor = lineColor; /** - * @member {number} the alpha of the line to draw + * the alpha of the line to draw + * @member {number} */ this.lineAlpha = lineAlpha; /** - * @member {number} cached tint of the line to draw + * cached tint of the line to draw + * @member {number} + * @private */ this._lineTint = lineColor; /** - * @member {number} the color of the fill + * the color of the fill + * @member {number} */ this.fillColor = fillColor; /** - * @member {number} the alpha of the fill + * the alpha of the fill + * @member {number} */ this.fillAlpha = fillAlpha; /** - * @member {number} cached tint of the fill + * cached tint of the fill + * @member {number} + * @private */ this._fillTint = fillColor; /** - * @member {boolean} whether or not the shape is filled with a colour + * whether or not the shape is filled with a colour + * @member {boolean} */ this.fill = fill; this.holes = []; /** - * @member {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * The shape object to draw. + * @member {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} */ this.shape = shape; /** - * @member {number} The type of the shape, see the Const.Shapes file for all the existing types, + * The type of the shape, see the Const.Shapes file for all the existing types, + * @member {number} */ this.type = shape.type; } diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index b6f03c0..f9ff7ed 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -20,58 +20,72 @@ constructor(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, nativeLines, shape) { /** - * @member {number} the width of the line to draw + * the width of the line to draw + * @member {number} */ this.lineWidth = lineWidth; + /** - * @member {boolean} if true the liens will be draw using LINES instead of TRIANGLE_STRIP + * if true the liens will be draw using LINES instead of TRIANGLE_STRIP + * @member {boolean} */ this.nativeLines = nativeLines; /** - * @member {number} the color of the line to draw + * the color of the line to draw + * @member {number} */ this.lineColor = lineColor; /** - * @member {number} the alpha of the line to draw + * the alpha of the line to draw + * @member {number} */ this.lineAlpha = lineAlpha; /** - * @member {number} cached tint of the line to draw + * cached tint of the line to draw + * @member {number} + * @private */ this._lineTint = lineColor; /** - * @member {number} the color of the fill + * the color of the fill + * @member {number} */ this.fillColor = fillColor; /** - * @member {number} the alpha of the fill + * the alpha of the fill + * @member {number} */ this.fillAlpha = fillAlpha; /** - * @member {number} cached tint of the fill + * cached tint of the fill + * @member {number} + * @private */ this._fillTint = fillColor; /** - * @member {boolean} whether or not the shape is filled with a colour + * whether or not the shape is filled with a colour + * @member {boolean} */ this.fill = fill; this.holes = []; /** - * @member {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * The shape object to draw. + * @member {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} */ this.shape = shape; /** - * @member {number} The type of the shape, see the Const.Shapes file for all the existing types, + * The type of the shape, see the Const.Shapes file for all the existing types, + * @member {number} */ this.type = shape.type; } diff --git a/src/core/renderers/webgl/filters/filterTransforms.js b/src/core/renderers/webgl/filters/filterTransforms.js index 2d08dbc..706e422 100644 --- a/src/core/renderers/webgl/filters/filterTransforms.js +++ b/src/core/renderers/webgl/filters/filterTransforms.js @@ -5,6 +5,7 @@ * @param filterArea {Rectangle} The filter area * @param sprite {Sprite} the target sprite * @param outputMatrix {Matrix} @alvin + * @private */ // TODO playing around here.. this is temporary - (will end up in the shader) // this returns a matrix that will normalise map filter cords in the filter to screen space diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index b6f03c0..f9ff7ed 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -20,58 +20,72 @@ constructor(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, nativeLines, shape) { /** - * @member {number} the width of the line to draw + * the width of the line to draw + * @member {number} */ this.lineWidth = lineWidth; + /** - * @member {boolean} if true the liens will be draw using LINES instead of TRIANGLE_STRIP + * if true the liens will be draw using LINES instead of TRIANGLE_STRIP + * @member {boolean} */ this.nativeLines = nativeLines; /** - * @member {number} the color of the line to draw + * the color of the line to draw + * @member {number} */ this.lineColor = lineColor; /** - * @member {number} the alpha of the line to draw + * the alpha of the line to draw + * @member {number} */ this.lineAlpha = lineAlpha; /** - * @member {number} cached tint of the line to draw + * cached tint of the line to draw + * @member {number} + * @private */ this._lineTint = lineColor; /** - * @member {number} the color of the fill + * the color of the fill + * @member {number} */ this.fillColor = fillColor; /** - * @member {number} the alpha of the fill + * the alpha of the fill + * @member {number} */ this.fillAlpha = fillAlpha; /** - * @member {number} cached tint of the fill + * cached tint of the fill + * @member {number} + * @private */ this._fillTint = fillColor; /** - * @member {boolean} whether or not the shape is filled with a colour + * whether or not the shape is filled with a colour + * @member {boolean} */ this.fill = fill; this.holes = []; /** - * @member {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * The shape object to draw. + * @member {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} */ this.shape = shape; /** - * @member {number} The type of the shape, see the Const.Shapes file for all the existing types, + * The type of the shape, see the Const.Shapes file for all the existing types, + * @member {number} */ this.type = shape.type; } diff --git a/src/core/renderers/webgl/filters/filterTransforms.js b/src/core/renderers/webgl/filters/filterTransforms.js index 2d08dbc..706e422 100644 --- a/src/core/renderers/webgl/filters/filterTransforms.js +++ b/src/core/renderers/webgl/filters/filterTransforms.js @@ -5,6 +5,7 @@ * @param filterArea {Rectangle} The filter area * @param sprite {Sprite} the target sprite * @param outputMatrix {Matrix} @alvin + * @private */ // TODO playing around here.. this is temporary - (will end up in the shader) // this returns a matrix that will normalise map filter cords in the filter to screen space diff --git a/src/core/text/TextStyle.js b/src/core/text/TextStyle.js index c7ab5c2..6b1b00d 100644 --- a/src/core/text/TextStyle.js +++ b/src/core/text/TextStyle.js @@ -680,7 +680,7 @@ /** * Utility function to convert hexadecimal colors to strings, and simply return the color if it's a string. - * + * @private * @param {number|number[]} color * @return {string} The color as a string. */ @@ -704,7 +704,7 @@ /** * Utility function to convert hexadecimal colors to strings, and simply return the color if it's a string. * This version can also convert array of colors - * + * @private * @param {number|number[]} color * @return {string} The color as a string. */ @@ -728,7 +728,7 @@ /** * Utility function to convert hexadecimal colors to strings, and simply return the color if it's a string. * This version can also convert array of colors - * + * @private * @param {Array} array1 First array to compare * @param {Array} array2 Second array to compare * @return {boolean} Do the arrays contain the same values in the same order @@ -758,7 +758,7 @@ /** * Utility function to ensure that object properties are copied by value, and not by reference - * + * @private * @param {Object} target Target object to copy properties into * @param {Object} source Source object for the proporties to copy * @param {string} propertyObj Object containing properties names we want to loop over diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index b6f03c0..f9ff7ed 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -20,58 +20,72 @@ constructor(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, nativeLines, shape) { /** - * @member {number} the width of the line to draw + * the width of the line to draw + * @member {number} */ this.lineWidth = lineWidth; + /** - * @member {boolean} if true the liens will be draw using LINES instead of TRIANGLE_STRIP + * if true the liens will be draw using LINES instead of TRIANGLE_STRIP + * @member {boolean} */ this.nativeLines = nativeLines; /** - * @member {number} the color of the line to draw + * the color of the line to draw + * @member {number} */ this.lineColor = lineColor; /** - * @member {number} the alpha of the line to draw + * the alpha of the line to draw + * @member {number} */ this.lineAlpha = lineAlpha; /** - * @member {number} cached tint of the line to draw + * cached tint of the line to draw + * @member {number} + * @private */ this._lineTint = lineColor; /** - * @member {number} the color of the fill + * the color of the fill + * @member {number} */ this.fillColor = fillColor; /** - * @member {number} the alpha of the fill + * the alpha of the fill + * @member {number} */ this.fillAlpha = fillAlpha; /** - * @member {number} cached tint of the fill + * cached tint of the fill + * @member {number} + * @private */ this._fillTint = fillColor; /** - * @member {boolean} whether or not the shape is filled with a colour + * whether or not the shape is filled with a colour + * @member {boolean} */ this.fill = fill; this.holes = []; /** - * @member {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * The shape object to draw. + * @member {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} */ this.shape = shape; /** - * @member {number} The type of the shape, see the Const.Shapes file for all the existing types, + * The type of the shape, see the Const.Shapes file for all the existing types, + * @member {number} */ this.type = shape.type; } diff --git a/src/core/renderers/webgl/filters/filterTransforms.js b/src/core/renderers/webgl/filters/filterTransforms.js index 2d08dbc..706e422 100644 --- a/src/core/renderers/webgl/filters/filterTransforms.js +++ b/src/core/renderers/webgl/filters/filterTransforms.js @@ -5,6 +5,7 @@ * @param filterArea {Rectangle} The filter area * @param sprite {Sprite} the target sprite * @param outputMatrix {Matrix} @alvin + * @private */ // TODO playing around here.. this is temporary - (will end up in the shader) // this returns a matrix that will normalise map filter cords in the filter to screen space diff --git a/src/core/text/TextStyle.js b/src/core/text/TextStyle.js index c7ab5c2..6b1b00d 100644 --- a/src/core/text/TextStyle.js +++ b/src/core/text/TextStyle.js @@ -680,7 +680,7 @@ /** * Utility function to convert hexadecimal colors to strings, and simply return the color if it's a string. - * + * @private * @param {number|number[]} color * @return {string} The color as a string. */ @@ -704,7 +704,7 @@ /** * Utility function to convert hexadecimal colors to strings, and simply return the color if it's a string. * This version can also convert array of colors - * + * @private * @param {number|number[]} color * @return {string} The color as a string. */ @@ -728,7 +728,7 @@ /** * Utility function to convert hexadecimal colors to strings, and simply return the color if it's a string. * This version can also convert array of colors - * + * @private * @param {Array} array1 First array to compare * @param {Array} array2 Second array to compare * @return {boolean} Do the arrays contain the same values in the same order @@ -758,7 +758,7 @@ /** * Utility function to ensure that object properties are copied by value, and not by reference - * + * @private * @param {Object} target Target object to copy properties into * @param {Object} source Source object for the proporties to copy * @param {string} propertyObj Object containing properties names we want to loop over diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 18dbaa2..a0f560d 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -149,7 +149,7 @@ /** * Typedef for decomposeDataUri return object. * - * @typedef {object} DecomposedDataUri + * @typedef {object} PIXI.utils~DecomposedDataUri * @property {mediaType} Media type, eg. `image` * @property {subType} Sub type, eg. `png` * @property {encoding} Data encoding, eg. `base64` @@ -163,7 +163,7 @@ * @memberof PIXI.utils * @function decomposeDataUri * @param {string} dataUri - the data URI to check - * @return {DecomposedDataUri|undefined} The decomposed data uri or undefined + * @return {PIXI.utils~DecomposedDataUri|undefined} The decomposed data uri or undefined */ export function decomposeDataUri(dataUri) { @@ -205,7 +205,7 @@ /** * Typedef for Size object. * - * @typedef {object} Size + * @typedef {object} PIXI.utils~Size * @property {width} Width component * @property {height} Height component */ @@ -216,7 +216,7 @@ * @memberof PIXI.utils * @function getSvgSize * @param {string} svgString - a serialized svg element - * @return {Size|undefined} image extension + * @return {PIXI.utils~Size|undefined} image extension */ export function getSvgSize(svgString) { @@ -424,6 +424,7 @@ /** * premultiplies tint * + * @memberof PIXI.utils * @param {number} tint integet RGB * @param {number} alpha floating point alpha (0.0-1.0) * @returns {number} tint multiplied by alpha @@ -452,6 +453,7 @@ /** * combines rgb and alpha to out array * + * @memberof PIXI.utils * @param {Float32Array|number[]} rgb input rgb * @param {number} alpha alpha param * @param {Float32Array} [out] output @@ -481,6 +483,7 @@ /** * converts integer tint and float alpha to vec4 form, premultiplies by default * + * @memberof PIXI.utils * @param {number} tint input tint * @param {number} alpha alpha param * @param {Float32Array} [out] output diff --git a/src/core/graphics/GraphicsData.js b/src/core/graphics/GraphicsData.js index b6f03c0..f9ff7ed 100644 --- a/src/core/graphics/GraphicsData.js +++ b/src/core/graphics/GraphicsData.js @@ -20,58 +20,72 @@ constructor(lineWidth, lineColor, lineAlpha, fillColor, fillAlpha, fill, nativeLines, shape) { /** - * @member {number} the width of the line to draw + * the width of the line to draw + * @member {number} */ this.lineWidth = lineWidth; + /** - * @member {boolean} if true the liens will be draw using LINES instead of TRIANGLE_STRIP + * if true the liens will be draw using LINES instead of TRIANGLE_STRIP + * @member {boolean} */ this.nativeLines = nativeLines; /** - * @member {number} the color of the line to draw + * the color of the line to draw + * @member {number} */ this.lineColor = lineColor; /** - * @member {number} the alpha of the line to draw + * the alpha of the line to draw + * @member {number} */ this.lineAlpha = lineAlpha; /** - * @member {number} cached tint of the line to draw + * cached tint of the line to draw + * @member {number} + * @private */ this._lineTint = lineColor; /** - * @member {number} the color of the fill + * the color of the fill + * @member {number} */ this.fillColor = fillColor; /** - * @member {number} the alpha of the fill + * the alpha of the fill + * @member {number} */ this.fillAlpha = fillAlpha; /** - * @member {number} cached tint of the fill + * cached tint of the fill + * @member {number} + * @private */ this._fillTint = fillColor; /** - * @member {boolean} whether or not the shape is filled with a colour + * whether or not the shape is filled with a colour + * @member {boolean} */ this.fill = fill; this.holes = []; /** - * @member {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} The shape object to draw. + * The shape object to draw. + * @member {PIXI.Circle|PIXI.Ellipse|PIXI.Polygon|PIXI.Rectangle|PIXI.RoundedRectangle} */ this.shape = shape; /** - * @member {number} The type of the shape, see the Const.Shapes file for all the existing types, + * The type of the shape, see the Const.Shapes file for all the existing types, + * @member {number} */ this.type = shape.type; } diff --git a/src/core/renderers/webgl/filters/filterTransforms.js b/src/core/renderers/webgl/filters/filterTransforms.js index 2d08dbc..706e422 100644 --- a/src/core/renderers/webgl/filters/filterTransforms.js +++ b/src/core/renderers/webgl/filters/filterTransforms.js @@ -5,6 +5,7 @@ * @param filterArea {Rectangle} The filter area * @param sprite {Sprite} the target sprite * @param outputMatrix {Matrix} @alvin + * @private */ // TODO playing around here.. this is temporary - (will end up in the shader) // this returns a matrix that will normalise map filter cords in the filter to screen space diff --git a/src/core/text/TextStyle.js b/src/core/text/TextStyle.js index c7ab5c2..6b1b00d 100644 --- a/src/core/text/TextStyle.js +++ b/src/core/text/TextStyle.js @@ -680,7 +680,7 @@ /** * Utility function to convert hexadecimal colors to strings, and simply return the color if it's a string. - * + * @private * @param {number|number[]} color * @return {string} The color as a string. */ @@ -704,7 +704,7 @@ /** * Utility function to convert hexadecimal colors to strings, and simply return the color if it's a string. * This version can also convert array of colors - * + * @private * @param {number|number[]} color * @return {string} The color as a string. */ @@ -728,7 +728,7 @@ /** * Utility function to convert hexadecimal colors to strings, and simply return the color if it's a string. * This version can also convert array of colors - * + * @private * @param {Array} array1 First array to compare * @param {Array} array2 Second array to compare * @return {boolean} Do the arrays contain the same values in the same order @@ -758,7 +758,7 @@ /** * Utility function to ensure that object properties are copied by value, and not by reference - * + * @private * @param {Object} target Target object to copy properties into * @param {Object} source Source object for the proporties to copy * @param {string} propertyObj Object containing properties names we want to loop over diff --git a/src/core/utils/index.js b/src/core/utils/index.js index 18dbaa2..a0f560d 100644 --- a/src/core/utils/index.js +++ b/src/core/utils/index.js @@ -149,7 +149,7 @@ /** * Typedef for decomposeDataUri return object. * - * @typedef {object} DecomposedDataUri + * @typedef {object} PIXI.utils~DecomposedDataUri * @property {mediaType} Media type, eg. `image` * @property {subType} Sub type, eg. `png` * @property {encoding} Data encoding, eg. `base64` @@ -163,7 +163,7 @@ * @memberof PIXI.utils * @function decomposeDataUri * @param {string} dataUri - the data URI to check - * @return {DecomposedDataUri|undefined} The decomposed data uri or undefined + * @return {PIXI.utils~DecomposedDataUri|undefined} The decomposed data uri or undefined */ export function decomposeDataUri(dataUri) { @@ -205,7 +205,7 @@ /** * Typedef for Size object. * - * @typedef {object} Size + * @typedef {object} PIXI.utils~Size * @property {width} Width component * @property {height} Height component */ @@ -216,7 +216,7 @@ * @memberof PIXI.utils * @function getSvgSize * @param {string} svgString - a serialized svg element - * @return {Size|undefined} image extension + * @return {PIXI.utils~Size|undefined} image extension */ export function getSvgSize(svgString) { @@ -424,6 +424,7 @@ /** * premultiplies tint * + * @memberof PIXI.utils * @param {number} tint integet RGB * @param {number} alpha floating point alpha (0.0-1.0) * @returns {number} tint multiplied by alpha @@ -452,6 +453,7 @@ /** * combines rgb and alpha to out array * + * @memberof PIXI.utils * @param {Float32Array|number[]} rgb input rgb * @param {number} alpha alpha param * @param {Float32Array} [out] output @@ -481,6 +483,7 @@ /** * converts integer tint and float alpha to vec4 form, premultiplies by default * + * @memberof PIXI.utils * @param {number} tint input tint * @param {number} alpha alpha param * @param {Float32Array} [out] output diff --git a/src/extras/AnimatedSprite.js b/src/extras/AnimatedSprite.js index c605fa8..e538dd4 100644 --- a/src/extras/AnimatedSprite.js +++ b/src/extras/AnimatedSprite.js @@ -1,7 +1,7 @@ import * as core from '../core'; /** - * @typedef FrameObject + * @typedef PIXI.extras.AnimatedSprite~FrameObject * @type {object} * @property {PIXI.Texture} texture - The {@link PIXI.Texture} of the frame * @property {number} time - the duration of the frame in ms @@ -30,7 +30,7 @@ export default class AnimatedSprite extends core.Sprite { /** - * @param {PIXI.Texture[]|FrameObject[]} textures - an array of {@link PIXI.Texture} or frame + * @param {PIXI.Texture[]|PIXI.extras.AnimatedSprite~FrameObject[]} textures - an array of {@link PIXI.Texture} or frame * objects that make up the animation * @param {boolean} [autoUpdate=true] - Whether to use PIXI.ticker.shared to auto update animation time. */