diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/TwistFilter.js b/src/pixi/filters/TwistFilter.js index 19da0d5..920a67b 100644 --- a/src/pixi/filters/TwistFilter.js +++ b/src/pixi/filters/TwistFilter.js @@ -6,7 +6,7 @@ * * This filter applies a twist effect making display objects appear twisted in the given direction * @class TwistFilter - * @contructor + * @constructor */ PIXI.TwistFilter = function() { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/TwistFilter.js b/src/pixi/filters/TwistFilter.js index 19da0d5..920a67b 100644 --- a/src/pixi/filters/TwistFilter.js +++ b/src/pixi/filters/TwistFilter.js @@ -6,7 +6,7 @@ * * This filter applies a twist effect making display objects appear twisted in the given direction * @class TwistFilter - * @contructor + * @constructor */ PIXI.TwistFilter = function() { diff --git a/src/pixi/loaders/ImageLoader.js b/src/pixi/loaders/ImageLoader.js index f1606f1..1221eea 100644 --- a/src/pixi/loaders/ImageLoader.js +++ b/src/pixi/loaders/ImageLoader.js @@ -27,6 +27,9 @@ * if the image is loaded with loadFramedSpriteSheet * frames will contain the sprite sheet frames * + * @property frames + * @type Array + * @readOnly */ this.frames = []; }; diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/TwistFilter.js b/src/pixi/filters/TwistFilter.js index 19da0d5..920a67b 100644 --- a/src/pixi/filters/TwistFilter.js +++ b/src/pixi/filters/TwistFilter.js @@ -6,7 +6,7 @@ * * This filter applies a twist effect making display objects appear twisted in the given direction * @class TwistFilter - * @contructor + * @constructor */ PIXI.TwistFilter = function() { diff --git a/src/pixi/loaders/ImageLoader.js b/src/pixi/loaders/ImageLoader.js index f1606f1..1221eea 100644 --- a/src/pixi/loaders/ImageLoader.js +++ b/src/pixi/loaders/ImageLoader.js @@ -27,6 +27,9 @@ * if the image is loaded with loadFramedSpriteSheet * frames will contain the sprite sheet frames * + * @property frames + * @type Array + * @readOnly */ this.frames = []; }; diff --git a/src/pixi/primitives/Graphics.js b/src/pixi/primitives/Graphics.js index 36ae28b..f5ebe21 100644 --- a/src/pixi/primitives/Graphics.js +++ b/src/pixi/primitives/Graphics.js @@ -115,7 +115,9 @@ /** * Used to detect if the graphics object has changed if this is set to true then the graphics object will be recalculated * - * @type {Boolean} + * @property dirty + * @type Boolean + * @private */ this.dirty = true; }; diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/TwistFilter.js b/src/pixi/filters/TwistFilter.js index 19da0d5..920a67b 100644 --- a/src/pixi/filters/TwistFilter.js +++ b/src/pixi/filters/TwistFilter.js @@ -6,7 +6,7 @@ * * This filter applies a twist effect making display objects appear twisted in the given direction * @class TwistFilter - * @contructor + * @constructor */ PIXI.TwistFilter = function() { diff --git a/src/pixi/loaders/ImageLoader.js b/src/pixi/loaders/ImageLoader.js index f1606f1..1221eea 100644 --- a/src/pixi/loaders/ImageLoader.js +++ b/src/pixi/loaders/ImageLoader.js @@ -27,6 +27,9 @@ * if the image is loaded with loadFramedSpriteSheet * frames will contain the sprite sheet frames * + * @property frames + * @type Array + * @readOnly */ this.frames = []; }; diff --git a/src/pixi/primitives/Graphics.js b/src/pixi/primitives/Graphics.js index 36ae28b..f5ebe21 100644 --- a/src/pixi/primitives/Graphics.js +++ b/src/pixi/primitives/Graphics.js @@ -115,7 +115,9 @@ /** * Used to detect if the graphics object has changed if this is set to true then the graphics object will be recalculated * - * @type {Boolean} + * @property dirty + * @type Boolean + * @private */ this.dirty = true; }; diff --git a/src/pixi/renderers/canvas/CanvasGraphics.js b/src/pixi/renderers/canvas/CanvasGraphics.js index e29392b..0daa444 100644 --- a/src/pixi/renderers/canvas/CanvasGraphics.js +++ b/src/pixi/renderers/canvas/CanvasGraphics.js @@ -21,7 +21,7 @@ * @private * @method renderGraphics * @param graphics {Graphics} the actual graphics object to render - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasGraphics.renderGraphics = function(graphics, context) { @@ -191,7 +191,7 @@ * @private * @method renderGraphicsMask * @param graphics {Graphics} the graphics which will be used as a mask - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas */ PIXI.CanvasGraphics.renderGraphicsMask = function(graphics, context) { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/TwistFilter.js b/src/pixi/filters/TwistFilter.js index 19da0d5..920a67b 100644 --- a/src/pixi/filters/TwistFilter.js +++ b/src/pixi/filters/TwistFilter.js @@ -6,7 +6,7 @@ * * This filter applies a twist effect making display objects appear twisted in the given direction * @class TwistFilter - * @contructor + * @constructor */ PIXI.TwistFilter = function() { diff --git a/src/pixi/loaders/ImageLoader.js b/src/pixi/loaders/ImageLoader.js index f1606f1..1221eea 100644 --- a/src/pixi/loaders/ImageLoader.js +++ b/src/pixi/loaders/ImageLoader.js @@ -27,6 +27,9 @@ * if the image is loaded with loadFramedSpriteSheet * frames will contain the sprite sheet frames * + * @property frames + * @type Array + * @readOnly */ this.frames = []; }; diff --git a/src/pixi/primitives/Graphics.js b/src/pixi/primitives/Graphics.js index 36ae28b..f5ebe21 100644 --- a/src/pixi/primitives/Graphics.js +++ b/src/pixi/primitives/Graphics.js @@ -115,7 +115,9 @@ /** * Used to detect if the graphics object has changed if this is set to true then the graphics object will be recalculated * - * @type {Boolean} + * @property dirty + * @type Boolean + * @private */ this.dirty = true; }; diff --git a/src/pixi/renderers/canvas/CanvasGraphics.js b/src/pixi/renderers/canvas/CanvasGraphics.js index e29392b..0daa444 100644 --- a/src/pixi/renderers/canvas/CanvasGraphics.js +++ b/src/pixi/renderers/canvas/CanvasGraphics.js @@ -21,7 +21,7 @@ * @private * @method renderGraphics * @param graphics {Graphics} the actual graphics object to render - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasGraphics.renderGraphics = function(graphics, context) { @@ -191,7 +191,7 @@ * @private * @method renderGraphicsMask * @param graphics {Graphics} the graphics which will be used as a mask - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas */ PIXI.CanvasGraphics.renderGraphicsMask = function(graphics, context) { diff --git a/src/pixi/renderers/canvas/CanvasRenderer.js b/src/pixi/renderers/canvas/CanvasRenderer.js index b35f4dc..81ea948 100644 --- a/src/pixi/renderers/canvas/CanvasRenderer.js +++ b/src/pixi/renderers/canvas/CanvasRenderer.js @@ -8,8 +8,8 @@ * * @class CanvasRenderer * @constructor - * @param width=800 {Number} the width of the canvas view - * @param height=600 {Number} the height of the canvas view + * @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 * @param [options.view] {HTMLCanvasElement} the canvas to use as a view, optional @@ -40,7 +40,7 @@ this.type = PIXI.CANVAS_RENDERER; this.resolution = options.resolution; - + /** * This sets if the CanvasRenderer will clear the canvas or not before the new render pass. * If the Stage is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color. @@ -128,7 +128,7 @@ this.width *= this.resolution; this.height *= this.resolution; - + /** * The canvas element that everything is drawn to * @@ -140,7 +140,7 @@ /** * The canvas 2d context that everything is drawn with * @property context - * @type HTMLCanvasElement 2d Context + * @type CanvasRenderingContext2D 2d Context */ this.context = this.view.getContext( "2d", { alpha: this.transparent } ); @@ -274,7 +274,7 @@ * * @method renderDisplayObject * @param displayObject {DisplayObject} The displayObject to render - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas * @private */ PIXI.CanvasRenderer.prototype.renderDisplayObject = function(displayObject, context) diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/TwistFilter.js b/src/pixi/filters/TwistFilter.js index 19da0d5..920a67b 100644 --- a/src/pixi/filters/TwistFilter.js +++ b/src/pixi/filters/TwistFilter.js @@ -6,7 +6,7 @@ * * This filter applies a twist effect making display objects appear twisted in the given direction * @class TwistFilter - * @contructor + * @constructor */ PIXI.TwistFilter = function() { diff --git a/src/pixi/loaders/ImageLoader.js b/src/pixi/loaders/ImageLoader.js index f1606f1..1221eea 100644 --- a/src/pixi/loaders/ImageLoader.js +++ b/src/pixi/loaders/ImageLoader.js @@ -27,6 +27,9 @@ * if the image is loaded with loadFramedSpriteSheet * frames will contain the sprite sheet frames * + * @property frames + * @type Array + * @readOnly */ this.frames = []; }; diff --git a/src/pixi/primitives/Graphics.js b/src/pixi/primitives/Graphics.js index 36ae28b..f5ebe21 100644 --- a/src/pixi/primitives/Graphics.js +++ b/src/pixi/primitives/Graphics.js @@ -115,7 +115,9 @@ /** * Used to detect if the graphics object has changed if this is set to true then the graphics object will be recalculated * - * @type {Boolean} + * @property dirty + * @type Boolean + * @private */ this.dirty = true; }; diff --git a/src/pixi/renderers/canvas/CanvasGraphics.js b/src/pixi/renderers/canvas/CanvasGraphics.js index e29392b..0daa444 100644 --- a/src/pixi/renderers/canvas/CanvasGraphics.js +++ b/src/pixi/renderers/canvas/CanvasGraphics.js @@ -21,7 +21,7 @@ * @private * @method renderGraphics * @param graphics {Graphics} the actual graphics object to render - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasGraphics.renderGraphics = function(graphics, context) { @@ -191,7 +191,7 @@ * @private * @method renderGraphicsMask * @param graphics {Graphics} the graphics which will be used as a mask - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas */ PIXI.CanvasGraphics.renderGraphicsMask = function(graphics, context) { diff --git a/src/pixi/renderers/canvas/CanvasRenderer.js b/src/pixi/renderers/canvas/CanvasRenderer.js index b35f4dc..81ea948 100644 --- a/src/pixi/renderers/canvas/CanvasRenderer.js +++ b/src/pixi/renderers/canvas/CanvasRenderer.js @@ -8,8 +8,8 @@ * * @class CanvasRenderer * @constructor - * @param width=800 {Number} the width of the canvas view - * @param height=600 {Number} the height of the canvas view + * @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 * @param [options.view] {HTMLCanvasElement} the canvas to use as a view, optional @@ -40,7 +40,7 @@ this.type = PIXI.CANVAS_RENDERER; this.resolution = options.resolution; - + /** * This sets if the CanvasRenderer will clear the canvas or not before the new render pass. * If the Stage is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color. @@ -128,7 +128,7 @@ this.width *= this.resolution; this.height *= this.resolution; - + /** * The canvas element that everything is drawn to * @@ -140,7 +140,7 @@ /** * The canvas 2d context that everything is drawn with * @property context - * @type HTMLCanvasElement 2d Context + * @type CanvasRenderingContext2D 2d Context */ this.context = this.view.getContext( "2d", { alpha: this.transparent } ); @@ -274,7 +274,7 @@ * * @method renderDisplayObject * @param displayObject {DisplayObject} The displayObject to render - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas * @private */ PIXI.CanvasRenderer.prototype.renderDisplayObject = function(displayObject, context) diff --git a/src/pixi/renderers/canvas/utils/CanvasMaskManager.js b/src/pixi/renderers/canvas/utils/CanvasMaskManager.js index 690e976..10a5f82 100644 --- a/src/pixi/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/pixi/renderers/canvas/utils/CanvasMaskManager.js @@ -1,8 +1,7 @@ /** - * @author Mat Groves - * - * + * @author Mat Groves http://matgroves.com/ @Doormat23 */ + /** * A set of functions used to handle masking * @@ -18,7 +17,7 @@ * * @method pushMask * @param maskData the maskData that will be pushed - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasMaskManager.prototype.pushMask = function(maskData, renderSession) { @@ -49,7 +48,7 @@ * Restores the current drawing context to the state it was before the mask was applied * * @method popMask - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasMaskManager.prototype.popMask = function(renderSession) { diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/TwistFilter.js b/src/pixi/filters/TwistFilter.js index 19da0d5..920a67b 100644 --- a/src/pixi/filters/TwistFilter.js +++ b/src/pixi/filters/TwistFilter.js @@ -6,7 +6,7 @@ * * This filter applies a twist effect making display objects appear twisted in the given direction * @class TwistFilter - * @contructor + * @constructor */ PIXI.TwistFilter = function() { diff --git a/src/pixi/loaders/ImageLoader.js b/src/pixi/loaders/ImageLoader.js index f1606f1..1221eea 100644 --- a/src/pixi/loaders/ImageLoader.js +++ b/src/pixi/loaders/ImageLoader.js @@ -27,6 +27,9 @@ * if the image is loaded with loadFramedSpriteSheet * frames will contain the sprite sheet frames * + * @property frames + * @type Array + * @readOnly */ this.frames = []; }; diff --git a/src/pixi/primitives/Graphics.js b/src/pixi/primitives/Graphics.js index 36ae28b..f5ebe21 100644 --- a/src/pixi/primitives/Graphics.js +++ b/src/pixi/primitives/Graphics.js @@ -115,7 +115,9 @@ /** * Used to detect if the graphics object has changed if this is set to true then the graphics object will be recalculated * - * @type {Boolean} + * @property dirty + * @type Boolean + * @private */ this.dirty = true; }; diff --git a/src/pixi/renderers/canvas/CanvasGraphics.js b/src/pixi/renderers/canvas/CanvasGraphics.js index e29392b..0daa444 100644 --- a/src/pixi/renderers/canvas/CanvasGraphics.js +++ b/src/pixi/renderers/canvas/CanvasGraphics.js @@ -21,7 +21,7 @@ * @private * @method renderGraphics * @param graphics {Graphics} the actual graphics object to render - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasGraphics.renderGraphics = function(graphics, context) { @@ -191,7 +191,7 @@ * @private * @method renderGraphicsMask * @param graphics {Graphics} the graphics which will be used as a mask - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas */ PIXI.CanvasGraphics.renderGraphicsMask = function(graphics, context) { diff --git a/src/pixi/renderers/canvas/CanvasRenderer.js b/src/pixi/renderers/canvas/CanvasRenderer.js index b35f4dc..81ea948 100644 --- a/src/pixi/renderers/canvas/CanvasRenderer.js +++ b/src/pixi/renderers/canvas/CanvasRenderer.js @@ -8,8 +8,8 @@ * * @class CanvasRenderer * @constructor - * @param width=800 {Number} the width of the canvas view - * @param height=600 {Number} the height of the canvas view + * @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 * @param [options.view] {HTMLCanvasElement} the canvas to use as a view, optional @@ -40,7 +40,7 @@ this.type = PIXI.CANVAS_RENDERER; this.resolution = options.resolution; - + /** * This sets if the CanvasRenderer will clear the canvas or not before the new render pass. * If the Stage is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color. @@ -128,7 +128,7 @@ this.width *= this.resolution; this.height *= this.resolution; - + /** * The canvas element that everything is drawn to * @@ -140,7 +140,7 @@ /** * The canvas 2d context that everything is drawn with * @property context - * @type HTMLCanvasElement 2d Context + * @type CanvasRenderingContext2D 2d Context */ this.context = this.view.getContext( "2d", { alpha: this.transparent } ); @@ -274,7 +274,7 @@ * * @method renderDisplayObject * @param displayObject {DisplayObject} The displayObject to render - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas * @private */ PIXI.CanvasRenderer.prototype.renderDisplayObject = function(displayObject, context) diff --git a/src/pixi/renderers/canvas/utils/CanvasMaskManager.js b/src/pixi/renderers/canvas/utils/CanvasMaskManager.js index 690e976..10a5f82 100644 --- a/src/pixi/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/pixi/renderers/canvas/utils/CanvasMaskManager.js @@ -1,8 +1,7 @@ /** - * @author Mat Groves - * - * + * @author Mat Groves http://matgroves.com/ @Doormat23 */ + /** * A set of functions used to handle masking * @@ -18,7 +17,7 @@ * * @method pushMask * @param maskData the maskData that will be pushed - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasMaskManager.prototype.pushMask = function(maskData, renderSession) { @@ -49,7 +48,7 @@ * Restores the current drawing context to the state it was before the mask was applied * * @method popMask - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasMaskManager.prototype.popMask = function(renderSession) { diff --git a/src/pixi/renderers/canvas/utils/CanvasTinter.js b/src/pixi/renderers/canvas/utils/CanvasTinter.js index 172f344..b98aea1 100644 --- a/src/pixi/renderers/canvas/utils/CanvasTinter.js +++ b/src/pixi/renderers/canvas/utils/CanvasTinter.js @@ -1,4 +1,3 @@ - /** * @author Mat Groves * diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/TwistFilter.js b/src/pixi/filters/TwistFilter.js index 19da0d5..920a67b 100644 --- a/src/pixi/filters/TwistFilter.js +++ b/src/pixi/filters/TwistFilter.js @@ -6,7 +6,7 @@ * * This filter applies a twist effect making display objects appear twisted in the given direction * @class TwistFilter - * @contructor + * @constructor */ PIXI.TwistFilter = function() { diff --git a/src/pixi/loaders/ImageLoader.js b/src/pixi/loaders/ImageLoader.js index f1606f1..1221eea 100644 --- a/src/pixi/loaders/ImageLoader.js +++ b/src/pixi/loaders/ImageLoader.js @@ -27,6 +27,9 @@ * if the image is loaded with loadFramedSpriteSheet * frames will contain the sprite sheet frames * + * @property frames + * @type Array + * @readOnly */ this.frames = []; }; diff --git a/src/pixi/primitives/Graphics.js b/src/pixi/primitives/Graphics.js index 36ae28b..f5ebe21 100644 --- a/src/pixi/primitives/Graphics.js +++ b/src/pixi/primitives/Graphics.js @@ -115,7 +115,9 @@ /** * Used to detect if the graphics object has changed if this is set to true then the graphics object will be recalculated * - * @type {Boolean} + * @property dirty + * @type Boolean + * @private */ this.dirty = true; }; diff --git a/src/pixi/renderers/canvas/CanvasGraphics.js b/src/pixi/renderers/canvas/CanvasGraphics.js index e29392b..0daa444 100644 --- a/src/pixi/renderers/canvas/CanvasGraphics.js +++ b/src/pixi/renderers/canvas/CanvasGraphics.js @@ -21,7 +21,7 @@ * @private * @method renderGraphics * @param graphics {Graphics} the actual graphics object to render - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasGraphics.renderGraphics = function(graphics, context) { @@ -191,7 +191,7 @@ * @private * @method renderGraphicsMask * @param graphics {Graphics} the graphics which will be used as a mask - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas */ PIXI.CanvasGraphics.renderGraphicsMask = function(graphics, context) { diff --git a/src/pixi/renderers/canvas/CanvasRenderer.js b/src/pixi/renderers/canvas/CanvasRenderer.js index b35f4dc..81ea948 100644 --- a/src/pixi/renderers/canvas/CanvasRenderer.js +++ b/src/pixi/renderers/canvas/CanvasRenderer.js @@ -8,8 +8,8 @@ * * @class CanvasRenderer * @constructor - * @param width=800 {Number} the width of the canvas view - * @param height=600 {Number} the height of the canvas view + * @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 * @param [options.view] {HTMLCanvasElement} the canvas to use as a view, optional @@ -40,7 +40,7 @@ this.type = PIXI.CANVAS_RENDERER; this.resolution = options.resolution; - + /** * This sets if the CanvasRenderer will clear the canvas or not before the new render pass. * If the Stage is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color. @@ -128,7 +128,7 @@ this.width *= this.resolution; this.height *= this.resolution; - + /** * The canvas element that everything is drawn to * @@ -140,7 +140,7 @@ /** * The canvas 2d context that everything is drawn with * @property context - * @type HTMLCanvasElement 2d Context + * @type CanvasRenderingContext2D 2d Context */ this.context = this.view.getContext( "2d", { alpha: this.transparent } ); @@ -274,7 +274,7 @@ * * @method renderDisplayObject * @param displayObject {DisplayObject} The displayObject to render - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas * @private */ PIXI.CanvasRenderer.prototype.renderDisplayObject = function(displayObject, context) diff --git a/src/pixi/renderers/canvas/utils/CanvasMaskManager.js b/src/pixi/renderers/canvas/utils/CanvasMaskManager.js index 690e976..10a5f82 100644 --- a/src/pixi/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/pixi/renderers/canvas/utils/CanvasMaskManager.js @@ -1,8 +1,7 @@ /** - * @author Mat Groves - * - * + * @author Mat Groves http://matgroves.com/ @Doormat23 */ + /** * A set of functions used to handle masking * @@ -18,7 +17,7 @@ * * @method pushMask * @param maskData the maskData that will be pushed - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasMaskManager.prototype.pushMask = function(maskData, renderSession) { @@ -49,7 +48,7 @@ * Restores the current drawing context to the state it was before the mask was applied * * @method popMask - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasMaskManager.prototype.popMask = function(renderSession) { diff --git a/src/pixi/renderers/canvas/utils/CanvasTinter.js b/src/pixi/renderers/canvas/utils/CanvasTinter.js index 172f344..b98aea1 100644 --- a/src/pixi/renderers/canvas/utils/CanvasTinter.js +++ b/src/pixi/renderers/canvas/utils/CanvasTinter.js @@ -1,4 +1,3 @@ - /** * @author Mat Groves * diff --git a/src/pixi/renderers/webgl/WebGLRenderer.js b/src/pixi/renderers/webgl/WebGLRenderer.js index 20c7b26..3ed5737 100644 --- a/src/pixi/renderers/webgl/WebGLRenderer.js +++ b/src/pixi/renderers/webgl/WebGLRenderer.js @@ -12,8 +12,8 @@ * * @class WebGLRenderer * @constructor - * @param width=0 {Number} the width of the canvas view - * @param height=0 {Number} the height of the canvas view + * @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 * @param [options.view] {HTMLCanvasElement} the canvas to use as a view, optional diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/TwistFilter.js b/src/pixi/filters/TwistFilter.js index 19da0d5..920a67b 100644 --- a/src/pixi/filters/TwistFilter.js +++ b/src/pixi/filters/TwistFilter.js @@ -6,7 +6,7 @@ * * This filter applies a twist effect making display objects appear twisted in the given direction * @class TwistFilter - * @contructor + * @constructor */ PIXI.TwistFilter = function() { diff --git a/src/pixi/loaders/ImageLoader.js b/src/pixi/loaders/ImageLoader.js index f1606f1..1221eea 100644 --- a/src/pixi/loaders/ImageLoader.js +++ b/src/pixi/loaders/ImageLoader.js @@ -27,6 +27,9 @@ * if the image is loaded with loadFramedSpriteSheet * frames will contain the sprite sheet frames * + * @property frames + * @type Array + * @readOnly */ this.frames = []; }; diff --git a/src/pixi/primitives/Graphics.js b/src/pixi/primitives/Graphics.js index 36ae28b..f5ebe21 100644 --- a/src/pixi/primitives/Graphics.js +++ b/src/pixi/primitives/Graphics.js @@ -115,7 +115,9 @@ /** * Used to detect if the graphics object has changed if this is set to true then the graphics object will be recalculated * - * @type {Boolean} + * @property dirty + * @type Boolean + * @private */ this.dirty = true; }; diff --git a/src/pixi/renderers/canvas/CanvasGraphics.js b/src/pixi/renderers/canvas/CanvasGraphics.js index e29392b..0daa444 100644 --- a/src/pixi/renderers/canvas/CanvasGraphics.js +++ b/src/pixi/renderers/canvas/CanvasGraphics.js @@ -21,7 +21,7 @@ * @private * @method renderGraphics * @param graphics {Graphics} the actual graphics object to render - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasGraphics.renderGraphics = function(graphics, context) { @@ -191,7 +191,7 @@ * @private * @method renderGraphicsMask * @param graphics {Graphics} the graphics which will be used as a mask - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas */ PIXI.CanvasGraphics.renderGraphicsMask = function(graphics, context) { diff --git a/src/pixi/renderers/canvas/CanvasRenderer.js b/src/pixi/renderers/canvas/CanvasRenderer.js index b35f4dc..81ea948 100644 --- a/src/pixi/renderers/canvas/CanvasRenderer.js +++ b/src/pixi/renderers/canvas/CanvasRenderer.js @@ -8,8 +8,8 @@ * * @class CanvasRenderer * @constructor - * @param width=800 {Number} the width of the canvas view - * @param height=600 {Number} the height of the canvas view + * @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 * @param [options.view] {HTMLCanvasElement} the canvas to use as a view, optional @@ -40,7 +40,7 @@ this.type = PIXI.CANVAS_RENDERER; this.resolution = options.resolution; - + /** * This sets if the CanvasRenderer will clear the canvas or not before the new render pass. * If the Stage is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color. @@ -128,7 +128,7 @@ this.width *= this.resolution; this.height *= this.resolution; - + /** * The canvas element that everything is drawn to * @@ -140,7 +140,7 @@ /** * The canvas 2d context that everything is drawn with * @property context - * @type HTMLCanvasElement 2d Context + * @type CanvasRenderingContext2D 2d Context */ this.context = this.view.getContext( "2d", { alpha: this.transparent } ); @@ -274,7 +274,7 @@ * * @method renderDisplayObject * @param displayObject {DisplayObject} The displayObject to render - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas * @private */ PIXI.CanvasRenderer.prototype.renderDisplayObject = function(displayObject, context) diff --git a/src/pixi/renderers/canvas/utils/CanvasMaskManager.js b/src/pixi/renderers/canvas/utils/CanvasMaskManager.js index 690e976..10a5f82 100644 --- a/src/pixi/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/pixi/renderers/canvas/utils/CanvasMaskManager.js @@ -1,8 +1,7 @@ /** - * @author Mat Groves - * - * + * @author Mat Groves http://matgroves.com/ @Doormat23 */ + /** * A set of functions used to handle masking * @@ -18,7 +17,7 @@ * * @method pushMask * @param maskData the maskData that will be pushed - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasMaskManager.prototype.pushMask = function(maskData, renderSession) { @@ -49,7 +48,7 @@ * Restores the current drawing context to the state it was before the mask was applied * * @method popMask - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasMaskManager.prototype.popMask = function(renderSession) { diff --git a/src/pixi/renderers/canvas/utils/CanvasTinter.js b/src/pixi/renderers/canvas/utils/CanvasTinter.js index 172f344..b98aea1 100644 --- a/src/pixi/renderers/canvas/utils/CanvasTinter.js +++ b/src/pixi/renderers/canvas/utils/CanvasTinter.js @@ -1,4 +1,3 @@ - /** * @author Mat Groves * diff --git a/src/pixi/renderers/webgl/WebGLRenderer.js b/src/pixi/renderers/webgl/WebGLRenderer.js index 20c7b26..3ed5737 100644 --- a/src/pixi/renderers/webgl/WebGLRenderer.js +++ b/src/pixi/renderers/webgl/WebGLRenderer.js @@ -12,8 +12,8 @@ * * @class WebGLRenderer * @constructor - * @param width=0 {Number} the width of the canvas view - * @param height=0 {Number} the height of the canvas view + * @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 * @param [options.view] {HTMLCanvasElement} the canvas to use as a view, optional diff --git a/src/pixi/renderers/webgl/utils/WebGLGraphics.js b/src/pixi/renderers/webgl/utils/WebGLGraphics.js index 0b4b83f..1b63e8d 100644 --- a/src/pixi/renderers/webgl/utils/WebGLGraphics.js +++ b/src/pixi/renderers/webgl/utils/WebGLGraphics.js @@ -359,13 +359,16 @@ * Calcul the points for a quadratic bezier curve. (helper function..) * Based on : https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c * - * @param {number} fromX Origin point x - * @param {number} fromY Origin point x - * @param {number} cpX Control point x - * @param {number} cpY Control point y - * @param {number} toX Destination point x - * @param {number} toY Destination point y - * @return {number[]} + * @static + * @private + * @method quadraticBezierCurve + * @param fromX {Number} Origin point x + * @param fromY {Number} Origin point x + * @param cpX {Number} Control point x + * @param cpY {Number} Control point y + * @param toX {Number} Destination point x + * @param toY {Number} Destination point y + * @return {Array} */ PIXI.WebGLGraphics.quadraticBezierCurve = function(fromX, fromY, cpX, cpY, toX, toY) { var xa, diff --git a/src/pixi/filters/AlphaMaskFilter.js b/src/pixi/filters/AlphaMaskFilter.js index 6419a6e..61c7e7a 100644 --- a/src/pixi/filters/AlphaMaskFilter.js +++ b/src/pixi/filters/AlphaMaskFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used to offset the x and the g propery of the texture is used to offset the y. * @class AlphaMaskFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.AlphaMaskFilter = function(texture) diff --git a/src/pixi/filters/BlurFilter.js b/src/pixi/filters/BlurFilter.js index 1b5cddb..41699cf 100644 --- a/src/pixi/filters/BlurFilter.js +++ b/src/pixi/filters/BlurFilter.js @@ -8,7 +8,7 @@ * The strength of the blur can be set for x- and y-axis separately (always relative to the stage). * * @class BlurFilter - * @contructor + * @constructor */ PIXI.BlurFilter = function() { diff --git a/src/pixi/filters/ColorMatrixFilter.js b/src/pixi/filters/ColorMatrixFilter.js index fa3e5f1..14802a3 100644 --- a/src/pixi/filters/ColorMatrixFilter.js +++ b/src/pixi/filters/ColorMatrixFilter.js @@ -8,7 +8,7 @@ * color and alpha values of every pixel on your displayObject to produce a result * with a new set of RGBA color and alpha values. Its pretty powerful! * @class ColorMatrixFilter - * @contructor + * @constructor */ PIXI.ColorMatrixFilter = function() { diff --git a/src/pixi/filters/ColorStepFilter.js b/src/pixi/filters/ColorStepFilter.js index 8536409..f04bd90 100644 --- a/src/pixi/filters/ColorStepFilter.js +++ b/src/pixi/filters/ColorStepFilter.js @@ -6,7 +6,7 @@ * * This lowers the color depth of your image by the given amount, producing an image with a smaller palette. * @class ColorStepFilter - * @contructor + * @constructor */ PIXI.ColorStepFilter = function() { diff --git a/src/pixi/filters/DisplacementFilter.js b/src/pixi/filters/DisplacementFilter.js index 0e0e017..14198c3 100644 --- a/src/pixi/filters/DisplacementFilter.js +++ b/src/pixi/filters/DisplacementFilter.js @@ -8,7 +8,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class DisplacementFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.DisplacementFilter = function(texture) diff --git a/src/pixi/filters/DotScreenFilter.js b/src/pixi/filters/DotScreenFilter.js index e04aa8c..5f26861 100644 --- a/src/pixi/filters/DotScreenFilter.js +++ b/src/pixi/filters/DotScreenFilter.js @@ -7,7 +7,7 @@ * * This filter applies a dotscreen effect making display objects appear to be made out of black and white halftone dots like an old printer * @class DotScreenFilter - * @contructor + * @constructor */ PIXI.DotScreenFilter = function() { diff --git a/src/pixi/filters/GrayFilter.js b/src/pixi/filters/GrayFilter.js index 40c8936..c6be048 100644 --- a/src/pixi/filters/GrayFilter.js +++ b/src/pixi/filters/GrayFilter.js @@ -6,7 +6,7 @@ * * This turns your displayObjects to black and white. * @class GrayFilter - * @contructor + * @constructor */ PIXI.GrayFilter = function() { diff --git a/src/pixi/filters/InvertFilter.js b/src/pixi/filters/InvertFilter.js index d110509..4515f94 100644 --- a/src/pixi/filters/InvertFilter.js +++ b/src/pixi/filters/InvertFilter.js @@ -6,7 +6,7 @@ * * This inverts your displayObjects colors. * @class InvertFilter - * @contructor + * @constructor */ PIXI.InvertFilter = function() { diff --git a/src/pixi/filters/NormalMapFilter.js b/src/pixi/filters/NormalMapFilter.js index 4983d20..97184c9 100644 --- a/src/pixi/filters/NormalMapFilter.js +++ b/src/pixi/filters/NormalMapFilter.js @@ -9,7 +9,7 @@ * You can use this filter to apply all manor of crazy warping effects * Currently the r property of the texture is used offset the x and the g propery of the texture is used to offset the y. * @class NormalMapFilter - * @contructor + * @constructor * @param texture {Texture} The texture used for the displacemtent map * must be power of 2 texture at the moment */ PIXI.NormalMapFilter = function(texture) diff --git a/src/pixi/filters/PixelateFilter.js b/src/pixi/filters/PixelateFilter.js index 24652b0..ed972a9 100644 --- a/src/pixi/filters/PixelateFilter.js +++ b/src/pixi/filters/PixelateFilter.js @@ -6,7 +6,7 @@ * * This filter applies a pixelate effect making display objects appear 'blocky' * @class PixelateFilter - * @contructor + * @constructor */ PIXI.PixelateFilter = function() { diff --git a/src/pixi/filters/SepiaFilter.js b/src/pixi/filters/SepiaFilter.js index a3e785e..364fa60 100644 --- a/src/pixi/filters/SepiaFilter.js +++ b/src/pixi/filters/SepiaFilter.js @@ -6,7 +6,7 @@ * * This applies a sepia effect to your displayObjects. * @class SepiaFilter - * @contructor + * @constructor */ PIXI.SepiaFilter = function() { diff --git a/src/pixi/filters/TwistFilter.js b/src/pixi/filters/TwistFilter.js index 19da0d5..920a67b 100644 --- a/src/pixi/filters/TwistFilter.js +++ b/src/pixi/filters/TwistFilter.js @@ -6,7 +6,7 @@ * * This filter applies a twist effect making display objects appear twisted in the given direction * @class TwistFilter - * @contructor + * @constructor */ PIXI.TwistFilter = function() { diff --git a/src/pixi/loaders/ImageLoader.js b/src/pixi/loaders/ImageLoader.js index f1606f1..1221eea 100644 --- a/src/pixi/loaders/ImageLoader.js +++ b/src/pixi/loaders/ImageLoader.js @@ -27,6 +27,9 @@ * if the image is loaded with loadFramedSpriteSheet * frames will contain the sprite sheet frames * + * @property frames + * @type Array + * @readOnly */ this.frames = []; }; diff --git a/src/pixi/primitives/Graphics.js b/src/pixi/primitives/Graphics.js index 36ae28b..f5ebe21 100644 --- a/src/pixi/primitives/Graphics.js +++ b/src/pixi/primitives/Graphics.js @@ -115,7 +115,9 @@ /** * Used to detect if the graphics object has changed if this is set to true then the graphics object will be recalculated * - * @type {Boolean} + * @property dirty + * @type Boolean + * @private */ this.dirty = true; }; diff --git a/src/pixi/renderers/canvas/CanvasGraphics.js b/src/pixi/renderers/canvas/CanvasGraphics.js index e29392b..0daa444 100644 --- a/src/pixi/renderers/canvas/CanvasGraphics.js +++ b/src/pixi/renderers/canvas/CanvasGraphics.js @@ -21,7 +21,7 @@ * @private * @method renderGraphics * @param graphics {Graphics} the actual graphics object to render - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasGraphics.renderGraphics = function(graphics, context) { @@ -191,7 +191,7 @@ * @private * @method renderGraphicsMask * @param graphics {Graphics} the graphics which will be used as a mask - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas */ PIXI.CanvasGraphics.renderGraphicsMask = function(graphics, context) { diff --git a/src/pixi/renderers/canvas/CanvasRenderer.js b/src/pixi/renderers/canvas/CanvasRenderer.js index b35f4dc..81ea948 100644 --- a/src/pixi/renderers/canvas/CanvasRenderer.js +++ b/src/pixi/renderers/canvas/CanvasRenderer.js @@ -8,8 +8,8 @@ * * @class CanvasRenderer * @constructor - * @param width=800 {Number} the width of the canvas view - * @param height=600 {Number} the height of the canvas view + * @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 * @param [options.view] {HTMLCanvasElement} the canvas to use as a view, optional @@ -40,7 +40,7 @@ this.type = PIXI.CANVAS_RENDERER; this.resolution = options.resolution; - + /** * This sets if the CanvasRenderer will clear the canvas or not before the new render pass. * If the Stage is NOT transparent Pixi will use a canvas sized fillRect operation every frame to set the canvas background color. @@ -128,7 +128,7 @@ this.width *= this.resolution; this.height *= this.resolution; - + /** * The canvas element that everything is drawn to * @@ -140,7 +140,7 @@ /** * The canvas 2d context that everything is drawn with * @property context - * @type HTMLCanvasElement 2d Context + * @type CanvasRenderingContext2D 2d Context */ this.context = this.view.getContext( "2d", { alpha: this.transparent } ); @@ -274,7 +274,7 @@ * * @method renderDisplayObject * @param displayObject {DisplayObject} The displayObject to render - * @param context {Context2D} the context 2d method of the canvas + * @param context {CanvasRenderingContext2D} the context 2d method of the canvas * @private */ PIXI.CanvasRenderer.prototype.renderDisplayObject = function(displayObject, context) diff --git a/src/pixi/renderers/canvas/utils/CanvasMaskManager.js b/src/pixi/renderers/canvas/utils/CanvasMaskManager.js index 690e976..10a5f82 100644 --- a/src/pixi/renderers/canvas/utils/CanvasMaskManager.js +++ b/src/pixi/renderers/canvas/utils/CanvasMaskManager.js @@ -1,8 +1,7 @@ /** - * @author Mat Groves - * - * + * @author Mat Groves http://matgroves.com/ @Doormat23 */ + /** * A set of functions used to handle masking * @@ -18,7 +17,7 @@ * * @method pushMask * @param maskData the maskData that will be pushed - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasMaskManager.prototype.pushMask = function(maskData, renderSession) { @@ -49,7 +48,7 @@ * Restores the current drawing context to the state it was before the mask was applied * * @method popMask - * @param context {Context2D} the 2d drawing method of the canvas + * @param context {CanvasRenderingContext2D} the 2d drawing method of the canvas */ PIXI.CanvasMaskManager.prototype.popMask = function(renderSession) { diff --git a/src/pixi/renderers/canvas/utils/CanvasTinter.js b/src/pixi/renderers/canvas/utils/CanvasTinter.js index 172f344..b98aea1 100644 --- a/src/pixi/renderers/canvas/utils/CanvasTinter.js +++ b/src/pixi/renderers/canvas/utils/CanvasTinter.js @@ -1,4 +1,3 @@ - /** * @author Mat Groves * diff --git a/src/pixi/renderers/webgl/WebGLRenderer.js b/src/pixi/renderers/webgl/WebGLRenderer.js index 20c7b26..3ed5737 100644 --- a/src/pixi/renderers/webgl/WebGLRenderer.js +++ b/src/pixi/renderers/webgl/WebGLRenderer.js @@ -12,8 +12,8 @@ * * @class WebGLRenderer * @constructor - * @param width=0 {Number} the width of the canvas view - * @param height=0 {Number} the height of the canvas view + * @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 * @param [options.view] {HTMLCanvasElement} the canvas to use as a view, optional diff --git a/src/pixi/renderers/webgl/utils/WebGLGraphics.js b/src/pixi/renderers/webgl/utils/WebGLGraphics.js index 0b4b83f..1b63e8d 100644 --- a/src/pixi/renderers/webgl/utils/WebGLGraphics.js +++ b/src/pixi/renderers/webgl/utils/WebGLGraphics.js @@ -359,13 +359,16 @@ * Calcul the points for a quadratic bezier curve. (helper function..) * Based on : https://stackoverflow.com/questions/785097/how-do-i-implement-a-bezier-curve-in-c * - * @param {number} fromX Origin point x - * @param {number} fromY Origin point x - * @param {number} cpX Control point x - * @param {number} cpY Control point y - * @param {number} toX Destination point x - * @param {number} toY Destination point y - * @return {number[]} + * @static + * @private + * @method quadraticBezierCurve + * @param fromX {Number} Origin point x + * @param fromY {Number} Origin point x + * @param cpX {Number} Control point x + * @param cpY {Number} Control point y + * @param toX {Number} Destination point x + * @param toY {Number} Destination point y + * @return {Array} */ PIXI.WebGLGraphics.quadraticBezierCurve = function(fromX, fromY, cpX, cpY, toX, toY) { var xa, diff --git a/src/pixi/textures/RenderTexture.js b/src/pixi/textures/RenderTexture.js index 021e97a..2ff2909 100644 --- a/src/pixi/textures/RenderTexture.js +++ b/src/pixi/textures/RenderTexture.js @@ -3,27 +3,27 @@ */ /** - A RenderTexture is a special texture that allows any pixi displayObject to be rendered to it. - - __Hint__: All DisplayObjects (exmpl. Sprites) that render on RenderTexture should be preloaded. - Otherwise black rectangles will be drawn instead. - - RenderTexture takes snapshot of DisplayObject passed to render method. If DisplayObject is passed to render method, position and rotation of it will be ignored. For example: - - var renderTexture = new PIXI.RenderTexture(800, 600); - var sprite = PIXI.Sprite.fromImage("spinObj_01.png"); - sprite.position.x = 800/2; - sprite.position.y = 600/2; - sprite.anchor.x = 0.5; - sprite.anchor.y = 0.5; - renderTexture.render(sprite); - - Sprite in this case will be rendered to 0,0 position. To render this sprite at center DisplayObjectContainer should be used: - - var doc = new PIXI.DisplayObjectContainer(); - doc.addChild(sprite); - renderTexture.render(doc); // Renders to center of renderTexture - + * A RenderTexture is a special texture that allows any pixi displayObject to be rendered to it. + * + * __Hint__: All DisplayObjects (exmpl. Sprites) that render on RenderTexture should be preloaded. + * Otherwise black rectangles will be drawn instead. + * + * RenderTexture takes snapshot of DisplayObject passed to render method. If DisplayObject is passed to render method, position and rotation of it will be ignored. For example: + * + * var renderTexture = new PIXI.RenderTexture(800, 600); + * var sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * sprite.position.x = 800/2; + * sprite.position.y = 600/2; + * sprite.anchor.x = 0.5; + * sprite.anchor.y = 0.5; + * renderTexture.render(sprite); + * + * Sprite in this case will be rendered to 0,0 position. To render this sprite at center DisplayObjectContainer should be used: + * + * var doc = new PIXI.DisplayObjectContainer(); + * doc.addChild(sprite); + * renderTexture.render(doc); // Renders to center of renderTexture + * * @class RenderTexture * @extends Texture * @constructor