diff --git a/packages/core/src/renderers/State.js b/packages/core/src/renderers/State.js index cc100b5..fa3f221 100644 --- a/packages/core/src/renderers/State.js +++ b/packages/core/src/renderers/State.js @@ -127,7 +127,7 @@ * The blend mode to be applied when this state is set. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode. * Setting this mode to anything other than NO_BLEND will automatically switch blending on. * - * @member {boolean} value + * @member {boolean} * @default PIXI.BLEND_MODES.NORMAL * @see PIXI.BLEND_MODES */ diff --git a/packages/core/src/renderers/State.js b/packages/core/src/renderers/State.js index cc100b5..fa3f221 100644 --- a/packages/core/src/renderers/State.js +++ b/packages/core/src/renderers/State.js @@ -127,7 +127,7 @@ * The blend mode to be applied when this state is set. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode. * Setting this mode to anything other than NO_BLEND will automatically switch blending on. * - * @member {boolean} value + * @member {boolean} * @default PIXI.BLEND_MODES.NORMAL * @see PIXI.BLEND_MODES */ diff --git a/packages/core/src/renderers/filters/filterTransforms.js b/packages/core/src/renderers/filters/filterTransforms.js index d92c916..8932bae 100644 --- a/packages/core/src/renderers/filters/filterTransforms.js +++ b/packages/core/src/renderers/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/packages/core/src/renderers/State.js b/packages/core/src/renderers/State.js index cc100b5..fa3f221 100644 --- a/packages/core/src/renderers/State.js +++ b/packages/core/src/renderers/State.js @@ -127,7 +127,7 @@ * The blend mode to be applied when this state is set. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode. * Setting this mode to anything other than NO_BLEND will automatically switch blending on. * - * @member {boolean} value + * @member {boolean} * @default PIXI.BLEND_MODES.NORMAL * @see PIXI.BLEND_MODES */ diff --git a/packages/core/src/renderers/filters/filterTransforms.js b/packages/core/src/renderers/filters/filterTransforms.js index d92c916..8932bae 100644 --- a/packages/core/src/renderers/filters/filterTransforms.js +++ b/packages/core/src/renderers/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/packages/graphics/src/GraphicsData.js b/packages/graphics/src/GraphicsData.js index b6f03c0..f9ff7ed 100644 --- a/packages/graphics/src/GraphicsData.js +++ b/packages/graphics/src/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/packages/core/src/renderers/State.js b/packages/core/src/renderers/State.js index cc100b5..fa3f221 100644 --- a/packages/core/src/renderers/State.js +++ b/packages/core/src/renderers/State.js @@ -127,7 +127,7 @@ * The blend mode to be applied when this state is set. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode. * Setting this mode to anything other than NO_BLEND will automatically switch blending on. * - * @member {boolean} value + * @member {boolean} * @default PIXI.BLEND_MODES.NORMAL * @see PIXI.BLEND_MODES */ diff --git a/packages/core/src/renderers/filters/filterTransforms.js b/packages/core/src/renderers/filters/filterTransforms.js index d92c916..8932bae 100644 --- a/packages/core/src/renderers/filters/filterTransforms.js +++ b/packages/core/src/renderers/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/packages/graphics/src/GraphicsData.js b/packages/graphics/src/GraphicsData.js index b6f03c0..f9ff7ed 100644 --- a/packages/graphics/src/GraphicsData.js +++ b/packages/graphics/src/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/packages/sprite-animated/src/AnimatedSprite.js b/packages/sprite-animated/src/AnimatedSprite.js index c9ab48d..17e38d0 100644 --- a/packages/sprite-animated/src/AnimatedSprite.js +++ b/packages/sprite-animated/src/AnimatedSprite.js @@ -3,7 +3,7 @@ import { Ticker, UPDATE_PRIORITY } from '@pixi/ticker'; /** - * @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 @@ -32,7 +32,7 @@ export default class AnimatedSprite extends 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. */ diff --git a/packages/core/src/renderers/State.js b/packages/core/src/renderers/State.js index cc100b5..fa3f221 100644 --- a/packages/core/src/renderers/State.js +++ b/packages/core/src/renderers/State.js @@ -127,7 +127,7 @@ * The blend mode to be applied when this state is set. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode. * Setting this mode to anything other than NO_BLEND will automatically switch blending on. * - * @member {boolean} value + * @member {boolean} * @default PIXI.BLEND_MODES.NORMAL * @see PIXI.BLEND_MODES */ diff --git a/packages/core/src/renderers/filters/filterTransforms.js b/packages/core/src/renderers/filters/filterTransforms.js index d92c916..8932bae 100644 --- a/packages/core/src/renderers/filters/filterTransforms.js +++ b/packages/core/src/renderers/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/packages/graphics/src/GraphicsData.js b/packages/graphics/src/GraphicsData.js index b6f03c0..f9ff7ed 100644 --- a/packages/graphics/src/GraphicsData.js +++ b/packages/graphics/src/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/packages/sprite-animated/src/AnimatedSprite.js b/packages/sprite-animated/src/AnimatedSprite.js index c9ab48d..17e38d0 100644 --- a/packages/sprite-animated/src/AnimatedSprite.js +++ b/packages/sprite-animated/src/AnimatedSprite.js @@ -3,7 +3,7 @@ import { Ticker, UPDATE_PRIORITY } from '@pixi/ticker'; /** - * @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 @@ -32,7 +32,7 @@ export default class AnimatedSprite extends 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. */ diff --git a/packages/text/src/TextStyle.js b/packages/text/src/TextStyle.js index de85633..56382f7 100644 --- a/packages/text/src/TextStyle.js +++ b/packages/text/src/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/packages/core/src/renderers/State.js b/packages/core/src/renderers/State.js index cc100b5..fa3f221 100644 --- a/packages/core/src/renderers/State.js +++ b/packages/core/src/renderers/State.js @@ -127,7 +127,7 @@ * The blend mode to be applied when this state is set. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode. * Setting this mode to anything other than NO_BLEND will automatically switch blending on. * - * @member {boolean} value + * @member {boolean} * @default PIXI.BLEND_MODES.NORMAL * @see PIXI.BLEND_MODES */ diff --git a/packages/core/src/renderers/filters/filterTransforms.js b/packages/core/src/renderers/filters/filterTransforms.js index d92c916..8932bae 100644 --- a/packages/core/src/renderers/filters/filterTransforms.js +++ b/packages/core/src/renderers/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/packages/graphics/src/GraphicsData.js b/packages/graphics/src/GraphicsData.js index b6f03c0..f9ff7ed 100644 --- a/packages/graphics/src/GraphicsData.js +++ b/packages/graphics/src/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/packages/sprite-animated/src/AnimatedSprite.js b/packages/sprite-animated/src/AnimatedSprite.js index c9ab48d..17e38d0 100644 --- a/packages/sprite-animated/src/AnimatedSprite.js +++ b/packages/sprite-animated/src/AnimatedSprite.js @@ -3,7 +3,7 @@ import { Ticker, UPDATE_PRIORITY } from '@pixi/ticker'; /** - * @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 @@ -32,7 +32,7 @@ export default class AnimatedSprite extends 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. */ diff --git a/packages/text/src/TextStyle.js b/packages/text/src/TextStyle.js index de85633..56382f7 100644 --- a/packages/text/src/TextStyle.js +++ b/packages/text/src/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/packages/utils/src/color/premultiply.js b/packages/utils/src/color/premultiply.js index 3217bf3..b55ed6f 100644 --- a/packages/utils/src/color/premultiply.js +++ b/packages/utils/src/color/premultiply.js @@ -61,6 +61,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 @@ -90,6 +91,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 @@ -118,6 +120,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/packages/core/src/renderers/State.js b/packages/core/src/renderers/State.js index cc100b5..fa3f221 100644 --- a/packages/core/src/renderers/State.js +++ b/packages/core/src/renderers/State.js @@ -127,7 +127,7 @@ * The blend mode to be applied when this state is set. Apply a value of `PIXI.BLEND_MODES.NORMAL` to reset the blend mode. * Setting this mode to anything other than NO_BLEND will automatically switch blending on. * - * @member {boolean} value + * @member {boolean} * @default PIXI.BLEND_MODES.NORMAL * @see PIXI.BLEND_MODES */ diff --git a/packages/core/src/renderers/filters/filterTransforms.js b/packages/core/src/renderers/filters/filterTransforms.js index d92c916..8932bae 100644 --- a/packages/core/src/renderers/filters/filterTransforms.js +++ b/packages/core/src/renderers/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/packages/graphics/src/GraphicsData.js b/packages/graphics/src/GraphicsData.js index b6f03c0..f9ff7ed 100644 --- a/packages/graphics/src/GraphicsData.js +++ b/packages/graphics/src/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/packages/sprite-animated/src/AnimatedSprite.js b/packages/sprite-animated/src/AnimatedSprite.js index c9ab48d..17e38d0 100644 --- a/packages/sprite-animated/src/AnimatedSprite.js +++ b/packages/sprite-animated/src/AnimatedSprite.js @@ -3,7 +3,7 @@ import { Ticker, UPDATE_PRIORITY } from '@pixi/ticker'; /** - * @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 @@ -32,7 +32,7 @@ export default class AnimatedSprite extends 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. */ diff --git a/packages/text/src/TextStyle.js b/packages/text/src/TextStyle.js index de85633..56382f7 100644 --- a/packages/text/src/TextStyle.js +++ b/packages/text/src/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/packages/utils/src/color/premultiply.js b/packages/utils/src/color/premultiply.js index 3217bf3..b55ed6f 100644 --- a/packages/utils/src/color/premultiply.js +++ b/packages/utils/src/color/premultiply.js @@ -61,6 +61,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 @@ -90,6 +91,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 @@ -118,6 +120,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/packages/utils/src/network/decomposeDataUri.js b/packages/utils/src/network/decomposeDataUri.js index ab317a2..1ba3028 100644 --- a/packages/utils/src/network/decomposeDataUri.js +++ b/packages/utils/src/network/decomposeDataUri.js @@ -3,7 +3,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` @@ -17,7 +17,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) {