diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/packages/mesh-extras/test/SimplePlane.js b/packages/mesh-extras/test/SimplePlane.js new file mode 100644 index 0000000..148cd4a --- /dev/null +++ b/packages/mesh-extras/test/SimplePlane.js @@ -0,0 +1,55 @@ +const { SimplePlane } = require('../'); +const { skipHello } = require('@pixi/utils'); +const { Loader } = require('@pixi/loaders'); +const { Point } = require('@pixi/math'); +const { RenderTexture, Texture } = require('@pixi/core'); + +skipHello(); + +// TODO: fix with webglrenderer +describe('PIXI.SimplePlane', function () +{ + it('should create a plane from an external image', function (done) + { + const loader = new Loader(); + + loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) + .load(function (loader, resources) + { + const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + done(); + }); + }); + + it('should create a new empty textured SimplePlane', function () + { + const plane = new SimplePlane(Texture.EMPTY, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + }); + + describe('containsPoint', function () + { + it('should return true when point inside', function () + { + const point = new Point(10, 10); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.true; + }); + + it('should return false when point outside', function () + { + const point = new Point(100, 100); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.false; + }); + }); +}); diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/packages/mesh-extras/test/SimplePlane.js b/packages/mesh-extras/test/SimplePlane.js new file mode 100644 index 0000000..148cd4a --- /dev/null +++ b/packages/mesh-extras/test/SimplePlane.js @@ -0,0 +1,55 @@ +const { SimplePlane } = require('../'); +const { skipHello } = require('@pixi/utils'); +const { Loader } = require('@pixi/loaders'); +const { Point } = require('@pixi/math'); +const { RenderTexture, Texture } = require('@pixi/core'); + +skipHello(); + +// TODO: fix with webglrenderer +describe('PIXI.SimplePlane', function () +{ + it('should create a plane from an external image', function (done) + { + const loader = new Loader(); + + loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) + .load(function (loader, resources) + { + const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + done(); + }); + }); + + it('should create a new empty textured SimplePlane', function () + { + const plane = new SimplePlane(Texture.EMPTY, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + }); + + describe('containsPoint', function () + { + it('should return true when point inside', function () + { + const point = new Point(10, 10); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.true; + }); + + it('should return false when point outside', function () + { + const point = new Point(100, 100); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.false; + }); + }); +}); diff --git a/packages/mesh-extras/test/index.js b/packages/mesh-extras/test/index.js index d767624..ec021e8 100644 --- a/packages/mesh-extras/test/index.js +++ b/packages/mesh-extras/test/index.js @@ -1 +1 @@ -require('./Plane'); +require('./SimplePlane'); diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/packages/mesh-extras/test/SimplePlane.js b/packages/mesh-extras/test/SimplePlane.js new file mode 100644 index 0000000..148cd4a --- /dev/null +++ b/packages/mesh-extras/test/SimplePlane.js @@ -0,0 +1,55 @@ +const { SimplePlane } = require('../'); +const { skipHello } = require('@pixi/utils'); +const { Loader } = require('@pixi/loaders'); +const { Point } = require('@pixi/math'); +const { RenderTexture, Texture } = require('@pixi/core'); + +skipHello(); + +// TODO: fix with webglrenderer +describe('PIXI.SimplePlane', function () +{ + it('should create a plane from an external image', function (done) + { + const loader = new Loader(); + + loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) + .load(function (loader, resources) + { + const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + done(); + }); + }); + + it('should create a new empty textured SimplePlane', function () + { + const plane = new SimplePlane(Texture.EMPTY, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + }); + + describe('containsPoint', function () + { + it('should return true when point inside', function () + { + const point = new Point(10, 10); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.true; + }); + + it('should return false when point outside', function () + { + const point = new Point(100, 100); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.false; + }); + }); +}); diff --git a/packages/mesh-extras/test/index.js b/packages/mesh-extras/test/index.js index d767624..ec021e8 100644 --- a/packages/mesh-extras/test/index.js +++ b/packages/mesh-extras/test/index.js @@ -1 +1 @@ -require('./Plane'); +require('./SimplePlane'); diff --git a/packages/prepare/src/BasePrepare.js b/packages/prepare/src/BasePrepare.js index d375485..0e07703 100644 --- a/packages/prepare/src/BasePrepare.js +++ b/packages/prepare/src/BasePrepare.js @@ -9,7 +9,7 @@ * The prepare manager provides functionality to upload content to the GPU. * * BasePrepare handles basic queuing functionality and is extended by - * {@link PIXI.prepare.WebGLPrepare} and {@link PIXI.prepare.CanvasPrepare} + * {@link PIXI.prepare.Prepare} and {@link PIXI.prepare.CanvasPrepare} * to provide preparation capabilities specific to their respective renderers. * * @example @@ -49,7 +49,7 @@ this.renderer = renderer; /** - * The only real difference between CanvasPrepare and WebGLPrepare is what they pass + * The only real difference between CanvasPrepare and Prepare is what they pass * to upload hooks. That different parameter is stored here. * @type {PIXI.prepare.CanvasPrepare|PIXI.Renderer} * @protected diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/packages/mesh-extras/test/SimplePlane.js b/packages/mesh-extras/test/SimplePlane.js new file mode 100644 index 0000000..148cd4a --- /dev/null +++ b/packages/mesh-extras/test/SimplePlane.js @@ -0,0 +1,55 @@ +const { SimplePlane } = require('../'); +const { skipHello } = require('@pixi/utils'); +const { Loader } = require('@pixi/loaders'); +const { Point } = require('@pixi/math'); +const { RenderTexture, Texture } = require('@pixi/core'); + +skipHello(); + +// TODO: fix with webglrenderer +describe('PIXI.SimplePlane', function () +{ + it('should create a plane from an external image', function (done) + { + const loader = new Loader(); + + loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) + .load(function (loader, resources) + { + const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + done(); + }); + }); + + it('should create a new empty textured SimplePlane', function () + { + const plane = new SimplePlane(Texture.EMPTY, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + }); + + describe('containsPoint', function () + { + it('should return true when point inside', function () + { + const point = new Point(10, 10); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.true; + }); + + it('should return false when point outside', function () + { + const point = new Point(100, 100); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.false; + }); + }); +}); diff --git a/packages/mesh-extras/test/index.js b/packages/mesh-extras/test/index.js index d767624..ec021e8 100644 --- a/packages/mesh-extras/test/index.js +++ b/packages/mesh-extras/test/index.js @@ -1 +1 @@ -require('./Plane'); +require('./SimplePlane'); diff --git a/packages/prepare/src/BasePrepare.js b/packages/prepare/src/BasePrepare.js index d375485..0e07703 100644 --- a/packages/prepare/src/BasePrepare.js +++ b/packages/prepare/src/BasePrepare.js @@ -9,7 +9,7 @@ * The prepare manager provides functionality to upload content to the GPU. * * BasePrepare handles basic queuing functionality and is extended by - * {@link PIXI.prepare.WebGLPrepare} and {@link PIXI.prepare.CanvasPrepare} + * {@link PIXI.prepare.Prepare} and {@link PIXI.prepare.CanvasPrepare} * to provide preparation capabilities specific to their respective renderers. * * @example @@ -49,7 +49,7 @@ this.renderer = renderer; /** - * The only real difference between CanvasPrepare and WebGLPrepare is what they pass + * The only real difference between CanvasPrepare and Prepare is what they pass * to upload hooks. That different parameter is stored here. * @type {PIXI.prepare.CanvasPrepare|PIXI.Renderer} * @protected diff --git a/packages/settings/src/settings.js b/packages/settings/src/settings.js index 57ed219..ba20829 100644 --- a/packages/settings/src/settings.js +++ b/packages/settings/src/settings.js @@ -89,7 +89,7 @@ * @property {number} resolution=1 * @property {boolean} antialias=false * @property {boolean} forceFXAA=false - * @property {boolean} autoResize=false + * @property {boolean} autoDensity=false * @property {boolean} transparent=false * @property {number} backgroundColor=0x000000 * @property {boolean} clearBeforeRender=true @@ -102,7 +102,7 @@ view: null, antialias: false, forceFXAA: false, - autoResize: false, + autoDensity: false, transparent: false, backgroundColor: 0x000000, clearBeforeRender: true, diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/packages/mesh-extras/test/SimplePlane.js b/packages/mesh-extras/test/SimplePlane.js new file mode 100644 index 0000000..148cd4a --- /dev/null +++ b/packages/mesh-extras/test/SimplePlane.js @@ -0,0 +1,55 @@ +const { SimplePlane } = require('../'); +const { skipHello } = require('@pixi/utils'); +const { Loader } = require('@pixi/loaders'); +const { Point } = require('@pixi/math'); +const { RenderTexture, Texture } = require('@pixi/core'); + +skipHello(); + +// TODO: fix with webglrenderer +describe('PIXI.SimplePlane', function () +{ + it('should create a plane from an external image', function (done) + { + const loader = new Loader(); + + loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) + .load(function (loader, resources) + { + const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + done(); + }); + }); + + it('should create a new empty textured SimplePlane', function () + { + const plane = new SimplePlane(Texture.EMPTY, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + }); + + describe('containsPoint', function () + { + it('should return true when point inside', function () + { + const point = new Point(10, 10); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.true; + }); + + it('should return false when point outside', function () + { + const point = new Point(100, 100); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.false; + }); + }); +}); diff --git a/packages/mesh-extras/test/index.js b/packages/mesh-extras/test/index.js index d767624..ec021e8 100644 --- a/packages/mesh-extras/test/index.js +++ b/packages/mesh-extras/test/index.js @@ -1 +1 @@ -require('./Plane'); +require('./SimplePlane'); diff --git a/packages/prepare/src/BasePrepare.js b/packages/prepare/src/BasePrepare.js index d375485..0e07703 100644 --- a/packages/prepare/src/BasePrepare.js +++ b/packages/prepare/src/BasePrepare.js @@ -9,7 +9,7 @@ * The prepare manager provides functionality to upload content to the GPU. * * BasePrepare handles basic queuing functionality and is extended by - * {@link PIXI.prepare.WebGLPrepare} and {@link PIXI.prepare.CanvasPrepare} + * {@link PIXI.prepare.Prepare} and {@link PIXI.prepare.CanvasPrepare} * to provide preparation capabilities specific to their respective renderers. * * @example @@ -49,7 +49,7 @@ this.renderer = renderer; /** - * The only real difference between CanvasPrepare and WebGLPrepare is what they pass + * The only real difference between CanvasPrepare and Prepare is what they pass * to upload hooks. That different parameter is stored here. * @type {PIXI.prepare.CanvasPrepare|PIXI.Renderer} * @protected diff --git a/packages/settings/src/settings.js b/packages/settings/src/settings.js index 57ed219..ba20829 100644 --- a/packages/settings/src/settings.js +++ b/packages/settings/src/settings.js @@ -89,7 +89,7 @@ * @property {number} resolution=1 * @property {boolean} antialias=false * @property {boolean} forceFXAA=false - * @property {boolean} autoResize=false + * @property {boolean} autoDensity=false * @property {boolean} transparent=false * @property {number} backgroundColor=0x000000 * @property {boolean} clearBeforeRender=true @@ -102,7 +102,7 @@ view: null, antialias: false, forceFXAA: false, - autoResize: false, + autoDensity: false, transparent: false, backgroundColor: 0x000000, clearBeforeRender: true, diff --git a/packages/sprite-animated/src/AnimatedSprite.js b/packages/sprite-animated/src/AnimatedSprite.js index 4f44a06..5adaba2 100644 --- a/packages/sprite-animated/src/AnimatedSprite.js +++ b/packages/sprite-animated/src/AnimatedSprite.js @@ -22,10 +22,10 @@ * containing the animation definitions: * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * animatedSprite = new PIXI.AnimatedSprite(sheet.animations["image_sequence"]); * ... * } @@ -99,14 +99,14 @@ this.updateAnchor = false; /** - * Function to call when a AnimatedSprite finishes playing. + * Function to call when an AnimatedSprite finishes playing. * * @member {Function} */ this.onComplete = null; /** - * Function to call when a AnimatedSprite changes which texture is being rendered. + * Function to call when an AnimatedSprite changes which texture is being rendered. * * @member {Function} */ @@ -331,10 +331,10 @@ } /** - * A short hand way of creating a movieclip from an array of frame ids. + * A short hand way of creating an AnimatedSprite from an array of frame ids. * * @static - * @param {string[]} frames - The array of frames ids the movieclip will use as its texture frames. + * @param {string[]} frames - The array of frames ids the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animated sprite with the specified frames. */ static fromFrames(frames) @@ -350,10 +350,10 @@ } /** - * A short hand way of creating a movieclip from an array of image ids. + * A short hand way of creating an AnimatedSprite from an array of image ids. * * @static - * @param {string[]} images - The array of image urls the movieclip will use as its texture frames. + * @param {string[]} images - The array of image urls the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animate sprite with the specified images as frames. */ static fromImages(images) diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/packages/mesh-extras/test/SimplePlane.js b/packages/mesh-extras/test/SimplePlane.js new file mode 100644 index 0000000..148cd4a --- /dev/null +++ b/packages/mesh-extras/test/SimplePlane.js @@ -0,0 +1,55 @@ +const { SimplePlane } = require('../'); +const { skipHello } = require('@pixi/utils'); +const { Loader } = require('@pixi/loaders'); +const { Point } = require('@pixi/math'); +const { RenderTexture, Texture } = require('@pixi/core'); + +skipHello(); + +// TODO: fix with webglrenderer +describe('PIXI.SimplePlane', function () +{ + it('should create a plane from an external image', function (done) + { + const loader = new Loader(); + + loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) + .load(function (loader, resources) + { + const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + done(); + }); + }); + + it('should create a new empty textured SimplePlane', function () + { + const plane = new SimplePlane(Texture.EMPTY, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + }); + + describe('containsPoint', function () + { + it('should return true when point inside', function () + { + const point = new Point(10, 10); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.true; + }); + + it('should return false when point outside', function () + { + const point = new Point(100, 100); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.false; + }); + }); +}); diff --git a/packages/mesh-extras/test/index.js b/packages/mesh-extras/test/index.js index d767624..ec021e8 100644 --- a/packages/mesh-extras/test/index.js +++ b/packages/mesh-extras/test/index.js @@ -1 +1 @@ -require('./Plane'); +require('./SimplePlane'); diff --git a/packages/prepare/src/BasePrepare.js b/packages/prepare/src/BasePrepare.js index d375485..0e07703 100644 --- a/packages/prepare/src/BasePrepare.js +++ b/packages/prepare/src/BasePrepare.js @@ -9,7 +9,7 @@ * The prepare manager provides functionality to upload content to the GPU. * * BasePrepare handles basic queuing functionality and is extended by - * {@link PIXI.prepare.WebGLPrepare} and {@link PIXI.prepare.CanvasPrepare} + * {@link PIXI.prepare.Prepare} and {@link PIXI.prepare.CanvasPrepare} * to provide preparation capabilities specific to their respective renderers. * * @example @@ -49,7 +49,7 @@ this.renderer = renderer; /** - * The only real difference between CanvasPrepare and WebGLPrepare is what they pass + * The only real difference between CanvasPrepare and Prepare is what they pass * to upload hooks. That different parameter is stored here. * @type {PIXI.prepare.CanvasPrepare|PIXI.Renderer} * @protected diff --git a/packages/settings/src/settings.js b/packages/settings/src/settings.js index 57ed219..ba20829 100644 --- a/packages/settings/src/settings.js +++ b/packages/settings/src/settings.js @@ -89,7 +89,7 @@ * @property {number} resolution=1 * @property {boolean} antialias=false * @property {boolean} forceFXAA=false - * @property {boolean} autoResize=false + * @property {boolean} autoDensity=false * @property {boolean} transparent=false * @property {number} backgroundColor=0x000000 * @property {boolean} clearBeforeRender=true @@ -102,7 +102,7 @@ view: null, antialias: false, forceFXAA: false, - autoResize: false, + autoDensity: false, transparent: false, backgroundColor: 0x000000, clearBeforeRender: true, diff --git a/packages/sprite-animated/src/AnimatedSprite.js b/packages/sprite-animated/src/AnimatedSprite.js index 4f44a06..5adaba2 100644 --- a/packages/sprite-animated/src/AnimatedSprite.js +++ b/packages/sprite-animated/src/AnimatedSprite.js @@ -22,10 +22,10 @@ * containing the animation definitions: * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * animatedSprite = new PIXI.AnimatedSprite(sheet.animations["image_sequence"]); * ... * } @@ -99,14 +99,14 @@ this.updateAnchor = false; /** - * Function to call when a AnimatedSprite finishes playing. + * Function to call when an AnimatedSprite finishes playing. * * @member {Function} */ this.onComplete = null; /** - * Function to call when a AnimatedSprite changes which texture is being rendered. + * Function to call when an AnimatedSprite changes which texture is being rendered. * * @member {Function} */ @@ -331,10 +331,10 @@ } /** - * A short hand way of creating a movieclip from an array of frame ids. + * A short hand way of creating an AnimatedSprite from an array of frame ids. * * @static - * @param {string[]} frames - The array of frames ids the movieclip will use as its texture frames. + * @param {string[]} frames - The array of frames ids the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animated sprite with the specified frames. */ static fromFrames(frames) @@ -350,10 +350,10 @@ } /** - * A short hand way of creating a movieclip from an array of image ids. + * A short hand way of creating an AnimatedSprite from an array of image ids. * * @static - * @param {string[]} images - The array of image urls the movieclip will use as its texture frames. + * @param {string[]} images - The array of image urls the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animate sprite with the specified images as frames. */ static fromImages(images) diff --git a/packages/sprite/src/Sprite.js b/packages/sprite/src/Sprite.js index 683fe10..cef065e 100644 --- a/packages/sprite/src/Sprite.js +++ b/packages/sprite/src/Sprite.js @@ -21,10 +21,10 @@ * as swapping base textures when rendering to the screen is inefficient. * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * let sprite = new PIXI.Sprite(sheet.textures["image.png"]); * ... * } diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/packages/mesh-extras/test/SimplePlane.js b/packages/mesh-extras/test/SimplePlane.js new file mode 100644 index 0000000..148cd4a --- /dev/null +++ b/packages/mesh-extras/test/SimplePlane.js @@ -0,0 +1,55 @@ +const { SimplePlane } = require('../'); +const { skipHello } = require('@pixi/utils'); +const { Loader } = require('@pixi/loaders'); +const { Point } = require('@pixi/math'); +const { RenderTexture, Texture } = require('@pixi/core'); + +skipHello(); + +// TODO: fix with webglrenderer +describe('PIXI.SimplePlane', function () +{ + it('should create a plane from an external image', function (done) + { + const loader = new Loader(); + + loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) + .load(function (loader, resources) + { + const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + done(); + }); + }); + + it('should create a new empty textured SimplePlane', function () + { + const plane = new SimplePlane(Texture.EMPTY, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + }); + + describe('containsPoint', function () + { + it('should return true when point inside', function () + { + const point = new Point(10, 10); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.true; + }); + + it('should return false when point outside', function () + { + const point = new Point(100, 100); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.false; + }); + }); +}); diff --git a/packages/mesh-extras/test/index.js b/packages/mesh-extras/test/index.js index d767624..ec021e8 100644 --- a/packages/mesh-extras/test/index.js +++ b/packages/mesh-extras/test/index.js @@ -1 +1 @@ -require('./Plane'); +require('./SimplePlane'); diff --git a/packages/prepare/src/BasePrepare.js b/packages/prepare/src/BasePrepare.js index d375485..0e07703 100644 --- a/packages/prepare/src/BasePrepare.js +++ b/packages/prepare/src/BasePrepare.js @@ -9,7 +9,7 @@ * The prepare manager provides functionality to upload content to the GPU. * * BasePrepare handles basic queuing functionality and is extended by - * {@link PIXI.prepare.WebGLPrepare} and {@link PIXI.prepare.CanvasPrepare} + * {@link PIXI.prepare.Prepare} and {@link PIXI.prepare.CanvasPrepare} * to provide preparation capabilities specific to their respective renderers. * * @example @@ -49,7 +49,7 @@ this.renderer = renderer; /** - * The only real difference between CanvasPrepare and WebGLPrepare is what they pass + * The only real difference between CanvasPrepare and Prepare is what they pass * to upload hooks. That different parameter is stored here. * @type {PIXI.prepare.CanvasPrepare|PIXI.Renderer} * @protected diff --git a/packages/settings/src/settings.js b/packages/settings/src/settings.js index 57ed219..ba20829 100644 --- a/packages/settings/src/settings.js +++ b/packages/settings/src/settings.js @@ -89,7 +89,7 @@ * @property {number} resolution=1 * @property {boolean} antialias=false * @property {boolean} forceFXAA=false - * @property {boolean} autoResize=false + * @property {boolean} autoDensity=false * @property {boolean} transparent=false * @property {number} backgroundColor=0x000000 * @property {boolean} clearBeforeRender=true @@ -102,7 +102,7 @@ view: null, antialias: false, forceFXAA: false, - autoResize: false, + autoDensity: false, transparent: false, backgroundColor: 0x000000, clearBeforeRender: true, diff --git a/packages/sprite-animated/src/AnimatedSprite.js b/packages/sprite-animated/src/AnimatedSprite.js index 4f44a06..5adaba2 100644 --- a/packages/sprite-animated/src/AnimatedSprite.js +++ b/packages/sprite-animated/src/AnimatedSprite.js @@ -22,10 +22,10 @@ * containing the animation definitions: * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * animatedSprite = new PIXI.AnimatedSprite(sheet.animations["image_sequence"]); * ... * } @@ -99,14 +99,14 @@ this.updateAnchor = false; /** - * Function to call when a AnimatedSprite finishes playing. + * Function to call when an AnimatedSprite finishes playing. * * @member {Function} */ this.onComplete = null; /** - * Function to call when a AnimatedSprite changes which texture is being rendered. + * Function to call when an AnimatedSprite changes which texture is being rendered. * * @member {Function} */ @@ -331,10 +331,10 @@ } /** - * A short hand way of creating a movieclip from an array of frame ids. + * A short hand way of creating an AnimatedSprite from an array of frame ids. * * @static - * @param {string[]} frames - The array of frames ids the movieclip will use as its texture frames. + * @param {string[]} frames - The array of frames ids the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animated sprite with the specified frames. */ static fromFrames(frames) @@ -350,10 +350,10 @@ } /** - * A short hand way of creating a movieclip from an array of image ids. + * A short hand way of creating an AnimatedSprite from an array of image ids. * * @static - * @param {string[]} images - The array of image urls the movieclip will use as its texture frames. + * @param {string[]} images - The array of image urls the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animate sprite with the specified images as frames. */ static fromImages(images) diff --git a/packages/sprite/src/Sprite.js b/packages/sprite/src/Sprite.js index 683fe10..cef065e 100644 --- a/packages/sprite/src/Sprite.js +++ b/packages/sprite/src/Sprite.js @@ -21,10 +21,10 @@ * as swapping base textures when rendering to the screen is inefficient. * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * let sprite = new PIXI.Sprite(sheet.textures["image.png"]); * ... * } diff --git a/packages/spritesheet/src/Spritesheet.js b/packages/spritesheet/src/Spritesheet.js index 7c83c8b..bf020db 100644 --- a/packages/spritesheet/src/Spritesheet.js +++ b/packages/spritesheet/src/Spritesheet.js @@ -9,10 +9,10 @@ * To access a sprite sheet from your code pass its JSON data file to Pixi's loader: * * ```js - * PIXI.loader.add("images/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("images/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["images/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["images/spritesheet.json"].spritesheet; * ... * } * ``` @@ -244,7 +244,7 @@ data.anchor ); - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'from' and 'fromLoader' functions Texture.addToCache(this.textures[i], i); } diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/packages/mesh-extras/test/SimplePlane.js b/packages/mesh-extras/test/SimplePlane.js new file mode 100644 index 0000000..148cd4a --- /dev/null +++ b/packages/mesh-extras/test/SimplePlane.js @@ -0,0 +1,55 @@ +const { SimplePlane } = require('../'); +const { skipHello } = require('@pixi/utils'); +const { Loader } = require('@pixi/loaders'); +const { Point } = require('@pixi/math'); +const { RenderTexture, Texture } = require('@pixi/core'); + +skipHello(); + +// TODO: fix with webglrenderer +describe('PIXI.SimplePlane', function () +{ + it('should create a plane from an external image', function (done) + { + const loader = new Loader(); + + loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) + .load(function (loader, resources) + { + const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + done(); + }); + }); + + it('should create a new empty textured SimplePlane', function () + { + const plane = new SimplePlane(Texture.EMPTY, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + }); + + describe('containsPoint', function () + { + it('should return true when point inside', function () + { + const point = new Point(10, 10); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.true; + }); + + it('should return false when point outside', function () + { + const point = new Point(100, 100); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.false; + }); + }); +}); diff --git a/packages/mesh-extras/test/index.js b/packages/mesh-extras/test/index.js index d767624..ec021e8 100644 --- a/packages/mesh-extras/test/index.js +++ b/packages/mesh-extras/test/index.js @@ -1 +1 @@ -require('./Plane'); +require('./SimplePlane'); diff --git a/packages/prepare/src/BasePrepare.js b/packages/prepare/src/BasePrepare.js index d375485..0e07703 100644 --- a/packages/prepare/src/BasePrepare.js +++ b/packages/prepare/src/BasePrepare.js @@ -9,7 +9,7 @@ * The prepare manager provides functionality to upload content to the GPU. * * BasePrepare handles basic queuing functionality and is extended by - * {@link PIXI.prepare.WebGLPrepare} and {@link PIXI.prepare.CanvasPrepare} + * {@link PIXI.prepare.Prepare} and {@link PIXI.prepare.CanvasPrepare} * to provide preparation capabilities specific to their respective renderers. * * @example @@ -49,7 +49,7 @@ this.renderer = renderer; /** - * The only real difference between CanvasPrepare and WebGLPrepare is what they pass + * The only real difference between CanvasPrepare and Prepare is what they pass * to upload hooks. That different parameter is stored here. * @type {PIXI.prepare.CanvasPrepare|PIXI.Renderer} * @protected diff --git a/packages/settings/src/settings.js b/packages/settings/src/settings.js index 57ed219..ba20829 100644 --- a/packages/settings/src/settings.js +++ b/packages/settings/src/settings.js @@ -89,7 +89,7 @@ * @property {number} resolution=1 * @property {boolean} antialias=false * @property {boolean} forceFXAA=false - * @property {boolean} autoResize=false + * @property {boolean} autoDensity=false * @property {boolean} transparent=false * @property {number} backgroundColor=0x000000 * @property {boolean} clearBeforeRender=true @@ -102,7 +102,7 @@ view: null, antialias: false, forceFXAA: false, - autoResize: false, + autoDensity: false, transparent: false, backgroundColor: 0x000000, clearBeforeRender: true, diff --git a/packages/sprite-animated/src/AnimatedSprite.js b/packages/sprite-animated/src/AnimatedSprite.js index 4f44a06..5adaba2 100644 --- a/packages/sprite-animated/src/AnimatedSprite.js +++ b/packages/sprite-animated/src/AnimatedSprite.js @@ -22,10 +22,10 @@ * containing the animation definitions: * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * animatedSprite = new PIXI.AnimatedSprite(sheet.animations["image_sequence"]); * ... * } @@ -99,14 +99,14 @@ this.updateAnchor = false; /** - * Function to call when a AnimatedSprite finishes playing. + * Function to call when an AnimatedSprite finishes playing. * * @member {Function} */ this.onComplete = null; /** - * Function to call when a AnimatedSprite changes which texture is being rendered. + * Function to call when an AnimatedSprite changes which texture is being rendered. * * @member {Function} */ @@ -331,10 +331,10 @@ } /** - * A short hand way of creating a movieclip from an array of frame ids. + * A short hand way of creating an AnimatedSprite from an array of frame ids. * * @static - * @param {string[]} frames - The array of frames ids the movieclip will use as its texture frames. + * @param {string[]} frames - The array of frames ids the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animated sprite with the specified frames. */ static fromFrames(frames) @@ -350,10 +350,10 @@ } /** - * A short hand way of creating a movieclip from an array of image ids. + * A short hand way of creating an AnimatedSprite from an array of image ids. * * @static - * @param {string[]} images - The array of image urls the movieclip will use as its texture frames. + * @param {string[]} images - The array of image urls the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animate sprite with the specified images as frames. */ static fromImages(images) diff --git a/packages/sprite/src/Sprite.js b/packages/sprite/src/Sprite.js index 683fe10..cef065e 100644 --- a/packages/sprite/src/Sprite.js +++ b/packages/sprite/src/Sprite.js @@ -21,10 +21,10 @@ * as swapping base textures when rendering to the screen is inefficient. * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * let sprite = new PIXI.Sprite(sheet.textures["image.png"]); * ... * } diff --git a/packages/spritesheet/src/Spritesheet.js b/packages/spritesheet/src/Spritesheet.js index 7c83c8b..bf020db 100644 --- a/packages/spritesheet/src/Spritesheet.js +++ b/packages/spritesheet/src/Spritesheet.js @@ -9,10 +9,10 @@ * To access a sprite sheet from your code pass its JSON data file to Pixi's loader: * * ```js - * PIXI.loader.add("images/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("images/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["images/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["images/spritesheet.json"].spritesheet; * ... * } * ``` @@ -244,7 +244,7 @@ data.anchor ); - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'from' and 'fromLoader' functions Texture.addToCache(this.textures[i], i); } diff --git a/packages/spritesheet/test/SpritesheetLoader.js b/packages/spritesheet/test/SpritesheetLoader.js index 932064c..d7c729e 100644 --- a/packages/spritesheet/test/SpritesheetLoader.js +++ b/packages/spritesheet/test/SpritesheetLoader.js @@ -95,7 +95,7 @@ const loader = new Loader(); // provide a mock pre-loader that creates an empty base texture for compressed texture assets - // this is necessary because the spritesheetParser expects a baseTexture on the resource + // this is necessary because the SpriteSheetLoader expects a baseTexture on the resource loader.pre((resource, next) => { if (resource.extension === 'crn') diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/packages/mesh-extras/test/SimplePlane.js b/packages/mesh-extras/test/SimplePlane.js new file mode 100644 index 0000000..148cd4a --- /dev/null +++ b/packages/mesh-extras/test/SimplePlane.js @@ -0,0 +1,55 @@ +const { SimplePlane } = require('../'); +const { skipHello } = require('@pixi/utils'); +const { Loader } = require('@pixi/loaders'); +const { Point } = require('@pixi/math'); +const { RenderTexture, Texture } = require('@pixi/core'); + +skipHello(); + +// TODO: fix with webglrenderer +describe('PIXI.SimplePlane', function () +{ + it('should create a plane from an external image', function (done) + { + const loader = new Loader(); + + loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) + .load(function (loader, resources) + { + const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + done(); + }); + }); + + it('should create a new empty textured SimplePlane', function () + { + const plane = new SimplePlane(Texture.EMPTY, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + }); + + describe('containsPoint', function () + { + it('should return true when point inside', function () + { + const point = new Point(10, 10); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.true; + }); + + it('should return false when point outside', function () + { + const point = new Point(100, 100); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.false; + }); + }); +}); diff --git a/packages/mesh-extras/test/index.js b/packages/mesh-extras/test/index.js index d767624..ec021e8 100644 --- a/packages/mesh-extras/test/index.js +++ b/packages/mesh-extras/test/index.js @@ -1 +1 @@ -require('./Plane'); +require('./SimplePlane'); diff --git a/packages/prepare/src/BasePrepare.js b/packages/prepare/src/BasePrepare.js index d375485..0e07703 100644 --- a/packages/prepare/src/BasePrepare.js +++ b/packages/prepare/src/BasePrepare.js @@ -9,7 +9,7 @@ * The prepare manager provides functionality to upload content to the GPU. * * BasePrepare handles basic queuing functionality and is extended by - * {@link PIXI.prepare.WebGLPrepare} and {@link PIXI.prepare.CanvasPrepare} + * {@link PIXI.prepare.Prepare} and {@link PIXI.prepare.CanvasPrepare} * to provide preparation capabilities specific to their respective renderers. * * @example @@ -49,7 +49,7 @@ this.renderer = renderer; /** - * The only real difference between CanvasPrepare and WebGLPrepare is what they pass + * The only real difference between CanvasPrepare and Prepare is what they pass * to upload hooks. That different parameter is stored here. * @type {PIXI.prepare.CanvasPrepare|PIXI.Renderer} * @protected diff --git a/packages/settings/src/settings.js b/packages/settings/src/settings.js index 57ed219..ba20829 100644 --- a/packages/settings/src/settings.js +++ b/packages/settings/src/settings.js @@ -89,7 +89,7 @@ * @property {number} resolution=1 * @property {boolean} antialias=false * @property {boolean} forceFXAA=false - * @property {boolean} autoResize=false + * @property {boolean} autoDensity=false * @property {boolean} transparent=false * @property {number} backgroundColor=0x000000 * @property {boolean} clearBeforeRender=true @@ -102,7 +102,7 @@ view: null, antialias: false, forceFXAA: false, - autoResize: false, + autoDensity: false, transparent: false, backgroundColor: 0x000000, clearBeforeRender: true, diff --git a/packages/sprite-animated/src/AnimatedSprite.js b/packages/sprite-animated/src/AnimatedSprite.js index 4f44a06..5adaba2 100644 --- a/packages/sprite-animated/src/AnimatedSprite.js +++ b/packages/sprite-animated/src/AnimatedSprite.js @@ -22,10 +22,10 @@ * containing the animation definitions: * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * animatedSprite = new PIXI.AnimatedSprite(sheet.animations["image_sequence"]); * ... * } @@ -99,14 +99,14 @@ this.updateAnchor = false; /** - * Function to call when a AnimatedSprite finishes playing. + * Function to call when an AnimatedSprite finishes playing. * * @member {Function} */ this.onComplete = null; /** - * Function to call when a AnimatedSprite changes which texture is being rendered. + * Function to call when an AnimatedSprite changes which texture is being rendered. * * @member {Function} */ @@ -331,10 +331,10 @@ } /** - * A short hand way of creating a movieclip from an array of frame ids. + * A short hand way of creating an AnimatedSprite from an array of frame ids. * * @static - * @param {string[]} frames - The array of frames ids the movieclip will use as its texture frames. + * @param {string[]} frames - The array of frames ids the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animated sprite with the specified frames. */ static fromFrames(frames) @@ -350,10 +350,10 @@ } /** - * A short hand way of creating a movieclip from an array of image ids. + * A short hand way of creating an AnimatedSprite from an array of image ids. * * @static - * @param {string[]} images - The array of image urls the movieclip will use as its texture frames. + * @param {string[]} images - The array of image urls the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animate sprite with the specified images as frames. */ static fromImages(images) diff --git a/packages/sprite/src/Sprite.js b/packages/sprite/src/Sprite.js index 683fe10..cef065e 100644 --- a/packages/sprite/src/Sprite.js +++ b/packages/sprite/src/Sprite.js @@ -21,10 +21,10 @@ * as swapping base textures when rendering to the screen is inefficient. * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * let sprite = new PIXI.Sprite(sheet.textures["image.png"]); * ... * } diff --git a/packages/spritesheet/src/Spritesheet.js b/packages/spritesheet/src/Spritesheet.js index 7c83c8b..bf020db 100644 --- a/packages/spritesheet/src/Spritesheet.js +++ b/packages/spritesheet/src/Spritesheet.js @@ -9,10 +9,10 @@ * To access a sprite sheet from your code pass its JSON data file to Pixi's loader: * * ```js - * PIXI.loader.add("images/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("images/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["images/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["images/spritesheet.json"].spritesheet; * ... * } * ``` @@ -244,7 +244,7 @@ data.anchor ); - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'from' and 'fromLoader' functions Texture.addToCache(this.textures[i], i); } diff --git a/packages/spritesheet/test/SpritesheetLoader.js b/packages/spritesheet/test/SpritesheetLoader.js index 932064c..d7c729e 100644 --- a/packages/spritesheet/test/SpritesheetLoader.js +++ b/packages/spritesheet/test/SpritesheetLoader.js @@ -95,7 +95,7 @@ const loader = new Loader(); // provide a mock pre-loader that creates an empty base texture for compressed texture assets - // this is necessary because the spritesheetParser expects a baseTexture on the resource + // this is necessary because the SpriteSheetLoader expects a baseTexture on the resource loader.pre((resource, next) => { if (resource.extension === 'crn') diff --git a/packages/ticker/src/Ticker.js b/packages/ticker/src/Ticker.js index c49725e..0211578 100644 --- a/packages/ticker/src/Ticker.js +++ b/packages/ticker/src/Ticker.js @@ -501,7 +501,7 @@ /** * Manages the minimum amount of milliseconds allowed to * elapse between invoking {@link PIXI.Ticker#update}. - * This will effect the measured value of {@link PIXI.ticker.Ticker#FPS}. + * This will effect the measured value of {@link PIXI.Ticker#FPS}. * When setting this property it is clamped to a value between * `1` and `TARGET_FPMS * 1000`. * diff --git a/README.md b/README.md index 50615e3..b2aba98 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.Loader.shared.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js-legacy/README.md b/bundles/pixi.js-legacy/README.md index ab7a0a4..dc25925 100644 --- a/bundles/pixi.js-legacy/README.md +++ b/bundles/pixi.js-legacy/README.md @@ -38,7 +38,7 @@ document.body.appendChild(app.view); // load the texture we need -PIXI.loader.add('bunny', 'bunny.png').load((loader, resources) => { +app.loader.add('bunny', 'bunny.png').load((loader, resources) => { // This creates a texture from a 'bunny.png' image. const bunny = new PIXI.Sprite(resources.bunny.texture); diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js index 33dab51..c71693f 100644 --- a/bundles/pixi.js/src/useDeprecated.js +++ b/bundles/pixi.js/src/useDeprecated.js @@ -26,7 +26,7 @@ SVG_SIZE: { get() { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + deprecation(v5, 'PIXI.utils.SVG_SIZE property has moved to PIXI.resources.SVGResource.SVG_SIZE'); return PIXI.SVGResource.SVG_SIZE; }, @@ -40,7 +40,7 @@ TransformStatic: { get() { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformStatic class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -54,7 +54,7 @@ TransformBase: { get() { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + deprecation(v5, 'PIXI.TransformBase class has been removed, use PIXI.Transform'); return PIXI.Transform; }, @@ -75,7 +75,7 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + deprecation(v5, 'PIXI.TRANSFORM_MODE property has been removed'); return { STATIC: 0, DYNAMIC: 1 }; }, @@ -89,7 +89,7 @@ WebGLRenderer: { get() { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + deprecation(v5, 'PIXI.WebGLRenderer class has moved to PIXI.Renderer'); return PIXI.Renderer; }, @@ -103,7 +103,7 @@ CanvasRenderTarget: { get() { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + deprecation(v5, 'PIXI.CanvasRenderTarget class has moved to PIXI.utils.CanvasRenderTarget'); return PIXI.utils.CanvasRenderTarget; }, @@ -119,7 +119,7 @@ loader: { get() { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + deprecation(v5, 'PIXI.loader instance has moved to PIXI.Loader.shared'); return PIXI.Loader.shared; }, @@ -133,7 +133,7 @@ FilterManager: { get() { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + deprecation(v5, 'PIXI.FilterManager class has moved to PIXI.systems.FilterSystem'); return PIXI.systems.FilterSystem; }, @@ -157,7 +157,7 @@ TilingSprite: { get() { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + deprecation(v5, 'PIXI.extras.TilingSprite class has moved to PIXI.TilingSprite'); return PIXI.TilingSprite; }, @@ -170,7 +170,7 @@ TilingSpriteRenderer: { get() { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer class has moved to PIXI.TilingSpriteRenderer'); return PIXI.TilingSpriteRenderer; }, @@ -183,7 +183,7 @@ AnimatedSprite: { get() { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + deprecation(v5, 'PIXI.extras.AnimatedSprite class has moved to PIXI.AnimatedSprite'); return PIXI.AnimatedSprite; }, @@ -196,7 +196,7 @@ BitmapText: { get() { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + deprecation(v5, 'PIXI.extras.BitmapText class has moved to PIXI.BitmapText'); return PIXI.BitmapText; }, @@ -212,7 +212,7 @@ getSvgSize: { get() { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + deprecation(v5, 'PIXI.utils.getSvgSize function has moved to PIXI.resources.SVGResource.getSize'); return PIXI.SVGResource.getSize; }, @@ -235,7 +235,7 @@ Mesh: { get() { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + deprecation(v5, 'PIXI.mesh.Mesh class has moved to PIXI.SimpleMesh'); return PIXI.SimpleMesh; }, @@ -248,7 +248,7 @@ NineSlicePlane: { get() { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + deprecation(v5, 'PIXI.mesh.NineSlicePlane class has moved to PIXI.NineSlicePlane'); return PIXI.NineSlicePlane; }, @@ -261,7 +261,7 @@ Plane: { get() { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + deprecation(v5, 'PIXI.mesh.Plane class has moved to PIXI.SimplePlane'); return PIXI.SimplePlane; }, @@ -274,7 +274,7 @@ Rope: { get() { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + deprecation(v5, 'PIXI.mesh.Rope class has moved to PIXI.SimpleRope'); return PIXI.SimpleRope; }, @@ -287,7 +287,7 @@ RawMesh: { get() { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + deprecation(v5, 'PIXI.mesh.RawMesh class has moved to PIXI.Mesh'); return PIXI.Mesh; }, @@ -300,7 +300,7 @@ CanvasMeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer class has moved to PIXI.CanvasMeshRenderer'); return PIXI.CanvasMeshRenderer; }, @@ -313,7 +313,7 @@ MeshRenderer: { get() { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + deprecation(v5, 'PIXI.mesh.MeshRenderer class has moved to PIXI.MeshRenderer'); return PIXI.MeshRenderer; }, @@ -337,7 +337,7 @@ ParticleContainer: { get() { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + deprecation(v5, 'PIXI.particles.ParticleContainer class has moved to PIXI.ParticleContainer'); return PIXI.ParticleContainer; }, @@ -350,7 +350,7 @@ ParticleRenderer: { get() { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + deprecation(v5, 'PIXI.particles.ParticleRenderer class has moved to PIXI.ParticleRenderer'); return PIXI.ParticleRenderer; }, @@ -374,7 +374,7 @@ Ticker: { get() { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + deprecation(v5, 'PIXI.ticker.Ticker class has moved to PIXI.Ticker'); return PIXI.Ticker; }, @@ -388,7 +388,7 @@ shared: { get() { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + deprecation(v5, 'PIXI.ticker.shared instance has moved to PIXI.Ticker.shared'); return PIXI.Ticker.shared; }, @@ -411,7 +411,7 @@ Loader: { get() { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + deprecation(v5, 'PIXI.loaders.Loader class has moved to PIXI.Loader'); return PIXI.Loader; }, @@ -424,7 +424,7 @@ Resource: { get() { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + deprecation(v5, 'PIXI.loaders.Resource class has moved to PIXI.LoaderResource'); return PIXI.LoaderResource; }, @@ -437,7 +437,7 @@ bitmapFontParser: { get() { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + deprecation(v5, 'PIXI.loaders.bitmapFontParser function has moved to PIXI.BitmapFontLoader.use'); return PIXI.BitmapFontLoader.use; }, @@ -450,7 +450,7 @@ parseBitmapFontData: { get() { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has moved to PIXI.BitmapFontLoader.parse'); return PIXI.BitmapFontLoader.parse; }, @@ -463,7 +463,7 @@ spritesheetParser: { get() { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + deprecation(v5, 'PIXI.loaders.spritesheetParser function has moved to PIXI.SpritesheetLoader.use'); return PIXI.SpritesheetLoader.use; }, @@ -476,7 +476,7 @@ getResourcePath: { get() { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + deprecation(v5, 'PIXI.loaders.getResourcePath property has moved to PIXI.SpritesheetLoader.getResourcePath'); return PIXI.SpritesheetLoader.getResourcePath; }, @@ -491,7 +491,9 @@ */ PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + deprecation(v5, + 'PIXI.loaders.Loader.addPixiMiddleware function is deprecated, use PIXI.loaders.Loader.registerPlugin' + ); return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); }; @@ -504,7 +506,7 @@ Object.defineProperty(PIXI.extract, 'WebGLExtract', { get() { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.extract.Extract'); return PIXI.extract.Extract; }, @@ -518,7 +520,7 @@ Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { get() { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.prepare.Prepare'); return PIXI.prepare.Prepare; }, @@ -533,7 +535,7 @@ */ PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + deprecation(v5, 'PIXI.Container._renderWebGL method has moved to PIXI.Container._render'); this._render(renderer); }; @@ -546,7 +548,7 @@ */ PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + deprecation(v5, 'PIXI.Container.renderWebGL method has moved to PIXI.Container.render'); this.render(renderer); }; @@ -559,7 +561,7 @@ */ PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + deprecation(v5, 'PIXI.DisplayObject.renderWebGL method has moved to PIXI.DisplayObject.render'); this.render(renderer); }; @@ -572,7 +574,7 @@ */ PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + deprecation(v5, 'PIXI.Container.renderAdvancedWebGL method has moved to PIXI.Container.renderAdvanced'); this.renderAdvanced(renderer); }; @@ -590,13 +592,13 @@ TRANSFORM_MODE: { get() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); return 0; }, set() { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed'); }, }, }); @@ -610,7 +612,7 @@ */ BaseTexture.prototype.loadSource = function loadSource(image) { - deprecation(v5, 'PIXI.BaseTexture#loadSource has been deprecated'); + deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated'); const resource = PIXI.resources.autoDetectResource(image); @@ -631,7 +633,7 @@ hasLoaded: { get() { - deprecation(v5, 'PIXI.BaseTexture#hasLoaded has been removed, used valid.'); + deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid'); return this.valid; }, @@ -646,7 +648,7 @@ imageUrl: { get() { - deprecation(v5, 'PIXI.BaseTexture#imageUrl has been removed, used resource.url.'); + deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use resource.url'); return this.resource && this.resource.url; }, @@ -662,7 +664,7 @@ */ BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -678,7 +680,7 @@ */ BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from'); return BaseTexture.from(canvas, { scaleMode }); }; @@ -692,7 +694,7 @@ */ BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from'); const resourceOptions = { scale, crossorigin }; @@ -706,7 +708,7 @@ */ PIXI.Point.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + deprecation(v5, 'PIXI.Point.copy method has been replaced with PIXI.Point.copyFrom'); return this.copyFrom(p); }; @@ -718,7 +720,7 @@ */ PIXI.ObservablePoint.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + deprecation(v5, 'PIXI.ObservablePoint.copy method has been replaced with PIXI.ObservablePoint.copyFrom'); return this.copyFrom(p); }; @@ -730,7 +732,7 @@ */ PIXI.Rectangle.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + deprecation(v5, 'PIXI.Rectangle.copy method has been replaced with PIXI.Rectangle.copyFrom'); return this.copyFrom(p); }; @@ -742,7 +744,7 @@ */ PIXI.Matrix.prototype.copy = function copy(p) { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + deprecation(v5, 'PIXI.Matrix.copy method has been replaced with PIXI.Matrix.copyTo'); return this.copyTo(p); }; @@ -755,7 +757,9 @@ */ getRenderTarget(clear, resolution) { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture' + ); return this.getFilterTexture(resolution); }, @@ -767,7 +771,10 @@ */ returnRenderTarget(renderTexture) { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + deprecation(v5, + 'PIXI.FilterManager.returnRenderTarget method has been replaced with ' + + 'PIXI.systems.FilterSystem.returnFilterTexture' + ); this.returnFilterTexture(renderTexture); }, @@ -780,7 +787,7 @@ */ calculateScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterSystem#calculateScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, ' + 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead'); const mappedMatrix = outputMatrix.identity(); @@ -800,7 +807,7 @@ */ calculateNormalizedScreenSpaceMatrix(outputMatrix) { - deprecation(v5, 'FilterManager#calculateNormalizedScreenSpaceMatrix is removed, ' + deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, ' + 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.'); const { sourceFrame, destinationFrame } = this.activeState; @@ -827,7 +834,7 @@ sourceFrame: { get() { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + deprecation(v5, 'PIXI.RenderTexture.sourceFrame property has been removed'); return this.filterFrame; }, @@ -841,7 +848,7 @@ size: { get() { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + deprecation(v5, 'PIXI.RenderTexture.size property has been removed'); return this._frame; }, @@ -858,7 +865,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurXFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(true, strength, quality, resolution, kernelSize); } @@ -874,7 +881,7 @@ { constructor(strength, quality, resolution, kernelSize) { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + deprecation(v5, 'PIXI.filters.BlurYFilter class is deprecated, use PIXI.filters.BlurFilterPass'); super(false, strength, quality, resolution, kernelSize); } @@ -893,14 +900,14 @@ { Graphics.prototype.generateCanvasTexture = function generateCanvasTexture() { - deprecation(v5, 'PIXI.Graphics#generateCanvasTexture is only available in "pixi.js-legacy"'); + deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"'); }; } // Use these to deprecate all the Sprite from* methods function spriteFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Sprite.${name} is deprecated, use PIXI.Sprite.from`); + deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`); return Sprite.from(source, { resourceOptions: { @@ -953,7 +960,7 @@ // Use these to deprecate all the Texture from* methods function textureFrom(name, source, crossorigin, scaleMode) { - deprecation(v5, `PIXI.Texture.${name} is deprecated, use PIXI.Texture.from`); + deprecation(v5, `PIXI.Texture.${name} method is deprecated, use PIXI.Texture.from`); return Texture.from(source, { resourceOptions: { @@ -1011,13 +1018,13 @@ Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { get() { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); return this.autoDensity; }, set(value) { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, use autoDensity'); this.autoDensity = value; }, @@ -1035,7 +1042,7 @@ */ mixin() { - deprecation(v5, 'PIXI.utils.mixins.mixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1044,7 +1051,7 @@ */ delayMixin() { - deprecation(v5, 'PIXI.utils.mixins.delayMixin no longer available'); + deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available'); }, /** * @memberof PIXI.utils.mixins @@ -1053,7 +1060,7 @@ */ performMixins() { - deprecation(v5, 'PIXI.utils.mixins.performMixins no longer available'); + deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available'); }, }; } diff --git a/packages/app/src/Application.js b/packages/app/src/Application.js index b780acc..39bbee5 100644 --- a/packages/app/src/Application.js +++ b/packages/app/src/Application.js @@ -48,7 +48,7 @@ * @param {string} [options.powerPreference] - Parameter passed to webgl context, set to "high-performance" * for devices with dual graphics card. **(WebGL only)**. * @param {boolean} [options.sharedTicker=false] - `true` to use PIXI.Ticker.shared, `false` to create new ticker. - * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loaders.shared, `false` to create new Loader. + * @param {boolean} [options.sharedLoader=false] - `true` to use PIXI.Loader.shared, `false` to create new Loader. * @param {Window|HTMLElement} [options.resizeTo] - Element to automatically resize stage to. */ constructor(options) diff --git a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js index 7154fa0..00fbe0f 100644 --- a/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js +++ b/packages/canvas/canvas-mesh/src/CanvasMeshRenderer.js @@ -70,7 +70,7 @@ * Draws the object in Triangle Mesh mode * * @private - * @param {PIXI.RawMesh} mesh - the Mesh to render + * @param {PIXI.Mesh} mesh - the Mesh to render */ _renderTriangleMesh(mesh) { @@ -90,7 +90,7 @@ * Draws the object in triangle mode using canvas * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh */ _renderTriangles(mesh) { @@ -113,7 +113,7 @@ * Draws one of the triangles that from the Mesh * * @private - * @param {PIXI.RawMesh} mesh - the current mesh + * @param {PIXI.Mesh} mesh - the current mesh * @param {number} index0 - the index of the first vertex * @param {number} index1 - the index of the second vertex * @param {number} index2 - the index of the third vertex @@ -231,7 +231,7 @@ * Renders a flat Mesh * * @private - * @param {PIXI.RawMesh} mesh - The Mesh to render + * @param {PIXI.Mesh} mesh - The Mesh to render */ renderMeshFlat(mesh) { diff --git a/packages/core/src/renderTexture/BaseRenderTexture.js b/packages/core/src/renderTexture/BaseRenderTexture.js index 005edb6..bfe1d4a 100644 --- a/packages/core/src/renderTexture/BaseRenderTexture.js +++ b/packages/core/src/renderTexture/BaseRenderTexture.js @@ -14,7 +14,7 @@ * let renderer = PIXI.autoDetectRenderer(); * let baseRenderTexture = new PIXI.BaseRenderTexture(800, 600); * let renderTexture = new PIXI.RenderTexture(baseRenderTexture); - * let sprite = PIXI.Sprite.fromImage("spinObj_01.png"); + * let sprite = PIXI.Sprite.from("spinObj_01.png"); * * sprite.position.x = 800/2; * sprite.position.y = 600/2; diff --git a/packages/core/src/textures/Texture.js b/packages/core/src/textures/Texture.js index 12793a9..97e04da 100644 --- a/packages/core/src/textures/Texture.js +++ b/packages/core/src/textures/Texture.js @@ -374,7 +374,7 @@ name = imageUrl; } - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'fromLoader' function BaseTexture.addToCache(texture.baseTexture, name); Texture.addToCache(texture, name); diff --git a/packages/mesh-extras/package.json b/packages/mesh-extras/package.json index f353b3c..879d18e 100644 --- a/packages/mesh-extras/package.json +++ b/packages/mesh-extras/package.json @@ -4,7 +4,7 @@ "main": "lib/mesh-extras.js", "module": "lib/mesh-extras.es.js", "bundle": "dist/mesh-extras.js", - "description": "Custom Mesh display objects, like Rope and Plane", + "description": "Custom Mesh display objects, like Rope and SimplePlane", "author": "Mat Groves", "contributors": [ "Matt Karl " diff --git a/packages/mesh-extras/src/SimplePlane.js b/packages/mesh-extras/src/SimplePlane.js index 5771e5a..3fb0fe5 100644 --- a/packages/mesh-extras/src/SimplePlane.js +++ b/packages/mesh-extras/src/SimplePlane.js @@ -3,13 +3,13 @@ import PlaneGeometry from './geometry/PlaneGeometry'; /** - * The Plane allows you to draw a texture across several points and then manipulate these points + * The SimplePlane allows you to draw a texture across several points and then manipulate these points * *```js * for (let i = 0; i < 20; i++) { * points.push(new PIXI.Point(i * 50, 0)); * }; - * let Plane = new PIXI.Plane(PIXI.Texture.from("snake.png"), points); + * let SimplePlane = new PIXI.SimplePlane(PIXI.Texture.from("snake.png"), points); * ``` * * @class @@ -20,7 +20,7 @@ export default class SimplePlane extends Mesh { /** - * @param {PIXI.Texture} texture - The texture to use on the Plane. + * @param {PIXI.Texture} texture - The texture to use on the SimplePlane. * @param {number} verticesX - The number of vertices in the x-axis * @param {number} verticesY - The number of vertices in the y-axis */ diff --git a/packages/mesh-extras/test/Plane.js b/packages/mesh-extras/test/Plane.js deleted file mode 100644 index 148cd4a..0000000 --- a/packages/mesh-extras/test/Plane.js +++ /dev/null @@ -1,55 +0,0 @@ -const { SimplePlane } = require('../'); -const { skipHello } = require('@pixi/utils'); -const { Loader } = require('@pixi/loaders'); -const { Point } = require('@pixi/math'); -const { RenderTexture, Texture } = require('@pixi/core'); - -skipHello(); - -// TODO: fix with webglrenderer -describe('PIXI.SimplePlane', function () -{ - it('should create a plane from an external image', function (done) - { - const loader = new Loader(); - - loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) - .load(function (loader, resources) - { - const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - done(); - }); - }); - - it('should create a new empty textured SimplePlane', function () - { - const plane = new SimplePlane(Texture.EMPTY, 100, 100); - - expect(plane.geometry.segWidth).to.equal(100); - expect(plane.geometry.segHeight).to.equal(100); - }); - - describe('containsPoint', function () - { - it('should return true when point inside', function () - { - const point = new Point(10, 10); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.true; - }); - - it('should return false when point outside', function () - { - const point = new Point(100, 100); - const texture = new RenderTexture.create(20, 30); - const plane = new SimplePlane(texture, 100, 100); - - expect(plane.containsPoint(point)).to.be.false; - }); - }); -}); diff --git a/packages/mesh-extras/test/SimplePlane.js b/packages/mesh-extras/test/SimplePlane.js new file mode 100644 index 0000000..148cd4a --- /dev/null +++ b/packages/mesh-extras/test/SimplePlane.js @@ -0,0 +1,55 @@ +const { SimplePlane } = require('../'); +const { skipHello } = require('@pixi/utils'); +const { Loader } = require('@pixi/loaders'); +const { Point } = require('@pixi/math'); +const { RenderTexture, Texture } = require('@pixi/core'); + +skipHello(); + +// TODO: fix with webglrenderer +describe('PIXI.SimplePlane', function () +{ + it('should create a plane from an external image', function (done) + { + const loader = new Loader(); + + loader.add('testBitmap', `file://${__dirname}/resources/bitmap-1.png`) + .load(function (loader, resources) + { + const plane = new SimplePlane(resources.testBitmap.texture, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + done(); + }); + }); + + it('should create a new empty textured SimplePlane', function () + { + const plane = new SimplePlane(Texture.EMPTY, 100, 100); + + expect(plane.geometry.segWidth).to.equal(100); + expect(plane.geometry.segHeight).to.equal(100); + }); + + describe('containsPoint', function () + { + it('should return true when point inside', function () + { + const point = new Point(10, 10); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.true; + }); + + it('should return false when point outside', function () + { + const point = new Point(100, 100); + const texture = new RenderTexture.create(20, 30); + const plane = new SimplePlane(texture, 100, 100); + + expect(plane.containsPoint(point)).to.be.false; + }); + }); +}); diff --git a/packages/mesh-extras/test/index.js b/packages/mesh-extras/test/index.js index d767624..ec021e8 100644 --- a/packages/mesh-extras/test/index.js +++ b/packages/mesh-extras/test/index.js @@ -1 +1 @@ -require('./Plane'); +require('./SimplePlane'); diff --git a/packages/prepare/src/BasePrepare.js b/packages/prepare/src/BasePrepare.js index d375485..0e07703 100644 --- a/packages/prepare/src/BasePrepare.js +++ b/packages/prepare/src/BasePrepare.js @@ -9,7 +9,7 @@ * The prepare manager provides functionality to upload content to the GPU. * * BasePrepare handles basic queuing functionality and is extended by - * {@link PIXI.prepare.WebGLPrepare} and {@link PIXI.prepare.CanvasPrepare} + * {@link PIXI.prepare.Prepare} and {@link PIXI.prepare.CanvasPrepare} * to provide preparation capabilities specific to their respective renderers. * * @example @@ -49,7 +49,7 @@ this.renderer = renderer; /** - * The only real difference between CanvasPrepare and WebGLPrepare is what they pass + * The only real difference between CanvasPrepare and Prepare is what they pass * to upload hooks. That different parameter is stored here. * @type {PIXI.prepare.CanvasPrepare|PIXI.Renderer} * @protected diff --git a/packages/settings/src/settings.js b/packages/settings/src/settings.js index 57ed219..ba20829 100644 --- a/packages/settings/src/settings.js +++ b/packages/settings/src/settings.js @@ -89,7 +89,7 @@ * @property {number} resolution=1 * @property {boolean} antialias=false * @property {boolean} forceFXAA=false - * @property {boolean} autoResize=false + * @property {boolean} autoDensity=false * @property {boolean} transparent=false * @property {number} backgroundColor=0x000000 * @property {boolean} clearBeforeRender=true @@ -102,7 +102,7 @@ view: null, antialias: false, forceFXAA: false, - autoResize: false, + autoDensity: false, transparent: false, backgroundColor: 0x000000, clearBeforeRender: true, diff --git a/packages/sprite-animated/src/AnimatedSprite.js b/packages/sprite-animated/src/AnimatedSprite.js index 4f44a06..5adaba2 100644 --- a/packages/sprite-animated/src/AnimatedSprite.js +++ b/packages/sprite-animated/src/AnimatedSprite.js @@ -22,10 +22,10 @@ * containing the animation definitions: * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * animatedSprite = new PIXI.AnimatedSprite(sheet.animations["image_sequence"]); * ... * } @@ -99,14 +99,14 @@ this.updateAnchor = false; /** - * Function to call when a AnimatedSprite finishes playing. + * Function to call when an AnimatedSprite finishes playing. * * @member {Function} */ this.onComplete = null; /** - * Function to call when a AnimatedSprite changes which texture is being rendered. + * Function to call when an AnimatedSprite changes which texture is being rendered. * * @member {Function} */ @@ -331,10 +331,10 @@ } /** - * A short hand way of creating a movieclip from an array of frame ids. + * A short hand way of creating an AnimatedSprite from an array of frame ids. * * @static - * @param {string[]} frames - The array of frames ids the movieclip will use as its texture frames. + * @param {string[]} frames - The array of frames ids the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animated sprite with the specified frames. */ static fromFrames(frames) @@ -350,10 +350,10 @@ } /** - * A short hand way of creating a movieclip from an array of image ids. + * A short hand way of creating an AnimatedSprite from an array of image ids. * * @static - * @param {string[]} images - The array of image urls the movieclip will use as its texture frames. + * @param {string[]} images - The array of image urls the AnimatedSprite will use as its texture frames. * @return {AnimatedSprite} The new animate sprite with the specified images as frames. */ static fromImages(images) diff --git a/packages/sprite/src/Sprite.js b/packages/sprite/src/Sprite.js index 683fe10..cef065e 100644 --- a/packages/sprite/src/Sprite.js +++ b/packages/sprite/src/Sprite.js @@ -21,10 +21,10 @@ * as swapping base textures when rendering to the screen is inefficient. * * ```js - * PIXI.loader.add("assets/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("assets/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["assets/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["assets/spritesheet.json"].spritesheet; * let sprite = new PIXI.Sprite(sheet.textures["image.png"]); * ... * } diff --git a/packages/spritesheet/src/Spritesheet.js b/packages/spritesheet/src/Spritesheet.js index 7c83c8b..bf020db 100644 --- a/packages/spritesheet/src/Spritesheet.js +++ b/packages/spritesheet/src/Spritesheet.js @@ -9,10 +9,10 @@ * To access a sprite sheet from your code pass its JSON data file to Pixi's loader: * * ```js - * PIXI.loader.add("images/spritesheet.json").load(setup); + * PIXI.Loader.shared.add("images/spritesheet.json").load(setup); * * function setup() { - * let sheet = PIXI.loader.resources["images/spritesheet.json"].spritesheet; + * let sheet = PIXI.Loader.shared.resources["images/spritesheet.json"].spritesheet; * ... * } * ``` @@ -244,7 +244,7 @@ data.anchor ); - // lets also add the frame to pixi's global cache for fromFrame and fromImage functions + // lets also add the frame to pixi's global cache for 'from' and 'fromLoader' functions Texture.addToCache(this.textures[i], i); } diff --git a/packages/spritesheet/test/SpritesheetLoader.js b/packages/spritesheet/test/SpritesheetLoader.js index 932064c..d7c729e 100644 --- a/packages/spritesheet/test/SpritesheetLoader.js +++ b/packages/spritesheet/test/SpritesheetLoader.js @@ -95,7 +95,7 @@ const loader = new Loader(); // provide a mock pre-loader that creates an empty base texture for compressed texture assets - // this is necessary because the spritesheetParser expects a baseTexture on the resource + // this is necessary because the SpriteSheetLoader expects a baseTexture on the resource loader.pre((resource, next) => { if (resource.extension === 'crn') diff --git a/packages/ticker/src/Ticker.js b/packages/ticker/src/Ticker.js index c49725e..0211578 100644 --- a/packages/ticker/src/Ticker.js +++ b/packages/ticker/src/Ticker.js @@ -501,7 +501,7 @@ /** * Manages the minimum amount of milliseconds allowed to * elapse between invoking {@link PIXI.Ticker#update}. - * This will effect the measured value of {@link PIXI.ticker.Ticker#FPS}. + * This will effect the measured value of {@link PIXI.Ticker#FPS}. * When setting this property it is clamped to a value between * `1` and `TARGET_FPMS * 1000`. * diff --git a/tools/integration-tests/test/display/Bounds.js b/tools/integration-tests/test/display/Bounds.js index e74e643..bf87b35 100644 --- a/tools/integration-tests/test/display/Bounds.js +++ b/tools/integration-tests/test/display/Bounds.js @@ -4,7 +4,7 @@ const { Rectangle } = require('@pixi/math'); const { Graphics } = require('@pixi/graphics'); const { Text } = require('@pixi/text'); -// const { Plane } = require('@pixi/mesh'); +// const { SimplePlane } = require('@pixi/mesh-extras'); describe('getBounds', function () { @@ -199,7 +199,7 @@ const texture = RenderTexture.create(10, 10); - const plane = new Plane(texture); + const plane = new SimplePlane(texture); parent.addChild(plane);