diff --git a/packages/accessibility/src/AccessibilityManager.js b/packages/accessibility/src/AccessibilityManager.js index f3bf230..eefb65e 100644 --- a/packages/accessibility/src/AccessibilityManager.js +++ b/packages/accessibility/src/AccessibilityManager.js @@ -357,7 +357,7 @@ /** * Adjust the hit area based on the bounds of a display object * - * @param {Rectangle} hitArea - Bounds of the child + * @param {PIXI.Rectangle} hitArea - Bounds of the child */ capHitArea(hitArea) { @@ -388,7 +388,7 @@ * Adds a DisplayObject to the accessibility manager * * @private - * @param {DisplayObject} displayObject - The child to make accessible. + * @param {PIXI.DisplayObject} displayObject - The child to make accessible. */ addChild(displayObject) { diff --git a/packages/accessibility/src/AccessibilityManager.js b/packages/accessibility/src/AccessibilityManager.js index f3bf230..eefb65e 100644 --- a/packages/accessibility/src/AccessibilityManager.js +++ b/packages/accessibility/src/AccessibilityManager.js @@ -357,7 +357,7 @@ /** * Adjust the hit area based on the bounds of a display object * - * @param {Rectangle} hitArea - Bounds of the child + * @param {PIXI.Rectangle} hitArea - Bounds of the child */ capHitArea(hitArea) { @@ -388,7 +388,7 @@ * Adds a DisplayObject to the accessibility manager * * @private - * @param {DisplayObject} displayObject - The child to make accessible. + * @param {PIXI.DisplayObject} displayObject - The child to make accessible. */ addChild(displayObject) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index bfe1d4a..dc0248f 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -12,7 +12,7 @@ * * ```js * let renderer = PIXI.autoDetectRenderer(); - * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 800, height: 600 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * let sprite = PIXI.Sprite.from("spinObj_01.png"); * @@ -31,7 +31,7 @@ * * sprite.setTransform() * - * let baseRenderTexture = new PIXI.BaseRenderTexture(100, 100); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 100, height: 100 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * * renderer.render(sprite, renderTexture); // Renders to center of RenderTexture diff --git a/packages/accessibility/src/AccessibilityManager.js b/packages/accessibility/src/AccessibilityManager.js index f3bf230..eefb65e 100644 --- a/packages/accessibility/src/AccessibilityManager.js +++ b/packages/accessibility/src/AccessibilityManager.js @@ -357,7 +357,7 @@ /** * Adjust the hit area based on the bounds of a display object * - * @param {Rectangle} hitArea - Bounds of the child + * @param {PIXI.Rectangle} hitArea - Bounds of the child */ capHitArea(hitArea) { @@ -388,7 +388,7 @@ * Adds a DisplayObject to the accessibility manager * * @private - * @param {DisplayObject} displayObject - The child to make accessible. + * @param {PIXI.DisplayObject} displayObject - The child to make accessible. */ addChild(displayObject) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index bfe1d4a..dc0248f 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -12,7 +12,7 @@ * * ```js * let renderer = PIXI.autoDetectRenderer(); - * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 800, height: 600 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * let sprite = PIXI.Sprite.from("spinObj_01.png"); * @@ -31,7 +31,7 @@ * * sprite.setTransform() * - * let baseRenderTexture = new PIXI.BaseRenderTexture(100, 100); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 100, height: 100 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * * renderer.render(sprite, renderTexture); // Renders to center of RenderTexture diff --git a/packages/core/src/renderTexture/RenderTexture.js b/packages/core/src/renderTexture/RenderTexture.js index c3c1ddb..14e319f 100644 --- a/packages/core/src/renderTexture/RenderTexture.js +++ b/packages/core/src/renderTexture/RenderTexture.js @@ -41,7 +41,7 @@ export default class RenderTexture extends Texture { /** - * @param {PIXI.BaseRenderTexture} baseRenderTexture - The renderer used for this RenderTexture + * @param {PIXI.BaseRenderTexture} baseRenderTexture - The base texture object that this texture uses * @param {PIXI.Rectangle} [frame] - The rectangle frame of the texture to show */ constructor(baseRenderTexture, frame) @@ -74,7 +74,7 @@ /** * The base texture object that this texture uses * - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ super(baseRenderTexture, frame); @@ -95,10 +95,10 @@ this.filterFrame = null; /** - * The key for pooled texture of FilterSystem - * @protected - * @member {string} - */ + * The key for pooled texture of FilterSystem + * @protected + * @member {string} + */ this.filterPoolKey = null; this.updateUvs(); diff --git a/packages/accessibility/src/AccessibilityManager.js b/packages/accessibility/src/AccessibilityManager.js index f3bf230..eefb65e 100644 --- a/packages/accessibility/src/AccessibilityManager.js +++ b/packages/accessibility/src/AccessibilityManager.js @@ -357,7 +357,7 @@ /** * Adjust the hit area based on the bounds of a display object * - * @param {Rectangle} hitArea - Bounds of the child + * @param {PIXI.Rectangle} hitArea - Bounds of the child */ capHitArea(hitArea) { @@ -388,7 +388,7 @@ * Adds a DisplayObject to the accessibility manager * * @private - * @param {DisplayObject} displayObject - The child to make accessible. + * @param {PIXI.DisplayObject} displayObject - The child to make accessible. */ addChild(displayObject) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index bfe1d4a..dc0248f 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -12,7 +12,7 @@ * * ```js * let renderer = PIXI.autoDetectRenderer(); - * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 800, height: 600 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * let sprite = PIXI.Sprite.from("spinObj_01.png"); * @@ -31,7 +31,7 @@ * * sprite.setTransform() * - * let baseRenderTexture = new PIXI.BaseRenderTexture(100, 100); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 100, height: 100 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * * renderer.render(sprite, renderTexture); // Renders to center of RenderTexture diff --git a/packages/core/src/renderTexture/RenderTexture.js b/packages/core/src/renderTexture/RenderTexture.js index c3c1ddb..14e319f 100644 --- a/packages/core/src/renderTexture/RenderTexture.js +++ b/packages/core/src/renderTexture/RenderTexture.js @@ -41,7 +41,7 @@ export default class RenderTexture extends Texture { /** - * @param {PIXI.BaseRenderTexture} baseRenderTexture - The renderer used for this RenderTexture + * @param {PIXI.BaseRenderTexture} baseRenderTexture - The base texture object that this texture uses * @param {PIXI.Rectangle} [frame] - The rectangle frame of the texture to show */ constructor(baseRenderTexture, frame) @@ -74,7 +74,7 @@ /** * The base texture object that this texture uses * - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ super(baseRenderTexture, frame); @@ -95,10 +95,10 @@ this.filterFrame = null; /** - * The key for pooled texture of FilterSystem - * @protected - * @member {string} - */ + * The key for pooled texture of FilterSystem + * @protected + * @member {string} + */ this.filterPoolKey = null; this.updateUvs(); diff --git a/packages/core/src/textures/BaseTexture.js b/packages/core/src/textures/BaseTexture.js index e986bad..4958121 100644 --- a/packages/core/src/textures/BaseTexture.js +++ b/packages/core/src/textures/BaseTexture.js @@ -1,5 +1,5 @@ -import { uid, BaseTextureCache, TextureCache, isPow2, EventEmitter } from '@pixi/utils'; -import { FORMATS, TARGETS, TYPES, SCALE_MODES } from '@pixi/constants'; +import { BaseTextureCache, EventEmitter, isPow2, TextureCache, uid } from '@pixi/utils'; +import { FORMATS, SCALE_MODES, TARGETS, TYPES } from '@pixi/constants'; import Resource from './resources/Resource'; import BufferResource from './resources/BufferResource'; @@ -311,7 +311,7 @@ * * @param {PIXI.SCALE_MODES} [scaleMode] - Pixi scalemode * @param {PIXI.MIPMAP_MODES} [mipmap] - enable mipmaps - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setStyle(scaleMode, mipmap) { @@ -343,7 +343,7 @@ * @param {number} width Visual width * @param {number} height Visual height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setSize(width, height, resolution) { @@ -362,7 +362,7 @@ * @param {number} realWidth Full rendered width * @param {number} realHeight Full rendered height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setRealSize(realWidth, realHeight, resolution) { @@ -389,7 +389,7 @@ * Changes resolution * * @param {number} [resolution] res - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResolution(resolution) { @@ -418,7 +418,7 @@ * Sets the resource if it wasn't set. Throws error if resource already present * * @param {PIXI.resources.Resource} resource - that is managing this BaseTexture - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResource(resource) { diff --git a/packages/accessibility/src/AccessibilityManager.js b/packages/accessibility/src/AccessibilityManager.js index f3bf230..eefb65e 100644 --- a/packages/accessibility/src/AccessibilityManager.js +++ b/packages/accessibility/src/AccessibilityManager.js @@ -357,7 +357,7 @@ /** * Adjust the hit area based on the bounds of a display object * - * @param {Rectangle} hitArea - Bounds of the child + * @param {PIXI.Rectangle} hitArea - Bounds of the child */ capHitArea(hitArea) { @@ -388,7 +388,7 @@ * Adds a DisplayObject to the accessibility manager * * @private - * @param {DisplayObject} displayObject - The child to make accessible. + * @param {PIXI.DisplayObject} displayObject - The child to make accessible. */ addChild(displayObject) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index bfe1d4a..dc0248f 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -12,7 +12,7 @@ * * ```js * let renderer = PIXI.autoDetectRenderer(); - * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 800, height: 600 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * let sprite = PIXI.Sprite.from("spinObj_01.png"); * @@ -31,7 +31,7 @@ * * sprite.setTransform() * - * let baseRenderTexture = new PIXI.BaseRenderTexture(100, 100); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 100, height: 100 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * * renderer.render(sprite, renderTexture); // Renders to center of RenderTexture diff --git a/packages/core/src/renderTexture/RenderTexture.js b/packages/core/src/renderTexture/RenderTexture.js index c3c1ddb..14e319f 100644 --- a/packages/core/src/renderTexture/RenderTexture.js +++ b/packages/core/src/renderTexture/RenderTexture.js @@ -41,7 +41,7 @@ export default class RenderTexture extends Texture { /** - * @param {PIXI.BaseRenderTexture} baseRenderTexture - The renderer used for this RenderTexture + * @param {PIXI.BaseRenderTexture} baseRenderTexture - The base texture object that this texture uses * @param {PIXI.Rectangle} [frame] - The rectangle frame of the texture to show */ constructor(baseRenderTexture, frame) @@ -74,7 +74,7 @@ /** * The base texture object that this texture uses * - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ super(baseRenderTexture, frame); @@ -95,10 +95,10 @@ this.filterFrame = null; /** - * The key for pooled texture of FilterSystem - * @protected - * @member {string} - */ + * The key for pooled texture of FilterSystem + * @protected + * @member {string} + */ this.filterPoolKey = null; this.updateUvs(); diff --git a/packages/core/src/textures/BaseTexture.js b/packages/core/src/textures/BaseTexture.js index e986bad..4958121 100644 --- a/packages/core/src/textures/BaseTexture.js +++ b/packages/core/src/textures/BaseTexture.js @@ -1,5 +1,5 @@ -import { uid, BaseTextureCache, TextureCache, isPow2, EventEmitter } from '@pixi/utils'; -import { FORMATS, TARGETS, TYPES, SCALE_MODES } from '@pixi/constants'; +import { BaseTextureCache, EventEmitter, isPow2, TextureCache, uid } from '@pixi/utils'; +import { FORMATS, SCALE_MODES, TARGETS, TYPES } from '@pixi/constants'; import Resource from './resources/Resource'; import BufferResource from './resources/BufferResource'; @@ -311,7 +311,7 @@ * * @param {PIXI.SCALE_MODES} [scaleMode] - Pixi scalemode * @param {PIXI.MIPMAP_MODES} [mipmap] - enable mipmaps - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setStyle(scaleMode, mipmap) { @@ -343,7 +343,7 @@ * @param {number} width Visual width * @param {number} height Visual height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setSize(width, height, resolution) { @@ -362,7 +362,7 @@ * @param {number} realWidth Full rendered width * @param {number} realHeight Full rendered height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setRealSize(realWidth, realHeight, resolution) { @@ -389,7 +389,7 @@ * Changes resolution * * @param {number} [resolution] res - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResolution(resolution) { @@ -418,7 +418,7 @@ * Sets the resource if it wasn't set. Throws error if resource already present * * @param {PIXI.resources.Resource} resource - that is managing this BaseTexture - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResource(resource) { diff --git a/packages/core/src/textures/TextureSystem.js b/packages/core/src/textures/TextureSystem.js index d0a80bc..6a2da8f 100644 --- a/packages/core/src/textures/TextureSystem.js +++ b/packages/core/src/textures/TextureSystem.js @@ -357,7 +357,7 @@ * * @private * @param {PIXI.BaseTexture} texture - Texture to update - * @param {glTexture} glTexture + * @param {PIXI.GLTexture} glTexture */ setStyle(texture, glTexture) { diff --git a/packages/accessibility/src/AccessibilityManager.js b/packages/accessibility/src/AccessibilityManager.js index f3bf230..eefb65e 100644 --- a/packages/accessibility/src/AccessibilityManager.js +++ b/packages/accessibility/src/AccessibilityManager.js @@ -357,7 +357,7 @@ /** * Adjust the hit area based on the bounds of a display object * - * @param {Rectangle} hitArea - Bounds of the child + * @param {PIXI.Rectangle} hitArea - Bounds of the child */ capHitArea(hitArea) { @@ -388,7 +388,7 @@ * Adds a DisplayObject to the accessibility manager * * @private - * @param {DisplayObject} displayObject - The child to make accessible. + * @param {PIXI.DisplayObject} displayObject - The child to make accessible. */ addChild(displayObject) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index bfe1d4a..dc0248f 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -12,7 +12,7 @@ * * ```js * let renderer = PIXI.autoDetectRenderer(); - * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 800, height: 600 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * let sprite = PIXI.Sprite.from("spinObj_01.png"); * @@ -31,7 +31,7 @@ * * sprite.setTransform() * - * let baseRenderTexture = new PIXI.BaseRenderTexture(100, 100); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 100, height: 100 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * * renderer.render(sprite, renderTexture); // Renders to center of RenderTexture diff --git a/packages/core/src/renderTexture/RenderTexture.js b/packages/core/src/renderTexture/RenderTexture.js index c3c1ddb..14e319f 100644 --- a/packages/core/src/renderTexture/RenderTexture.js +++ b/packages/core/src/renderTexture/RenderTexture.js @@ -41,7 +41,7 @@ export default class RenderTexture extends Texture { /** - * @param {PIXI.BaseRenderTexture} baseRenderTexture - The renderer used for this RenderTexture + * @param {PIXI.BaseRenderTexture} baseRenderTexture - The base texture object that this texture uses * @param {PIXI.Rectangle} [frame] - The rectangle frame of the texture to show */ constructor(baseRenderTexture, frame) @@ -74,7 +74,7 @@ /** * The base texture object that this texture uses * - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ super(baseRenderTexture, frame); @@ -95,10 +95,10 @@ this.filterFrame = null; /** - * The key for pooled texture of FilterSystem - * @protected - * @member {string} - */ + * The key for pooled texture of FilterSystem + * @protected + * @member {string} + */ this.filterPoolKey = null; this.updateUvs(); diff --git a/packages/core/src/textures/BaseTexture.js b/packages/core/src/textures/BaseTexture.js index e986bad..4958121 100644 --- a/packages/core/src/textures/BaseTexture.js +++ b/packages/core/src/textures/BaseTexture.js @@ -1,5 +1,5 @@ -import { uid, BaseTextureCache, TextureCache, isPow2, EventEmitter } from '@pixi/utils'; -import { FORMATS, TARGETS, TYPES, SCALE_MODES } from '@pixi/constants'; +import { BaseTextureCache, EventEmitter, isPow2, TextureCache, uid } from '@pixi/utils'; +import { FORMATS, SCALE_MODES, TARGETS, TYPES } from '@pixi/constants'; import Resource from './resources/Resource'; import BufferResource from './resources/BufferResource'; @@ -311,7 +311,7 @@ * * @param {PIXI.SCALE_MODES} [scaleMode] - Pixi scalemode * @param {PIXI.MIPMAP_MODES} [mipmap] - enable mipmaps - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setStyle(scaleMode, mipmap) { @@ -343,7 +343,7 @@ * @param {number} width Visual width * @param {number} height Visual height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setSize(width, height, resolution) { @@ -362,7 +362,7 @@ * @param {number} realWidth Full rendered width * @param {number} realHeight Full rendered height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setRealSize(realWidth, realHeight, resolution) { @@ -389,7 +389,7 @@ * Changes resolution * * @param {number} [resolution] res - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResolution(resolution) { @@ -418,7 +418,7 @@ * Sets the resource if it wasn't set. Throws error if resource already present * * @param {PIXI.resources.Resource} resource - that is managing this BaseTexture - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResource(resource) { diff --git a/packages/core/src/textures/TextureSystem.js b/packages/core/src/textures/TextureSystem.js index d0a80bc..6a2da8f 100644 --- a/packages/core/src/textures/TextureSystem.js +++ b/packages/core/src/textures/TextureSystem.js @@ -357,7 +357,7 @@ * * @private * @param {PIXI.BaseTexture} texture - Texture to update - * @param {glTexture} glTexture + * @param {PIXI.GLTexture} glTexture */ setStyle(texture, glTexture) { diff --git a/packages/display/src/Container.js b/packages/display/src/Container.js index ff301ef..b509c7a 100644 --- a/packages/display/src/Container.js +++ b/packages/display/src/Container.js @@ -332,7 +332,7 @@ * * @param {number} [beginIndex=0] - The beginning position. * @param {number} [endIndex=this.children.length] - The ending position. Default value is size of the container. - * @returns {DisplayObject[]} List of removed children + * @returns {PIXI.DisplayObject[]} List of removed children */ removeChildren(beginIndex = 0, endIndex) { diff --git a/packages/accessibility/src/AccessibilityManager.js b/packages/accessibility/src/AccessibilityManager.js index f3bf230..eefb65e 100644 --- a/packages/accessibility/src/AccessibilityManager.js +++ b/packages/accessibility/src/AccessibilityManager.js @@ -357,7 +357,7 @@ /** * Adjust the hit area based on the bounds of a display object * - * @param {Rectangle} hitArea - Bounds of the child + * @param {PIXI.Rectangle} hitArea - Bounds of the child */ capHitArea(hitArea) { @@ -388,7 +388,7 @@ * Adds a DisplayObject to the accessibility manager * * @private - * @param {DisplayObject} displayObject - The child to make accessible. + * @param {PIXI.DisplayObject} displayObject - The child to make accessible. */ addChild(displayObject) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index bfe1d4a..dc0248f 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -12,7 +12,7 @@ * * ```js * let renderer = PIXI.autoDetectRenderer(); - * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 800, height: 600 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * let sprite = PIXI.Sprite.from("spinObj_01.png"); * @@ -31,7 +31,7 @@ * * sprite.setTransform() * - * let baseRenderTexture = new PIXI.BaseRenderTexture(100, 100); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 100, height: 100 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * * renderer.render(sprite, renderTexture); // Renders to center of RenderTexture diff --git a/packages/core/src/renderTexture/RenderTexture.js b/packages/core/src/renderTexture/RenderTexture.js index c3c1ddb..14e319f 100644 --- a/packages/core/src/renderTexture/RenderTexture.js +++ b/packages/core/src/renderTexture/RenderTexture.js @@ -41,7 +41,7 @@ export default class RenderTexture extends Texture { /** - * @param {PIXI.BaseRenderTexture} baseRenderTexture - The renderer used for this RenderTexture + * @param {PIXI.BaseRenderTexture} baseRenderTexture - The base texture object that this texture uses * @param {PIXI.Rectangle} [frame] - The rectangle frame of the texture to show */ constructor(baseRenderTexture, frame) @@ -74,7 +74,7 @@ /** * The base texture object that this texture uses * - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ super(baseRenderTexture, frame); @@ -95,10 +95,10 @@ this.filterFrame = null; /** - * The key for pooled texture of FilterSystem - * @protected - * @member {string} - */ + * The key for pooled texture of FilterSystem + * @protected + * @member {string} + */ this.filterPoolKey = null; this.updateUvs(); diff --git a/packages/core/src/textures/BaseTexture.js b/packages/core/src/textures/BaseTexture.js index e986bad..4958121 100644 --- a/packages/core/src/textures/BaseTexture.js +++ b/packages/core/src/textures/BaseTexture.js @@ -1,5 +1,5 @@ -import { uid, BaseTextureCache, TextureCache, isPow2, EventEmitter } from '@pixi/utils'; -import { FORMATS, TARGETS, TYPES, SCALE_MODES } from '@pixi/constants'; +import { BaseTextureCache, EventEmitter, isPow2, TextureCache, uid } from '@pixi/utils'; +import { FORMATS, SCALE_MODES, TARGETS, TYPES } from '@pixi/constants'; import Resource from './resources/Resource'; import BufferResource from './resources/BufferResource'; @@ -311,7 +311,7 @@ * * @param {PIXI.SCALE_MODES} [scaleMode] - Pixi scalemode * @param {PIXI.MIPMAP_MODES} [mipmap] - enable mipmaps - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setStyle(scaleMode, mipmap) { @@ -343,7 +343,7 @@ * @param {number} width Visual width * @param {number} height Visual height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setSize(width, height, resolution) { @@ -362,7 +362,7 @@ * @param {number} realWidth Full rendered width * @param {number} realHeight Full rendered height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setRealSize(realWidth, realHeight, resolution) { @@ -389,7 +389,7 @@ * Changes resolution * * @param {number} [resolution] res - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResolution(resolution) { @@ -418,7 +418,7 @@ * Sets the resource if it wasn't set. Throws error if resource already present * * @param {PIXI.resources.Resource} resource - that is managing this BaseTexture - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResource(resource) { diff --git a/packages/core/src/textures/TextureSystem.js b/packages/core/src/textures/TextureSystem.js index d0a80bc..6a2da8f 100644 --- a/packages/core/src/textures/TextureSystem.js +++ b/packages/core/src/textures/TextureSystem.js @@ -357,7 +357,7 @@ * * @private * @param {PIXI.BaseTexture} texture - Texture to update - * @param {glTexture} glTexture + * @param {PIXI.GLTexture} glTexture */ setStyle(texture, glTexture) { diff --git a/packages/display/src/Container.js b/packages/display/src/Container.js index ff301ef..b509c7a 100644 --- a/packages/display/src/Container.js +++ b/packages/display/src/Container.js @@ -332,7 +332,7 @@ * * @param {number} [beginIndex=0] - The beginning position. * @param {number} [endIndex=this.children.length] - The ending position. Default value is size of the container. - * @returns {DisplayObject[]} List of removed children + * @returns {PIXI.DisplayObject[]} List of removed children */ removeChildren(beginIndex = 0, endIndex) { diff --git a/packages/mixin-get-global-position/src/index.js b/packages/mixin-get-global-position/src/index.js index 8440288..7a2e51f 100644 --- a/packages/mixin-get-global-position/src/index.js +++ b/packages/mixin-get-global-position/src/index.js @@ -6,11 +6,11 @@ * * @method getGlobalPosition * @memberof PIXI.DisplayObject# - * @param {Point} point - The point to write the global value to. If null a new point will be returned - * @param {boolean} skipUpdate - Setting to true will stop the transforms of the scene graph from + * @param {PIXI.Point} [point=new PIXI.Point()] - The point to write the global value to. + * @param {boolean} [skipUpdate=false] - Setting to true will stop the transforms of the scene graph from * being updated. This means the calculation returned MAY be out of date BUT will give you a * nice performance boost. - * @return {Point} The updated point. + * @return {PIXI.Point} The updated point. */ DisplayObject.prototype.getGlobalPosition = function getGlobalPosition(point = new Point(), skipUpdate = false) { diff --git a/packages/accessibility/src/AccessibilityManager.js b/packages/accessibility/src/AccessibilityManager.js index f3bf230..eefb65e 100644 --- a/packages/accessibility/src/AccessibilityManager.js +++ b/packages/accessibility/src/AccessibilityManager.js @@ -357,7 +357,7 @@ /** * Adjust the hit area based on the bounds of a display object * - * @param {Rectangle} hitArea - Bounds of the child + * @param {PIXI.Rectangle} hitArea - Bounds of the child */ capHitArea(hitArea) { @@ -388,7 +388,7 @@ * Adds a DisplayObject to the accessibility manager * * @private - * @param {DisplayObject} displayObject - The child to make accessible. + * @param {PIXI.DisplayObject} displayObject - The child to make accessible. */ addChild(displayObject) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index bfe1d4a..dc0248f 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -12,7 +12,7 @@ * * ```js * let renderer = PIXI.autoDetectRenderer(); - * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 800, height: 600 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * let sprite = PIXI.Sprite.from("spinObj_01.png"); * @@ -31,7 +31,7 @@ * * sprite.setTransform() * - * let baseRenderTexture = new PIXI.BaseRenderTexture(100, 100); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 100, height: 100 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * * renderer.render(sprite, renderTexture); // Renders to center of RenderTexture diff --git a/packages/core/src/renderTexture/RenderTexture.js b/packages/core/src/renderTexture/RenderTexture.js index c3c1ddb..14e319f 100644 --- a/packages/core/src/renderTexture/RenderTexture.js +++ b/packages/core/src/renderTexture/RenderTexture.js @@ -41,7 +41,7 @@ export default class RenderTexture extends Texture { /** - * @param {PIXI.BaseRenderTexture} baseRenderTexture - The renderer used for this RenderTexture + * @param {PIXI.BaseRenderTexture} baseRenderTexture - The base texture object that this texture uses * @param {PIXI.Rectangle} [frame] - The rectangle frame of the texture to show */ constructor(baseRenderTexture, frame) @@ -74,7 +74,7 @@ /** * The base texture object that this texture uses * - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ super(baseRenderTexture, frame); @@ -95,10 +95,10 @@ this.filterFrame = null; /** - * The key for pooled texture of FilterSystem - * @protected - * @member {string} - */ + * The key for pooled texture of FilterSystem + * @protected + * @member {string} + */ this.filterPoolKey = null; this.updateUvs(); diff --git a/packages/core/src/textures/BaseTexture.js b/packages/core/src/textures/BaseTexture.js index e986bad..4958121 100644 --- a/packages/core/src/textures/BaseTexture.js +++ b/packages/core/src/textures/BaseTexture.js @@ -1,5 +1,5 @@ -import { uid, BaseTextureCache, TextureCache, isPow2, EventEmitter } from '@pixi/utils'; -import { FORMATS, TARGETS, TYPES, SCALE_MODES } from '@pixi/constants'; +import { BaseTextureCache, EventEmitter, isPow2, TextureCache, uid } from '@pixi/utils'; +import { FORMATS, SCALE_MODES, TARGETS, TYPES } from '@pixi/constants'; import Resource from './resources/Resource'; import BufferResource from './resources/BufferResource'; @@ -311,7 +311,7 @@ * * @param {PIXI.SCALE_MODES} [scaleMode] - Pixi scalemode * @param {PIXI.MIPMAP_MODES} [mipmap] - enable mipmaps - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setStyle(scaleMode, mipmap) { @@ -343,7 +343,7 @@ * @param {number} width Visual width * @param {number} height Visual height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setSize(width, height, resolution) { @@ -362,7 +362,7 @@ * @param {number} realWidth Full rendered width * @param {number} realHeight Full rendered height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setRealSize(realWidth, realHeight, resolution) { @@ -389,7 +389,7 @@ * Changes resolution * * @param {number} [resolution] res - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResolution(resolution) { @@ -418,7 +418,7 @@ * Sets the resource if it wasn't set. Throws error if resource already present * * @param {PIXI.resources.Resource} resource - that is managing this BaseTexture - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResource(resource) { diff --git a/packages/core/src/textures/TextureSystem.js b/packages/core/src/textures/TextureSystem.js index d0a80bc..6a2da8f 100644 --- a/packages/core/src/textures/TextureSystem.js +++ b/packages/core/src/textures/TextureSystem.js @@ -357,7 +357,7 @@ * * @private * @param {PIXI.BaseTexture} texture - Texture to update - * @param {glTexture} glTexture + * @param {PIXI.GLTexture} glTexture */ setStyle(texture, glTexture) { diff --git a/packages/display/src/Container.js b/packages/display/src/Container.js index ff301ef..b509c7a 100644 --- a/packages/display/src/Container.js +++ b/packages/display/src/Container.js @@ -332,7 +332,7 @@ * * @param {number} [beginIndex=0] - The beginning position. * @param {number} [endIndex=this.children.length] - The ending position. Default value is size of the container. - * @returns {DisplayObject[]} List of removed children + * @returns {PIXI.DisplayObject[]} List of removed children */ removeChildren(beginIndex = 0, endIndex) { diff --git a/packages/mixin-get-global-position/src/index.js b/packages/mixin-get-global-position/src/index.js index 8440288..7a2e51f 100644 --- a/packages/mixin-get-global-position/src/index.js +++ b/packages/mixin-get-global-position/src/index.js @@ -6,11 +6,11 @@ * * @method getGlobalPosition * @memberof PIXI.DisplayObject# - * @param {Point} point - The point to write the global value to. If null a new point will be returned - * @param {boolean} skipUpdate - Setting to true will stop the transforms of the scene graph from + * @param {PIXI.Point} [point=new PIXI.Point()] - The point to write the global value to. + * @param {boolean} [skipUpdate=false] - Setting to true will stop the transforms of the scene graph from * being updated. This means the calculation returned MAY be out of date BUT will give you a * nice performance boost. - * @return {Point} The updated point. + * @return {PIXI.Point} The updated point. */ DisplayObject.prototype.getGlobalPosition = function getGlobalPosition(point = new Point(), skipUpdate = false) { diff --git a/packages/particles/src/ParticleContainer.js b/packages/particles/src/ParticleContainer.js index 5e37746..936424f 100644 --- a/packages/particles/src/ParticleContainer.js +++ b/packages/particles/src/ParticleContainer.js @@ -142,7 +142,7 @@ * The texture used to render the children. * * @readonly - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ this.baseTexture = null; diff --git a/packages/accessibility/src/AccessibilityManager.js b/packages/accessibility/src/AccessibilityManager.js index f3bf230..eefb65e 100644 --- a/packages/accessibility/src/AccessibilityManager.js +++ b/packages/accessibility/src/AccessibilityManager.js @@ -357,7 +357,7 @@ /** * Adjust the hit area based on the bounds of a display object * - * @param {Rectangle} hitArea - Bounds of the child + * @param {PIXI.Rectangle} hitArea - Bounds of the child */ capHitArea(hitArea) { @@ -388,7 +388,7 @@ * Adds a DisplayObject to the accessibility manager * * @private - * @param {DisplayObject} displayObject - The child to make accessible. + * @param {PIXI.DisplayObject} displayObject - The child to make accessible. */ addChild(displayObject) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index bfe1d4a..dc0248f 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -12,7 +12,7 @@ * * ```js * let renderer = PIXI.autoDetectRenderer(); - * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 800, height: 600 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * let sprite = PIXI.Sprite.from("spinObj_01.png"); * @@ -31,7 +31,7 @@ * * sprite.setTransform() * - * let baseRenderTexture = new PIXI.BaseRenderTexture(100, 100); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 100, height: 100 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * * renderer.render(sprite, renderTexture); // Renders to center of RenderTexture diff --git a/packages/core/src/renderTexture/RenderTexture.js b/packages/core/src/renderTexture/RenderTexture.js index c3c1ddb..14e319f 100644 --- a/packages/core/src/renderTexture/RenderTexture.js +++ b/packages/core/src/renderTexture/RenderTexture.js @@ -41,7 +41,7 @@ export default class RenderTexture extends Texture { /** - * @param {PIXI.BaseRenderTexture} baseRenderTexture - The renderer used for this RenderTexture + * @param {PIXI.BaseRenderTexture} baseRenderTexture - The base texture object that this texture uses * @param {PIXI.Rectangle} [frame] - The rectangle frame of the texture to show */ constructor(baseRenderTexture, frame) @@ -74,7 +74,7 @@ /** * The base texture object that this texture uses * - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ super(baseRenderTexture, frame); @@ -95,10 +95,10 @@ this.filterFrame = null; /** - * The key for pooled texture of FilterSystem - * @protected - * @member {string} - */ + * The key for pooled texture of FilterSystem + * @protected + * @member {string} + */ this.filterPoolKey = null; this.updateUvs(); diff --git a/packages/core/src/textures/BaseTexture.js b/packages/core/src/textures/BaseTexture.js index e986bad..4958121 100644 --- a/packages/core/src/textures/BaseTexture.js +++ b/packages/core/src/textures/BaseTexture.js @@ -1,5 +1,5 @@ -import { uid, BaseTextureCache, TextureCache, isPow2, EventEmitter } from '@pixi/utils'; -import { FORMATS, TARGETS, TYPES, SCALE_MODES } from '@pixi/constants'; +import { BaseTextureCache, EventEmitter, isPow2, TextureCache, uid } from '@pixi/utils'; +import { FORMATS, SCALE_MODES, TARGETS, TYPES } from '@pixi/constants'; import Resource from './resources/Resource'; import BufferResource from './resources/BufferResource'; @@ -311,7 +311,7 @@ * * @param {PIXI.SCALE_MODES} [scaleMode] - Pixi scalemode * @param {PIXI.MIPMAP_MODES} [mipmap] - enable mipmaps - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setStyle(scaleMode, mipmap) { @@ -343,7 +343,7 @@ * @param {number} width Visual width * @param {number} height Visual height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setSize(width, height, resolution) { @@ -362,7 +362,7 @@ * @param {number} realWidth Full rendered width * @param {number} realHeight Full rendered height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setRealSize(realWidth, realHeight, resolution) { @@ -389,7 +389,7 @@ * Changes resolution * * @param {number} [resolution] res - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResolution(resolution) { @@ -418,7 +418,7 @@ * Sets the resource if it wasn't set. Throws error if resource already present * * @param {PIXI.resources.Resource} resource - that is managing this BaseTexture - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResource(resource) { diff --git a/packages/core/src/textures/TextureSystem.js b/packages/core/src/textures/TextureSystem.js index d0a80bc..6a2da8f 100644 --- a/packages/core/src/textures/TextureSystem.js +++ b/packages/core/src/textures/TextureSystem.js @@ -357,7 +357,7 @@ * * @private * @param {PIXI.BaseTexture} texture - Texture to update - * @param {glTexture} glTexture + * @param {PIXI.GLTexture} glTexture */ setStyle(texture, glTexture) { diff --git a/packages/display/src/Container.js b/packages/display/src/Container.js index ff301ef..b509c7a 100644 --- a/packages/display/src/Container.js +++ b/packages/display/src/Container.js @@ -332,7 +332,7 @@ * * @param {number} [beginIndex=0] - The beginning position. * @param {number} [endIndex=this.children.length] - The ending position. Default value is size of the container. - * @returns {DisplayObject[]} List of removed children + * @returns {PIXI.DisplayObject[]} List of removed children */ removeChildren(beginIndex = 0, endIndex) { diff --git a/packages/mixin-get-global-position/src/index.js b/packages/mixin-get-global-position/src/index.js index 8440288..7a2e51f 100644 --- a/packages/mixin-get-global-position/src/index.js +++ b/packages/mixin-get-global-position/src/index.js @@ -6,11 +6,11 @@ * * @method getGlobalPosition * @memberof PIXI.DisplayObject# - * @param {Point} point - The point to write the global value to. If null a new point will be returned - * @param {boolean} skipUpdate - Setting to true will stop the transforms of the scene graph from + * @param {PIXI.Point} [point=new PIXI.Point()] - The point to write the global value to. + * @param {boolean} [skipUpdate=false] - Setting to true will stop the transforms of the scene graph from * being updated. This means the calculation returned MAY be out of date BUT will give you a * nice performance boost. - * @return {Point} The updated point. + * @return {PIXI.Point} The updated point. */ DisplayObject.prototype.getGlobalPosition = function getGlobalPosition(point = new Point(), skipUpdate = false) { diff --git a/packages/particles/src/ParticleContainer.js b/packages/particles/src/ParticleContainer.js index 5e37746..936424f 100644 --- a/packages/particles/src/ParticleContainer.js +++ b/packages/particles/src/ParticleContainer.js @@ -142,7 +142,7 @@ * The texture used to render the children. * * @readonly - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ this.baseTexture = null; diff --git a/packages/sprite-tiling/src/TilingSpriteRenderer.js b/packages/sprite-tiling/src/TilingSpriteRenderer.js index dca7270..fc29dc3 100644 --- a/packages/sprite-tiling/src/TilingSpriteRenderer.js +++ b/packages/sprite-tiling/src/TilingSpriteRenderer.js @@ -21,7 +21,7 @@ /** * constructor for renderer * - * @param {Renderer} renderer The renderer this tiling awesomeness works for. + * @param {PIXI.Renderer} renderer The renderer this tiling awesomeness works for. */ constructor(renderer) { diff --git a/packages/accessibility/src/AccessibilityManager.js b/packages/accessibility/src/AccessibilityManager.js index f3bf230..eefb65e 100644 --- a/packages/accessibility/src/AccessibilityManager.js +++ b/packages/accessibility/src/AccessibilityManager.js @@ -357,7 +357,7 @@ /** * Adjust the hit area based on the bounds of a display object * - * @param {Rectangle} hitArea - Bounds of the child + * @param {PIXI.Rectangle} hitArea - Bounds of the child */ capHitArea(hitArea) { @@ -388,7 +388,7 @@ * Adds a DisplayObject to the accessibility manager * * @private - * @param {DisplayObject} displayObject - The child to make accessible. + * @param {PIXI.DisplayObject} displayObject - The child to make accessible. */ addChild(displayObject) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index bfe1d4a..dc0248f 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -12,7 +12,7 @@ * * ```js * let renderer = PIXI.autoDetectRenderer(); - * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 800, height: 600 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * let sprite = PIXI.Sprite.from("spinObj_01.png"); * @@ -31,7 +31,7 @@ * * sprite.setTransform() * - * let baseRenderTexture = new PIXI.BaseRenderTexture(100, 100); + * let baseRenderTexture = new PIXI.BaseRenderTexture({ width: 100, height: 100 }); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); * * renderer.render(sprite, renderTexture); // Renders to center of RenderTexture diff --git a/packages/core/src/renderTexture/RenderTexture.js b/packages/core/src/renderTexture/RenderTexture.js index c3c1ddb..14e319f 100644 --- a/packages/core/src/renderTexture/RenderTexture.js +++ b/packages/core/src/renderTexture/RenderTexture.js @@ -41,7 +41,7 @@ export default class RenderTexture extends Texture { /** - * @param {PIXI.BaseRenderTexture} baseRenderTexture - The renderer used for this RenderTexture + * @param {PIXI.BaseRenderTexture} baseRenderTexture - The base texture object that this texture uses * @param {PIXI.Rectangle} [frame] - The rectangle frame of the texture to show */ constructor(baseRenderTexture, frame) @@ -74,7 +74,7 @@ /** * The base texture object that this texture uses * - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ super(baseRenderTexture, frame); @@ -95,10 +95,10 @@ this.filterFrame = null; /** - * The key for pooled texture of FilterSystem - * @protected - * @member {string} - */ + * The key for pooled texture of FilterSystem + * @protected + * @member {string} + */ this.filterPoolKey = null; this.updateUvs(); diff --git a/packages/core/src/textures/BaseTexture.js b/packages/core/src/textures/BaseTexture.js index e986bad..4958121 100644 --- a/packages/core/src/textures/BaseTexture.js +++ b/packages/core/src/textures/BaseTexture.js @@ -1,5 +1,5 @@ -import { uid, BaseTextureCache, TextureCache, isPow2, EventEmitter } from '@pixi/utils'; -import { FORMATS, TARGETS, TYPES, SCALE_MODES } from '@pixi/constants'; +import { BaseTextureCache, EventEmitter, isPow2, TextureCache, uid } from '@pixi/utils'; +import { FORMATS, SCALE_MODES, TARGETS, TYPES } from '@pixi/constants'; import Resource from './resources/Resource'; import BufferResource from './resources/BufferResource'; @@ -311,7 +311,7 @@ * * @param {PIXI.SCALE_MODES} [scaleMode] - Pixi scalemode * @param {PIXI.MIPMAP_MODES} [mipmap] - enable mipmaps - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setStyle(scaleMode, mipmap) { @@ -343,7 +343,7 @@ * @param {number} width Visual width * @param {number} height Visual height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setSize(width, height, resolution) { @@ -362,7 +362,7 @@ * @param {number} realWidth Full rendered width * @param {number} realHeight Full rendered height * @param {number} [resolution] Optionally set resolution - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setRealSize(realWidth, realHeight, resolution) { @@ -389,7 +389,7 @@ * Changes resolution * * @param {number} [resolution] res - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResolution(resolution) { @@ -418,7 +418,7 @@ * Sets the resource if it wasn't set. Throws error if resource already present * * @param {PIXI.resources.Resource} resource - that is managing this BaseTexture - * @returns {BaseTexture} this + * @returns {PIXI.BaseTexture} this */ setResource(resource) { diff --git a/packages/core/src/textures/TextureSystem.js b/packages/core/src/textures/TextureSystem.js index d0a80bc..6a2da8f 100644 --- a/packages/core/src/textures/TextureSystem.js +++ b/packages/core/src/textures/TextureSystem.js @@ -357,7 +357,7 @@ * * @private * @param {PIXI.BaseTexture} texture - Texture to update - * @param {glTexture} glTexture + * @param {PIXI.GLTexture} glTexture */ setStyle(texture, glTexture) { diff --git a/packages/display/src/Container.js b/packages/display/src/Container.js index ff301ef..b509c7a 100644 --- a/packages/display/src/Container.js +++ b/packages/display/src/Container.js @@ -332,7 +332,7 @@ * * @param {number} [beginIndex=0] - The beginning position. * @param {number} [endIndex=this.children.length] - The ending position. Default value is size of the container. - * @returns {DisplayObject[]} List of removed children + * @returns {PIXI.DisplayObject[]} List of removed children */ removeChildren(beginIndex = 0, endIndex) { diff --git a/packages/mixin-get-global-position/src/index.js b/packages/mixin-get-global-position/src/index.js index 8440288..7a2e51f 100644 --- a/packages/mixin-get-global-position/src/index.js +++ b/packages/mixin-get-global-position/src/index.js @@ -6,11 +6,11 @@ * * @method getGlobalPosition * @memberof PIXI.DisplayObject# - * @param {Point} point - The point to write the global value to. If null a new point will be returned - * @param {boolean} skipUpdate - Setting to true will stop the transforms of the scene graph from + * @param {PIXI.Point} [point=new PIXI.Point()] - The point to write the global value to. + * @param {boolean} [skipUpdate=false] - Setting to true will stop the transforms of the scene graph from * being updated. This means the calculation returned MAY be out of date BUT will give you a * nice performance boost. - * @return {Point} The updated point. + * @return {PIXI.Point} The updated point. */ DisplayObject.prototype.getGlobalPosition = function getGlobalPosition(point = new Point(), skipUpdate = false) { diff --git a/packages/particles/src/ParticleContainer.js b/packages/particles/src/ParticleContainer.js index 5e37746..936424f 100644 --- a/packages/particles/src/ParticleContainer.js +++ b/packages/particles/src/ParticleContainer.js @@ -142,7 +142,7 @@ * The texture used to render the children. * * @readonly - * @member {BaseTexture} + * @member {PIXI.BaseTexture} */ this.baseTexture = null; diff --git a/packages/sprite-tiling/src/TilingSpriteRenderer.js b/packages/sprite-tiling/src/TilingSpriteRenderer.js index dca7270..fc29dc3 100644 --- a/packages/sprite-tiling/src/TilingSpriteRenderer.js +++ b/packages/sprite-tiling/src/TilingSpriteRenderer.js @@ -21,7 +21,7 @@ /** * constructor for renderer * - * @param {Renderer} renderer The renderer this tiling awesomeness works for. + * @param {PIXI.Renderer} renderer The renderer this tiling awesomeness works for. */ constructor(renderer) { diff --git a/packages/text/src/Text.js b/packages/text/src/Text.js index 0b352ce..e86b682 100644 --- a/packages/text/src/Text.js +++ b/packages/text/src/Text.js @@ -367,8 +367,8 @@ /** * Gets the local bounds of the text object. * - * @param {Rectangle} rect - The output rectangle. - * @return {Rectangle} The bounds. + * @param {PIXI.Rectangle} rect - The output rectangle. + * @return {PIXI.Rectangle} The bounds. */ getLocalBounds(rect) {