diff --git a/bundles/pixi.js-legacy/src/index.js b/bundles/pixi.js-legacy/src/index.js index 6c9d2b8..f71fdb7 100644 --- a/bundles/pixi.js-legacy/src/index.js +++ b/bundles/pixi.js-legacy/src/index.js @@ -1,6 +1,6 @@ import '@pixi/polyfill'; -import { PIXI } from 'pixi.js'; +import { Application, accessibility, interaction, prepare, extract } from 'pixi.js'; import { autoDetectRenderer, CanvasRenderer } from '@pixi/canvas-renderer'; import { CanvasMeshRenderer } from '@pixi/canvas-mesh'; import { CanvasGraphicsRenderer } from '@pixi/canvas-graphics'; @@ -11,28 +11,18 @@ import '@pixi/canvas-particles'; import '@pixi/canvas-display'; -CanvasRenderer.registerPlugin('accessibility', PIXI.accessibility.AccessibilityManager); +CanvasRenderer.registerPlugin('accessibility', accessibility.AccessibilityManager); CanvasRenderer.registerPlugin('extract', canvasExtract.CanvasExtract); CanvasRenderer.registerPlugin('graphics', CanvasGraphicsRenderer); -CanvasRenderer.registerPlugin('interaction', PIXI.interaction.InteractionManager); +CanvasRenderer.registerPlugin('interaction', interaction.InteractionManager); CanvasRenderer.registerPlugin('mesh', CanvasMeshRenderer); CanvasRenderer.registerPlugin('prepare', canvasPrepare.CanvasPrepare); CanvasRenderer.registerPlugin('sprite', CanvasSpriteRenderer); -Object.assign(PIXI.prepare, canvasPrepare); -Object.assign(PIXI.extract, canvasExtract); +Object.assign(prepare, canvasPrepare); +Object.assign(extract, canvasExtract); -PIXI.Application.prototype.createRenderer = autoDetectRenderer; - -// Add to namespace window object for people doing `import 'pixi.js-legacy'` -Object.assign(PIXI, { - autoDetectRenderer, - CanvasRenderer, - CanvasGraphicsRenderer, - CanvasMeshRenderer, - CanvasSpriteRenderer, - CanvasTinter, -}); +Application.prototype.createRenderer = autoDetectRenderer; // Export ES for those importing specifically by name, // e.g., `import {autoDetectRenderer} from 'pixi.js-legacy'` diff --git a/bundles/pixi.js-legacy/src/index.js b/bundles/pixi.js-legacy/src/index.js index 6c9d2b8..f71fdb7 100644 --- a/bundles/pixi.js-legacy/src/index.js +++ b/bundles/pixi.js-legacy/src/index.js @@ -1,6 +1,6 @@ import '@pixi/polyfill'; -import { PIXI } from 'pixi.js'; +import { Application, accessibility, interaction, prepare, extract } from 'pixi.js'; import { autoDetectRenderer, CanvasRenderer } from '@pixi/canvas-renderer'; import { CanvasMeshRenderer } from '@pixi/canvas-mesh'; import { CanvasGraphicsRenderer } from '@pixi/canvas-graphics'; @@ -11,28 +11,18 @@ import '@pixi/canvas-particles'; import '@pixi/canvas-display'; -CanvasRenderer.registerPlugin('accessibility', PIXI.accessibility.AccessibilityManager); +CanvasRenderer.registerPlugin('accessibility', accessibility.AccessibilityManager); CanvasRenderer.registerPlugin('extract', canvasExtract.CanvasExtract); CanvasRenderer.registerPlugin('graphics', CanvasGraphicsRenderer); -CanvasRenderer.registerPlugin('interaction', PIXI.interaction.InteractionManager); +CanvasRenderer.registerPlugin('interaction', interaction.InteractionManager); CanvasRenderer.registerPlugin('mesh', CanvasMeshRenderer); CanvasRenderer.registerPlugin('prepare', canvasPrepare.CanvasPrepare); CanvasRenderer.registerPlugin('sprite', CanvasSpriteRenderer); -Object.assign(PIXI.prepare, canvasPrepare); -Object.assign(PIXI.extract, canvasExtract); +Object.assign(prepare, canvasPrepare); +Object.assign(extract, canvasExtract); -PIXI.Application.prototype.createRenderer = autoDetectRenderer; - -// Add to namespace window object for people doing `import 'pixi.js-legacy'` -Object.assign(PIXI, { - autoDetectRenderer, - CanvasRenderer, - CanvasGraphicsRenderer, - CanvasMeshRenderer, - CanvasSpriteRenderer, - CanvasTinter, -}); +Application.prototype.createRenderer = autoDetectRenderer; // Export ES for those importing specifically by name, // e.g., `import {autoDetectRenderer} from 'pixi.js-legacy'` diff --git a/bundles/pixi.js-legacy/test/index.js b/bundles/pixi.js-legacy/test/index.js index a29651e..15e82dd 100755 --- a/bundles/pixi.js-legacy/test/index.js +++ b/bundles/pixi.js-legacy/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi-legacy'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/bundles/pixi.js-legacy/src/index.js b/bundles/pixi.js-legacy/src/index.js index 6c9d2b8..f71fdb7 100644 --- a/bundles/pixi.js-legacy/src/index.js +++ b/bundles/pixi.js-legacy/src/index.js @@ -1,6 +1,6 @@ import '@pixi/polyfill'; -import { PIXI } from 'pixi.js'; +import { Application, accessibility, interaction, prepare, extract } from 'pixi.js'; import { autoDetectRenderer, CanvasRenderer } from '@pixi/canvas-renderer'; import { CanvasMeshRenderer } from '@pixi/canvas-mesh'; import { CanvasGraphicsRenderer } from '@pixi/canvas-graphics'; @@ -11,28 +11,18 @@ import '@pixi/canvas-particles'; import '@pixi/canvas-display'; -CanvasRenderer.registerPlugin('accessibility', PIXI.accessibility.AccessibilityManager); +CanvasRenderer.registerPlugin('accessibility', accessibility.AccessibilityManager); CanvasRenderer.registerPlugin('extract', canvasExtract.CanvasExtract); CanvasRenderer.registerPlugin('graphics', CanvasGraphicsRenderer); -CanvasRenderer.registerPlugin('interaction', PIXI.interaction.InteractionManager); +CanvasRenderer.registerPlugin('interaction', interaction.InteractionManager); CanvasRenderer.registerPlugin('mesh', CanvasMeshRenderer); CanvasRenderer.registerPlugin('prepare', canvasPrepare.CanvasPrepare); CanvasRenderer.registerPlugin('sprite', CanvasSpriteRenderer); -Object.assign(PIXI.prepare, canvasPrepare); -Object.assign(PIXI.extract, canvasExtract); +Object.assign(prepare, canvasPrepare); +Object.assign(extract, canvasExtract); -PIXI.Application.prototype.createRenderer = autoDetectRenderer; - -// Add to namespace window object for people doing `import 'pixi.js-legacy'` -Object.assign(PIXI, { - autoDetectRenderer, - CanvasRenderer, - CanvasGraphicsRenderer, - CanvasMeshRenderer, - CanvasSpriteRenderer, - CanvasTinter, -}); +Application.prototype.createRenderer = autoDetectRenderer; // Export ES for those importing specifically by name, // e.g., `import {autoDetectRenderer} from 'pixi.js-legacy'` diff --git a/bundles/pixi.js-legacy/test/index.js b/bundles/pixi.js-legacy/test/index.js index a29651e..15e82dd 100755 --- a/bundles/pixi.js-legacy/test/index.js +++ b/bundles/pixi.js-legacy/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi-legacy'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js deleted file mode 100644 index ad04323..0000000 --- a/bundles/pixi.js/src/deprecated.js +++ /dev/null @@ -1,909 +0,0 @@ -import { deprecation } from '@pixi/utils'; - -const v5 = '5.0.0'; - -export default function deprecated(PIXI) -{ - Object.defineProperties(PIXI, { - /** - * @constant {RegExp|string} SVG_SIZE - * @memberof PIXI - * @see PIXI.resources.SVGResource.SVG_SIZE - * @deprecated since 5.0.0 - */ - SVG_SIZE: { - get() - { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); - - return PIXI.SVGResource.SVG_SIZE; - }, - }, - - /** - * @class PIXI.TransformStatic - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformStatic: { - get() - { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * @class PIXI.TransformBase - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformBase: { - get() - { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * Constants that specify the transform type. - * - * @static - * @constant - * @name TRANSFORM_MODE - * @memberof PIXI - * @enum {number} - * @deprecated since 5.0.0 - * @property {number} STATIC - * @property {number} DYNAMIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); - - return { STATIC: 0, DYNAMIC: 1 }; - }, - }, - - /** - * @class PIXI.WebGLRenderer - * @see PIXI.Renderer - * @deprecated since 5.0.0 - */ - WebGLRenderer: { - get() - { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); - - return PIXI.Renderer; - }, - }, - - /** - * @class PIXI.CanvasRenderTarget - * @see PIXI.utils.CanvasRenderTarget - * @deprecated since 5.0.0 - */ - CanvasRenderTarget: { - get() - { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); - - return PIXI.utils.CanvasRenderTarget; - }, - }, - - /** - * @memberof PIXI - * @name loader - * @type {PIXI.Loader} - * @see PIXI.Loader.shared - * @deprecated since 5.0.0 - */ - loader: { - get() - { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); - - return PIXI.Loader.shared; - }, - }, - - /** - * @class PIXI.FilterManager - * @see PIXI.systems.FilterSystem - * @deprecated since 5.0.0 - */ - FilterManager: { - get() - { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); - - return PIXI.systems.FilterManager; - }, - }, - }); - - /** - * This namespace has been removed. All classes previous nested - * under this namespace have been moved to the top-level `PIXI` object. - * @namespace PIXI.extras - * @deprecated since 5.0.0 - */ - PIXI.extras = {}; - - Object.defineProperties(PIXI.extras, { - /** - * @class PIXI.extras.TilingSprite - * @see PIXI.TilingSprite - * @deprecated since 5.0.0 - */ - TilingSprite: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); - - return PIXI.TilingSprite; - }, - }, - /** - * @class PIXI.extras.TilingSpriteRenderer - * @see PIXI.TilingSpriteRenderer - * @deprecated since 5.0.0 - */ - TilingSpriteRenderer: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); - - return PIXI.TilingSpriteRenderer; - }, - }, - /** - * @class PIXI.extras.AnimatedSprite - * @see PIXI.AnimatedSprite - * @deprecated since 5.0.0 - */ - AnimatedSprite: { - get() - { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); - - return PIXI.AnimatedSprite; - }, - }, - /** - * @class PIXI.extras.BitmapText - * @see PIXI.BitmapText - * @deprecated since 5.0.0 - */ - BitmapText: { - get() - { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); - - return PIXI.BitmapText; - }, - }, - }); - - Object.defineProperties(PIXI.utils, { - /** - * @function PIXI.utils.getSvgSize - * @see PIXI.resources.SVGResource.getSize - * @deprecated since 5.0.0 - */ - getSvgSize: { - get() - { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); - - return PIXI.SVGResource.getSize; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.mesh - * @deprecated since 5.0.0 - */ - PIXI.mesh = {}; - - Object.defineProperties(PIXI.mesh, { - /** - * @class PIXI.mesh.Mesh - * @see PIXI.SimpleMesh - * @deprecated since 5.0.0 - */ - Mesh: { - get() - { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); - - return PIXI.SimpleMesh; - }, - }, - /** - * @class PIXI.mesh.NineSlicePlane - * @see PIXI.NineSlicePlane - * @deprecated since 5.0.0 - */ - NineSlicePlane: { - get() - { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); - - return PIXI.NineSlicePlane; - }, - }, - /** - * @class PIXI.mesh.Plane - * @see PIXI.SimplePlane - * @deprecated since 5.0.0 - */ - Plane: { - get() - { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); - - return PIXI.SimplePlane; - }, - }, - /** - * @class PIXI.mesh.Rope - * @see PIXI.SimpleRope - * @deprecated since 5.0.0 - */ - Rope: { - get() - { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); - - return PIXI.SimpleRope; - }, - }, - /** - * @class PIXI.mesh.RawMesh - * @see PIXI.Mesh - * @deprecated since 5.0.0 - */ - RawMesh: { - get() - { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); - - return PIXI.Mesh; - }, - }, - /** - * @class PIXI.mesh.CanvasMeshRenderer - * @see PIXI.CanvasMeshRenderer - * @deprecated since 5.0.0 - */ - CanvasMeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); - - return PIXI.CanvasMeshRenderer; - }, - }, - /** - * @class PIXI.mesh.MeshRenderer - * @see PIXI.MeshRenderer - * @deprecated since 5.0.0 - */ - MeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); - - return PIXI.MeshRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.particles - * @deprecated since 5.0.0 - */ - PIXI.particles = {}; - - Object.defineProperties(PIXI.particles, { - /** - * @class PIXI.particles.ParticleContainer - * @deprecated since 5.0.0 - * @see PIXI.ParticleContainer - */ - ParticleContainer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); - - return PIXI.ParticleContainer; - }, - }, - /** - * @class PIXI.particles.ParticleRenderer - * @deprecated since 5.0.0 - * @see PIXI.ParticleRenderer - */ - ParticleRenderer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); - - return PIXI.ParticleRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.ticker - * @deprecated since 5.0.0 - */ - PIXI.ticker = {}; - - Object.defineProperties(PIXI.ticker, { - /** - * @class PIXI.ticker.Ticker - * @deprecated since 5.0.0 - * @see PIXI.Ticker - */ - Ticker: { - get() - { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); - - return PIXI.Ticker; - }, - }, - /** - * @name PIXI.ticker.shared - * @type {PIXI.Ticker} - * @deprecated since 5.0.0 - * @see PIXI.Ticker.shared - */ - shared: { - get() - { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); - - return PIXI.Ticker.shared; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.loaders - * @deprecated since 5.0.0 - */ - PIXI.loaders = {}; - - Object.defineProperties(PIXI.loaders, { - /** - * @class PIXI.loaders.Loader - * @see PIXI.Loader - * @deprecated since 5.0.0 - */ - Loader: { - get() - { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); - - return PIXI.Loader; - }, - }, - /** - * @class PIXI.loaders.Resource - * @see PIXI.LoaderResource - * @deprecated since 5.0.0 - */ - Resource: { - get() - { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); - - return PIXI.LoaderResource; - }, - }, - /** - * @function PIXI.loaders.bitmapFontParser - * @see PIXI.BitmapFontLoader.use - * @deprecated since 5.0.0 - */ - bitmapFontParser: { - get() - { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); - - return PIXI.BitmapFontLoader.use; - }, - }, - /** - * @function PIXI.loaders.parseBitmapFontData - * @see PIXI.BitmapFontLoader.parse - * @deprecated since 5.0.0 - */ - parseBitmapFontData: { - get() - { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); - - return PIXI.BitmapFontLoader.parse; - }, - }, - /** - * @function PIXI.loaders.spritesheetParser - * @see PIXI.SpritesheetLoader.use - * @deprecated since 5.0.0 - */ - spritesheetParser: { - get() - { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); - - return PIXI.SpritesheetLoader.use; - }, - }, - /** - * @function PIXI.loaders.getResourcePath - * @see PIXI.SpritesheetLoader.getResourcePath - * @deprecated since 5.0.0 - */ - getResourcePath: { - get() - { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); - - return PIXI.SpritesheetLoader.getResourcePath; - }, - }, - }); - - /** - * @function PIXI.loaders.Loader.addPixiMiddleware - * @see PIXI.Loader.registerPlugin - * @deprecated since 5.0.0 - * @param {function} middleware - */ - PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) - { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); - - return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); - }; - - /** - * @class PIXI.extract.WebGLExtract - * @deprecated since 5.0.0 - * @see PIXI.extract.Extract - */ - Object.defineProperty(PIXI.extract, 'WebGLExtract', { - get() - { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); - - return PIXI.extract.Extract; - }, - }); - - /** - * @class PIXI.prepare.WebGLPrepare - * @deprecated since 5.0.0 - * @see PIXI.prepare.Prepare - */ - Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { - get() - { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); - - return PIXI.prepare.Prepare; - }, - }); - - /** - * @method PIXI.Container#_renderWebGL - * @private - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); - - this._render(renderer); - }; - - /** - * @method PIXI.Container#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.DisplayObject#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.DisplayObject#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.Container#renderAdvancedWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#renderAdvanced - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); - - this.renderAdvanced(renderer); - }; - - Object.defineProperties(PIXI.settings, { - /** - * Default transform type. - * - * @static - * @deprecated since 5.0.0 - * @memberof PIXI.settings - * @type {PIXI.TRANSFORM_MODE} - * @default PIXI.TRANSFORM_MODE.STATIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - - return 0; - }, - set() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - }, - }, - }); - - const { BaseTexture } = PIXI; - - /** - * @method fromImage - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method fromCanvas - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) - { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); - - return BaseTexture.from(canvas, { scaleMode }); - }; - - /** - * @method fromSVG - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method PIXI.Point#copy - * @deprecated since 5.0.0 - * @see PIXI.Point#copyFrom - */ - PIXI.Point.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.ObservablePoint#copy - * @deprecated since 5.0.0 - * @see PIXI.ObservablePoint#copyFrom - */ - PIXI.ObservablePoint.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Rectangle#copy - * @deprecated since 5.0.0 - * @see PIXI.Rectangle#copyFrom - */ - PIXI.Rectangle.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Matrix#copy - * @deprecated since 5.0.0 - * @see PIXI.Matrix#copyTo - */ - PIXI.Matrix.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); - - return this.copyTo(p); - }; - - Object.assign(PIXI.systems.FilterSystem.prototype, { - /** - * @method PIXI.FilterManager#getRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#getFilterTexture - */ - getRenderTarget(clear, resolution) - { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); - - return this.getFilterTexture(resolution); - }, - - /** - * @method PIXI.FilterManager#returnRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#returnFilterTexture - */ - returnRenderTarget(renderTexture) - { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); - - this.returnFilterTexture(renderTexture); - }, - }); - - Object.defineProperties(PIXI.RenderTexture.prototype, { - /** - * @name PIXI.RenderTexture#sourceFrame - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - sourceFrame: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); - - return this.filterFrame; - }, - }, - /** - * @name PIXI.RenderTexture#size - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - size: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); - - return this._frame; - }, - }, - }); - - /** - * @class BlurXFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurXFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(true, strength, quality, resolution, kernelSize); - } - } - - /** - * @class BlurYFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurYFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(false, strength, quality, resolution, kernelSize); - } - } - - Object.assign(PIXI.filters, { - BlurXFilter, - BlurYFilter, - }); - - const { Sprite, Texture } = PIXI; - - // 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`); - - return Sprite.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @see PIXI.Sprite.from - * @method PIXI.Sprite.fromImage - * @return {PIXI.Sprite} - */ - Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromSVG - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromCanvas - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromVideo - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromFrame - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); - - // 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`); - - return Texture.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromImage - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromImage = textureFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromSVG - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromCanvas - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromVideo - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromFrame - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); - - /** - * @deprecated since 5.0.0 - * @member {boolean} PIXI.AbstractRenderer#autoResize - * @see PIXI.AbstractRenderer#autoDensity - */ - Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { - get() - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - return this.autoDensity; - }, - set(value) - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - this.autoDensity = value; - }, - }); -} diff --git a/bundles/pixi.js-legacy/src/index.js b/bundles/pixi.js-legacy/src/index.js index 6c9d2b8..f71fdb7 100644 --- a/bundles/pixi.js-legacy/src/index.js +++ b/bundles/pixi.js-legacy/src/index.js @@ -1,6 +1,6 @@ import '@pixi/polyfill'; -import { PIXI } from 'pixi.js'; +import { Application, accessibility, interaction, prepare, extract } from 'pixi.js'; import { autoDetectRenderer, CanvasRenderer } from '@pixi/canvas-renderer'; import { CanvasMeshRenderer } from '@pixi/canvas-mesh'; import { CanvasGraphicsRenderer } from '@pixi/canvas-graphics'; @@ -11,28 +11,18 @@ import '@pixi/canvas-particles'; import '@pixi/canvas-display'; -CanvasRenderer.registerPlugin('accessibility', PIXI.accessibility.AccessibilityManager); +CanvasRenderer.registerPlugin('accessibility', accessibility.AccessibilityManager); CanvasRenderer.registerPlugin('extract', canvasExtract.CanvasExtract); CanvasRenderer.registerPlugin('graphics', CanvasGraphicsRenderer); -CanvasRenderer.registerPlugin('interaction', PIXI.interaction.InteractionManager); +CanvasRenderer.registerPlugin('interaction', interaction.InteractionManager); CanvasRenderer.registerPlugin('mesh', CanvasMeshRenderer); CanvasRenderer.registerPlugin('prepare', canvasPrepare.CanvasPrepare); CanvasRenderer.registerPlugin('sprite', CanvasSpriteRenderer); -Object.assign(PIXI.prepare, canvasPrepare); -Object.assign(PIXI.extract, canvasExtract); +Object.assign(prepare, canvasPrepare); +Object.assign(extract, canvasExtract); -PIXI.Application.prototype.createRenderer = autoDetectRenderer; - -// Add to namespace window object for people doing `import 'pixi.js-legacy'` -Object.assign(PIXI, { - autoDetectRenderer, - CanvasRenderer, - CanvasGraphicsRenderer, - CanvasMeshRenderer, - CanvasSpriteRenderer, - CanvasTinter, -}); +Application.prototype.createRenderer = autoDetectRenderer; // Export ES for those importing specifically by name, // e.g., `import {autoDetectRenderer} from 'pixi.js-legacy'` diff --git a/bundles/pixi.js-legacy/test/index.js b/bundles/pixi.js-legacy/test/index.js index a29651e..15e82dd 100755 --- a/bundles/pixi.js-legacy/test/index.js +++ b/bundles/pixi.js-legacy/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi-legacy'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js deleted file mode 100644 index ad04323..0000000 --- a/bundles/pixi.js/src/deprecated.js +++ /dev/null @@ -1,909 +0,0 @@ -import { deprecation } from '@pixi/utils'; - -const v5 = '5.0.0'; - -export default function deprecated(PIXI) -{ - Object.defineProperties(PIXI, { - /** - * @constant {RegExp|string} SVG_SIZE - * @memberof PIXI - * @see PIXI.resources.SVGResource.SVG_SIZE - * @deprecated since 5.0.0 - */ - SVG_SIZE: { - get() - { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); - - return PIXI.SVGResource.SVG_SIZE; - }, - }, - - /** - * @class PIXI.TransformStatic - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformStatic: { - get() - { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * @class PIXI.TransformBase - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformBase: { - get() - { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * Constants that specify the transform type. - * - * @static - * @constant - * @name TRANSFORM_MODE - * @memberof PIXI - * @enum {number} - * @deprecated since 5.0.0 - * @property {number} STATIC - * @property {number} DYNAMIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); - - return { STATIC: 0, DYNAMIC: 1 }; - }, - }, - - /** - * @class PIXI.WebGLRenderer - * @see PIXI.Renderer - * @deprecated since 5.0.0 - */ - WebGLRenderer: { - get() - { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); - - return PIXI.Renderer; - }, - }, - - /** - * @class PIXI.CanvasRenderTarget - * @see PIXI.utils.CanvasRenderTarget - * @deprecated since 5.0.0 - */ - CanvasRenderTarget: { - get() - { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); - - return PIXI.utils.CanvasRenderTarget; - }, - }, - - /** - * @memberof PIXI - * @name loader - * @type {PIXI.Loader} - * @see PIXI.Loader.shared - * @deprecated since 5.0.0 - */ - loader: { - get() - { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); - - return PIXI.Loader.shared; - }, - }, - - /** - * @class PIXI.FilterManager - * @see PIXI.systems.FilterSystem - * @deprecated since 5.0.0 - */ - FilterManager: { - get() - { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); - - return PIXI.systems.FilterManager; - }, - }, - }); - - /** - * This namespace has been removed. All classes previous nested - * under this namespace have been moved to the top-level `PIXI` object. - * @namespace PIXI.extras - * @deprecated since 5.0.0 - */ - PIXI.extras = {}; - - Object.defineProperties(PIXI.extras, { - /** - * @class PIXI.extras.TilingSprite - * @see PIXI.TilingSprite - * @deprecated since 5.0.0 - */ - TilingSprite: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); - - return PIXI.TilingSprite; - }, - }, - /** - * @class PIXI.extras.TilingSpriteRenderer - * @see PIXI.TilingSpriteRenderer - * @deprecated since 5.0.0 - */ - TilingSpriteRenderer: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); - - return PIXI.TilingSpriteRenderer; - }, - }, - /** - * @class PIXI.extras.AnimatedSprite - * @see PIXI.AnimatedSprite - * @deprecated since 5.0.0 - */ - AnimatedSprite: { - get() - { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); - - return PIXI.AnimatedSprite; - }, - }, - /** - * @class PIXI.extras.BitmapText - * @see PIXI.BitmapText - * @deprecated since 5.0.0 - */ - BitmapText: { - get() - { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); - - return PIXI.BitmapText; - }, - }, - }); - - Object.defineProperties(PIXI.utils, { - /** - * @function PIXI.utils.getSvgSize - * @see PIXI.resources.SVGResource.getSize - * @deprecated since 5.0.0 - */ - getSvgSize: { - get() - { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); - - return PIXI.SVGResource.getSize; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.mesh - * @deprecated since 5.0.0 - */ - PIXI.mesh = {}; - - Object.defineProperties(PIXI.mesh, { - /** - * @class PIXI.mesh.Mesh - * @see PIXI.SimpleMesh - * @deprecated since 5.0.0 - */ - Mesh: { - get() - { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); - - return PIXI.SimpleMesh; - }, - }, - /** - * @class PIXI.mesh.NineSlicePlane - * @see PIXI.NineSlicePlane - * @deprecated since 5.0.0 - */ - NineSlicePlane: { - get() - { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); - - return PIXI.NineSlicePlane; - }, - }, - /** - * @class PIXI.mesh.Plane - * @see PIXI.SimplePlane - * @deprecated since 5.0.0 - */ - Plane: { - get() - { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); - - return PIXI.SimplePlane; - }, - }, - /** - * @class PIXI.mesh.Rope - * @see PIXI.SimpleRope - * @deprecated since 5.0.0 - */ - Rope: { - get() - { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); - - return PIXI.SimpleRope; - }, - }, - /** - * @class PIXI.mesh.RawMesh - * @see PIXI.Mesh - * @deprecated since 5.0.0 - */ - RawMesh: { - get() - { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); - - return PIXI.Mesh; - }, - }, - /** - * @class PIXI.mesh.CanvasMeshRenderer - * @see PIXI.CanvasMeshRenderer - * @deprecated since 5.0.0 - */ - CanvasMeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); - - return PIXI.CanvasMeshRenderer; - }, - }, - /** - * @class PIXI.mesh.MeshRenderer - * @see PIXI.MeshRenderer - * @deprecated since 5.0.0 - */ - MeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); - - return PIXI.MeshRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.particles - * @deprecated since 5.0.0 - */ - PIXI.particles = {}; - - Object.defineProperties(PIXI.particles, { - /** - * @class PIXI.particles.ParticleContainer - * @deprecated since 5.0.0 - * @see PIXI.ParticleContainer - */ - ParticleContainer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); - - return PIXI.ParticleContainer; - }, - }, - /** - * @class PIXI.particles.ParticleRenderer - * @deprecated since 5.0.0 - * @see PIXI.ParticleRenderer - */ - ParticleRenderer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); - - return PIXI.ParticleRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.ticker - * @deprecated since 5.0.0 - */ - PIXI.ticker = {}; - - Object.defineProperties(PIXI.ticker, { - /** - * @class PIXI.ticker.Ticker - * @deprecated since 5.0.0 - * @see PIXI.Ticker - */ - Ticker: { - get() - { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); - - return PIXI.Ticker; - }, - }, - /** - * @name PIXI.ticker.shared - * @type {PIXI.Ticker} - * @deprecated since 5.0.0 - * @see PIXI.Ticker.shared - */ - shared: { - get() - { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); - - return PIXI.Ticker.shared; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.loaders - * @deprecated since 5.0.0 - */ - PIXI.loaders = {}; - - Object.defineProperties(PIXI.loaders, { - /** - * @class PIXI.loaders.Loader - * @see PIXI.Loader - * @deprecated since 5.0.0 - */ - Loader: { - get() - { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); - - return PIXI.Loader; - }, - }, - /** - * @class PIXI.loaders.Resource - * @see PIXI.LoaderResource - * @deprecated since 5.0.0 - */ - Resource: { - get() - { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); - - return PIXI.LoaderResource; - }, - }, - /** - * @function PIXI.loaders.bitmapFontParser - * @see PIXI.BitmapFontLoader.use - * @deprecated since 5.0.0 - */ - bitmapFontParser: { - get() - { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); - - return PIXI.BitmapFontLoader.use; - }, - }, - /** - * @function PIXI.loaders.parseBitmapFontData - * @see PIXI.BitmapFontLoader.parse - * @deprecated since 5.0.0 - */ - parseBitmapFontData: { - get() - { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); - - return PIXI.BitmapFontLoader.parse; - }, - }, - /** - * @function PIXI.loaders.spritesheetParser - * @see PIXI.SpritesheetLoader.use - * @deprecated since 5.0.0 - */ - spritesheetParser: { - get() - { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); - - return PIXI.SpritesheetLoader.use; - }, - }, - /** - * @function PIXI.loaders.getResourcePath - * @see PIXI.SpritesheetLoader.getResourcePath - * @deprecated since 5.0.0 - */ - getResourcePath: { - get() - { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); - - return PIXI.SpritesheetLoader.getResourcePath; - }, - }, - }); - - /** - * @function PIXI.loaders.Loader.addPixiMiddleware - * @see PIXI.Loader.registerPlugin - * @deprecated since 5.0.0 - * @param {function} middleware - */ - PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) - { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); - - return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); - }; - - /** - * @class PIXI.extract.WebGLExtract - * @deprecated since 5.0.0 - * @see PIXI.extract.Extract - */ - Object.defineProperty(PIXI.extract, 'WebGLExtract', { - get() - { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); - - return PIXI.extract.Extract; - }, - }); - - /** - * @class PIXI.prepare.WebGLPrepare - * @deprecated since 5.0.0 - * @see PIXI.prepare.Prepare - */ - Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { - get() - { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); - - return PIXI.prepare.Prepare; - }, - }); - - /** - * @method PIXI.Container#_renderWebGL - * @private - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); - - this._render(renderer); - }; - - /** - * @method PIXI.Container#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.DisplayObject#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.DisplayObject#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.Container#renderAdvancedWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#renderAdvanced - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); - - this.renderAdvanced(renderer); - }; - - Object.defineProperties(PIXI.settings, { - /** - * Default transform type. - * - * @static - * @deprecated since 5.0.0 - * @memberof PIXI.settings - * @type {PIXI.TRANSFORM_MODE} - * @default PIXI.TRANSFORM_MODE.STATIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - - return 0; - }, - set() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - }, - }, - }); - - const { BaseTexture } = PIXI; - - /** - * @method fromImage - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method fromCanvas - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) - { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); - - return BaseTexture.from(canvas, { scaleMode }); - }; - - /** - * @method fromSVG - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method PIXI.Point#copy - * @deprecated since 5.0.0 - * @see PIXI.Point#copyFrom - */ - PIXI.Point.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.ObservablePoint#copy - * @deprecated since 5.0.0 - * @see PIXI.ObservablePoint#copyFrom - */ - PIXI.ObservablePoint.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Rectangle#copy - * @deprecated since 5.0.0 - * @see PIXI.Rectangle#copyFrom - */ - PIXI.Rectangle.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Matrix#copy - * @deprecated since 5.0.0 - * @see PIXI.Matrix#copyTo - */ - PIXI.Matrix.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); - - return this.copyTo(p); - }; - - Object.assign(PIXI.systems.FilterSystem.prototype, { - /** - * @method PIXI.FilterManager#getRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#getFilterTexture - */ - getRenderTarget(clear, resolution) - { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); - - return this.getFilterTexture(resolution); - }, - - /** - * @method PIXI.FilterManager#returnRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#returnFilterTexture - */ - returnRenderTarget(renderTexture) - { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); - - this.returnFilterTexture(renderTexture); - }, - }); - - Object.defineProperties(PIXI.RenderTexture.prototype, { - /** - * @name PIXI.RenderTexture#sourceFrame - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - sourceFrame: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); - - return this.filterFrame; - }, - }, - /** - * @name PIXI.RenderTexture#size - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - size: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); - - return this._frame; - }, - }, - }); - - /** - * @class BlurXFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurXFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(true, strength, quality, resolution, kernelSize); - } - } - - /** - * @class BlurYFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurYFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(false, strength, quality, resolution, kernelSize); - } - } - - Object.assign(PIXI.filters, { - BlurXFilter, - BlurYFilter, - }); - - const { Sprite, Texture } = PIXI; - - // 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`); - - return Sprite.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @see PIXI.Sprite.from - * @method PIXI.Sprite.fromImage - * @return {PIXI.Sprite} - */ - Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromSVG - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromCanvas - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromVideo - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromFrame - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); - - // 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`); - - return Texture.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromImage - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromImage = textureFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromSVG - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromCanvas - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromVideo - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromFrame - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); - - /** - * @deprecated since 5.0.0 - * @member {boolean} PIXI.AbstractRenderer#autoResize - * @see PIXI.AbstractRenderer#autoDensity - */ - Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { - get() - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - return this.autoDensity; - }, - set(value) - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - this.autoDensity = value; - }, - }); -} diff --git a/bundles/pixi.js/src/index.js b/bundles/pixi.js/src/index.js index 9e80f0d..554ef58 100644 --- a/bundles/pixi.js/src/index.js +++ b/bundles/pixi.js/src/index.js @@ -1,26 +1,16 @@ import * as accessibility from '@pixi/accessibility'; -import * as app from '@pixi/app'; -import * as constants from '@pixi/constants'; -import * as core from '@pixi/core'; -import * as display from '@pixi/display'; import * as extract from '@pixi/extract'; -import * as graphics from '@pixi/graphics'; import * as interaction from '@pixi/interaction'; -import * as loaders from '@pixi/loaders'; -import * as math from '@pixi/math'; -import * as mesh from '@pixi/mesh'; -import * as meshExtras from '@pixi/mesh-extras'; -import * as particles from '@pixi/particles'; import * as prepare from '@pixi/prepare'; -import * as sprite from '@pixi/sprite'; -import * as spriteAnimated from '@pixi/sprite-animated'; -import * as spritesheet from '@pixi/spritesheet'; -import * as spriteTiling from '@pixi/sprite-tiling'; -import * as text from '@pixi/text'; -import * as textBitmap from '@pixi/text-bitmap'; -import * as ticker from '@pixi/ticker'; import * as utils from '@pixi/utils'; -import { settings } from '@pixi/settings'; +import { Application } from '@pixi/app'; +import { Renderer, BatchRenderer } from '@pixi/core'; +import { Loader, AppLoaderPlugin } from '@pixi/loaders'; +import { ParticleRenderer } from '@pixi/particles'; +import { SpritesheetLoader } from '@pixi/spritesheet'; +import { TilingSpriteRenderer } from '@pixi/sprite-tiling'; +import { BitmapFontLoader } from '@pixi/text-bitmap'; +import { TickerPlugin } from '@pixi/ticker'; import { AlphaFilter } from '@pixi/filter-alpha'; import { BlurFilter, BlurFilterPass } from '@pixi/filter-blur'; import { ColorMatrixFilter } from '@pixi/filter-color-matrix'; @@ -30,22 +20,26 @@ import '@pixi/mixin-cache-as-bitmap'; import '@pixi/mixin-get-child-by-name'; import '@pixi/mixin-get-global-position'; -import deprecated from './deprecated'; + +// Export deprecations so Rollup can call it +// in the footer after global is defined +// other module must call this manually +import useDeprecated from './useDeprecated'; // Install renderer plugins -core.Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); -core.Renderer.registerPlugin('extract', extract.Extract); -core.Renderer.registerPlugin('interaction', interaction.InteractionManager); -core.Renderer.registerPlugin('particle', particles.ParticleRenderer); -core.Renderer.registerPlugin('prepare', prepare.Prepare); -core.Renderer.registerPlugin('batch', core.BatchRenderer); -core.Renderer.registerPlugin('tilingSprite', spriteTiling.TilingSpriteRenderer); +Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); +Renderer.registerPlugin('extract', extract.Extract); +Renderer.registerPlugin('interaction', interaction.InteractionManager); +Renderer.registerPlugin('particle', ParticleRenderer); +Renderer.registerPlugin('prepare', prepare.Prepare); +Renderer.registerPlugin('batch', BatchRenderer); +Renderer.registerPlugin('tilingSprite', TilingSpriteRenderer); -loaders.Loader.registerPlugin(textBitmap.BitmapFontLoader); -loaders.Loader.registerPlugin(spritesheet.SpritesheetLoader); +Loader.registerPlugin(BitmapFontLoader); +Loader.registerPlugin(SpritesheetLoader); -app.Application.registerPlugin(ticker.TickerPlugin); -app.Application.registerPlugin(loaders.AppLoaderPlugin); +Application.registerPlugin(TickerPlugin); +Application.registerPlugin(AppLoaderPlugin); // Apply deplayed mixins utils.mixins.performMixins(); @@ -59,12 +53,11 @@ * @name VERSION * @type {string} */ -const VERSION = '__VERSION__'; +export const VERSION = '__VERSION__'; /** * @namespace PIXI */ -const PIXI = { VERSION }; /** * This namespace contains WebGL-only display filters that can be applied @@ -93,7 +86,7 @@ * document.body.appendChild(app.view); * @namespace PIXI.filters */ -const filters = { +export const filters = { AlphaFilter, BlurFilter, BlurFilterPass, @@ -103,47 +96,7 @@ NoiseFilter, }; -// Add to namespace window object for people doing `import 'pixi.js'` -if (typeof window !== 'undefined') -{ - const namespaces = { - accessibility, - extract, - filters, - interaction, - prepare, - settings, - utils, - }; - - window.PIXI = Object.assign( - PIXI, - namespaces, - app, - constants, - core, - display, - graphics, - loaders, - math, - mesh, - meshExtras, - particles, - sprite, - spriteAnimated, - spritesheet, - spriteTiling, - text, - textBitmap, - ticker - ); - - // Deprecations only apply to Window object - deprecated(PIXI); -} - // Export ES for those importing specifically by name, -// e.g., `import {autoDetectRenderer} from 'pixi.js'` export * from '@pixi/app'; export * from '@pixi/constants'; export * from '@pixi/core'; @@ -161,14 +114,12 @@ export * from '@pixi/text'; export * from '@pixi/text-bitmap'; export * from '@pixi/ticker'; +export * from '@pixi/settings'; export { - PIXI, - VERSION, accessibility, extract, - filters, interaction, prepare, - settings, utils, + useDeprecated, }; diff --git a/bundles/pixi.js-legacy/src/index.js b/bundles/pixi.js-legacy/src/index.js index 6c9d2b8..f71fdb7 100644 --- a/bundles/pixi.js-legacy/src/index.js +++ b/bundles/pixi.js-legacy/src/index.js @@ -1,6 +1,6 @@ import '@pixi/polyfill'; -import { PIXI } from 'pixi.js'; +import { Application, accessibility, interaction, prepare, extract } from 'pixi.js'; import { autoDetectRenderer, CanvasRenderer } from '@pixi/canvas-renderer'; import { CanvasMeshRenderer } from '@pixi/canvas-mesh'; import { CanvasGraphicsRenderer } from '@pixi/canvas-graphics'; @@ -11,28 +11,18 @@ import '@pixi/canvas-particles'; import '@pixi/canvas-display'; -CanvasRenderer.registerPlugin('accessibility', PIXI.accessibility.AccessibilityManager); +CanvasRenderer.registerPlugin('accessibility', accessibility.AccessibilityManager); CanvasRenderer.registerPlugin('extract', canvasExtract.CanvasExtract); CanvasRenderer.registerPlugin('graphics', CanvasGraphicsRenderer); -CanvasRenderer.registerPlugin('interaction', PIXI.interaction.InteractionManager); +CanvasRenderer.registerPlugin('interaction', interaction.InteractionManager); CanvasRenderer.registerPlugin('mesh', CanvasMeshRenderer); CanvasRenderer.registerPlugin('prepare', canvasPrepare.CanvasPrepare); CanvasRenderer.registerPlugin('sprite', CanvasSpriteRenderer); -Object.assign(PIXI.prepare, canvasPrepare); -Object.assign(PIXI.extract, canvasExtract); +Object.assign(prepare, canvasPrepare); +Object.assign(extract, canvasExtract); -PIXI.Application.prototype.createRenderer = autoDetectRenderer; - -// Add to namespace window object for people doing `import 'pixi.js-legacy'` -Object.assign(PIXI, { - autoDetectRenderer, - CanvasRenderer, - CanvasGraphicsRenderer, - CanvasMeshRenderer, - CanvasSpriteRenderer, - CanvasTinter, -}); +Application.prototype.createRenderer = autoDetectRenderer; // Export ES for those importing specifically by name, // e.g., `import {autoDetectRenderer} from 'pixi.js-legacy'` diff --git a/bundles/pixi.js-legacy/test/index.js b/bundles/pixi.js-legacy/test/index.js index a29651e..15e82dd 100755 --- a/bundles/pixi.js-legacy/test/index.js +++ b/bundles/pixi.js-legacy/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi-legacy'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js deleted file mode 100644 index ad04323..0000000 --- a/bundles/pixi.js/src/deprecated.js +++ /dev/null @@ -1,909 +0,0 @@ -import { deprecation } from '@pixi/utils'; - -const v5 = '5.0.0'; - -export default function deprecated(PIXI) -{ - Object.defineProperties(PIXI, { - /** - * @constant {RegExp|string} SVG_SIZE - * @memberof PIXI - * @see PIXI.resources.SVGResource.SVG_SIZE - * @deprecated since 5.0.0 - */ - SVG_SIZE: { - get() - { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); - - return PIXI.SVGResource.SVG_SIZE; - }, - }, - - /** - * @class PIXI.TransformStatic - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformStatic: { - get() - { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * @class PIXI.TransformBase - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformBase: { - get() - { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * Constants that specify the transform type. - * - * @static - * @constant - * @name TRANSFORM_MODE - * @memberof PIXI - * @enum {number} - * @deprecated since 5.0.0 - * @property {number} STATIC - * @property {number} DYNAMIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); - - return { STATIC: 0, DYNAMIC: 1 }; - }, - }, - - /** - * @class PIXI.WebGLRenderer - * @see PIXI.Renderer - * @deprecated since 5.0.0 - */ - WebGLRenderer: { - get() - { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); - - return PIXI.Renderer; - }, - }, - - /** - * @class PIXI.CanvasRenderTarget - * @see PIXI.utils.CanvasRenderTarget - * @deprecated since 5.0.0 - */ - CanvasRenderTarget: { - get() - { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); - - return PIXI.utils.CanvasRenderTarget; - }, - }, - - /** - * @memberof PIXI - * @name loader - * @type {PIXI.Loader} - * @see PIXI.Loader.shared - * @deprecated since 5.0.0 - */ - loader: { - get() - { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); - - return PIXI.Loader.shared; - }, - }, - - /** - * @class PIXI.FilterManager - * @see PIXI.systems.FilterSystem - * @deprecated since 5.0.0 - */ - FilterManager: { - get() - { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); - - return PIXI.systems.FilterManager; - }, - }, - }); - - /** - * This namespace has been removed. All classes previous nested - * under this namespace have been moved to the top-level `PIXI` object. - * @namespace PIXI.extras - * @deprecated since 5.0.0 - */ - PIXI.extras = {}; - - Object.defineProperties(PIXI.extras, { - /** - * @class PIXI.extras.TilingSprite - * @see PIXI.TilingSprite - * @deprecated since 5.0.0 - */ - TilingSprite: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); - - return PIXI.TilingSprite; - }, - }, - /** - * @class PIXI.extras.TilingSpriteRenderer - * @see PIXI.TilingSpriteRenderer - * @deprecated since 5.0.0 - */ - TilingSpriteRenderer: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); - - return PIXI.TilingSpriteRenderer; - }, - }, - /** - * @class PIXI.extras.AnimatedSprite - * @see PIXI.AnimatedSprite - * @deprecated since 5.0.0 - */ - AnimatedSprite: { - get() - { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); - - return PIXI.AnimatedSprite; - }, - }, - /** - * @class PIXI.extras.BitmapText - * @see PIXI.BitmapText - * @deprecated since 5.0.0 - */ - BitmapText: { - get() - { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); - - return PIXI.BitmapText; - }, - }, - }); - - Object.defineProperties(PIXI.utils, { - /** - * @function PIXI.utils.getSvgSize - * @see PIXI.resources.SVGResource.getSize - * @deprecated since 5.0.0 - */ - getSvgSize: { - get() - { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); - - return PIXI.SVGResource.getSize; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.mesh - * @deprecated since 5.0.0 - */ - PIXI.mesh = {}; - - Object.defineProperties(PIXI.mesh, { - /** - * @class PIXI.mesh.Mesh - * @see PIXI.SimpleMesh - * @deprecated since 5.0.0 - */ - Mesh: { - get() - { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); - - return PIXI.SimpleMesh; - }, - }, - /** - * @class PIXI.mesh.NineSlicePlane - * @see PIXI.NineSlicePlane - * @deprecated since 5.0.0 - */ - NineSlicePlane: { - get() - { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); - - return PIXI.NineSlicePlane; - }, - }, - /** - * @class PIXI.mesh.Plane - * @see PIXI.SimplePlane - * @deprecated since 5.0.0 - */ - Plane: { - get() - { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); - - return PIXI.SimplePlane; - }, - }, - /** - * @class PIXI.mesh.Rope - * @see PIXI.SimpleRope - * @deprecated since 5.0.0 - */ - Rope: { - get() - { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); - - return PIXI.SimpleRope; - }, - }, - /** - * @class PIXI.mesh.RawMesh - * @see PIXI.Mesh - * @deprecated since 5.0.0 - */ - RawMesh: { - get() - { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); - - return PIXI.Mesh; - }, - }, - /** - * @class PIXI.mesh.CanvasMeshRenderer - * @see PIXI.CanvasMeshRenderer - * @deprecated since 5.0.0 - */ - CanvasMeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); - - return PIXI.CanvasMeshRenderer; - }, - }, - /** - * @class PIXI.mesh.MeshRenderer - * @see PIXI.MeshRenderer - * @deprecated since 5.0.0 - */ - MeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); - - return PIXI.MeshRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.particles - * @deprecated since 5.0.0 - */ - PIXI.particles = {}; - - Object.defineProperties(PIXI.particles, { - /** - * @class PIXI.particles.ParticleContainer - * @deprecated since 5.0.0 - * @see PIXI.ParticleContainer - */ - ParticleContainer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); - - return PIXI.ParticleContainer; - }, - }, - /** - * @class PIXI.particles.ParticleRenderer - * @deprecated since 5.0.0 - * @see PIXI.ParticleRenderer - */ - ParticleRenderer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); - - return PIXI.ParticleRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.ticker - * @deprecated since 5.0.0 - */ - PIXI.ticker = {}; - - Object.defineProperties(PIXI.ticker, { - /** - * @class PIXI.ticker.Ticker - * @deprecated since 5.0.0 - * @see PIXI.Ticker - */ - Ticker: { - get() - { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); - - return PIXI.Ticker; - }, - }, - /** - * @name PIXI.ticker.shared - * @type {PIXI.Ticker} - * @deprecated since 5.0.0 - * @see PIXI.Ticker.shared - */ - shared: { - get() - { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); - - return PIXI.Ticker.shared; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.loaders - * @deprecated since 5.0.0 - */ - PIXI.loaders = {}; - - Object.defineProperties(PIXI.loaders, { - /** - * @class PIXI.loaders.Loader - * @see PIXI.Loader - * @deprecated since 5.0.0 - */ - Loader: { - get() - { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); - - return PIXI.Loader; - }, - }, - /** - * @class PIXI.loaders.Resource - * @see PIXI.LoaderResource - * @deprecated since 5.0.0 - */ - Resource: { - get() - { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); - - return PIXI.LoaderResource; - }, - }, - /** - * @function PIXI.loaders.bitmapFontParser - * @see PIXI.BitmapFontLoader.use - * @deprecated since 5.0.0 - */ - bitmapFontParser: { - get() - { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); - - return PIXI.BitmapFontLoader.use; - }, - }, - /** - * @function PIXI.loaders.parseBitmapFontData - * @see PIXI.BitmapFontLoader.parse - * @deprecated since 5.0.0 - */ - parseBitmapFontData: { - get() - { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); - - return PIXI.BitmapFontLoader.parse; - }, - }, - /** - * @function PIXI.loaders.spritesheetParser - * @see PIXI.SpritesheetLoader.use - * @deprecated since 5.0.0 - */ - spritesheetParser: { - get() - { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); - - return PIXI.SpritesheetLoader.use; - }, - }, - /** - * @function PIXI.loaders.getResourcePath - * @see PIXI.SpritesheetLoader.getResourcePath - * @deprecated since 5.0.0 - */ - getResourcePath: { - get() - { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); - - return PIXI.SpritesheetLoader.getResourcePath; - }, - }, - }); - - /** - * @function PIXI.loaders.Loader.addPixiMiddleware - * @see PIXI.Loader.registerPlugin - * @deprecated since 5.0.0 - * @param {function} middleware - */ - PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) - { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); - - return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); - }; - - /** - * @class PIXI.extract.WebGLExtract - * @deprecated since 5.0.0 - * @see PIXI.extract.Extract - */ - Object.defineProperty(PIXI.extract, 'WebGLExtract', { - get() - { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); - - return PIXI.extract.Extract; - }, - }); - - /** - * @class PIXI.prepare.WebGLPrepare - * @deprecated since 5.0.0 - * @see PIXI.prepare.Prepare - */ - Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { - get() - { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); - - return PIXI.prepare.Prepare; - }, - }); - - /** - * @method PIXI.Container#_renderWebGL - * @private - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); - - this._render(renderer); - }; - - /** - * @method PIXI.Container#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.DisplayObject#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.DisplayObject#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.Container#renderAdvancedWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#renderAdvanced - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); - - this.renderAdvanced(renderer); - }; - - Object.defineProperties(PIXI.settings, { - /** - * Default transform type. - * - * @static - * @deprecated since 5.0.0 - * @memberof PIXI.settings - * @type {PIXI.TRANSFORM_MODE} - * @default PIXI.TRANSFORM_MODE.STATIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - - return 0; - }, - set() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - }, - }, - }); - - const { BaseTexture } = PIXI; - - /** - * @method fromImage - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method fromCanvas - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) - { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); - - return BaseTexture.from(canvas, { scaleMode }); - }; - - /** - * @method fromSVG - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method PIXI.Point#copy - * @deprecated since 5.0.0 - * @see PIXI.Point#copyFrom - */ - PIXI.Point.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.ObservablePoint#copy - * @deprecated since 5.0.0 - * @see PIXI.ObservablePoint#copyFrom - */ - PIXI.ObservablePoint.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Rectangle#copy - * @deprecated since 5.0.0 - * @see PIXI.Rectangle#copyFrom - */ - PIXI.Rectangle.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Matrix#copy - * @deprecated since 5.0.0 - * @see PIXI.Matrix#copyTo - */ - PIXI.Matrix.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); - - return this.copyTo(p); - }; - - Object.assign(PIXI.systems.FilterSystem.prototype, { - /** - * @method PIXI.FilterManager#getRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#getFilterTexture - */ - getRenderTarget(clear, resolution) - { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); - - return this.getFilterTexture(resolution); - }, - - /** - * @method PIXI.FilterManager#returnRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#returnFilterTexture - */ - returnRenderTarget(renderTexture) - { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); - - this.returnFilterTexture(renderTexture); - }, - }); - - Object.defineProperties(PIXI.RenderTexture.prototype, { - /** - * @name PIXI.RenderTexture#sourceFrame - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - sourceFrame: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); - - return this.filterFrame; - }, - }, - /** - * @name PIXI.RenderTexture#size - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - size: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); - - return this._frame; - }, - }, - }); - - /** - * @class BlurXFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurXFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(true, strength, quality, resolution, kernelSize); - } - } - - /** - * @class BlurYFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurYFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(false, strength, quality, resolution, kernelSize); - } - } - - Object.assign(PIXI.filters, { - BlurXFilter, - BlurYFilter, - }); - - const { Sprite, Texture } = PIXI; - - // 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`); - - return Sprite.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @see PIXI.Sprite.from - * @method PIXI.Sprite.fromImage - * @return {PIXI.Sprite} - */ - Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromSVG - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromCanvas - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromVideo - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromFrame - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); - - // 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`); - - return Texture.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromImage - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromImage = textureFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromSVG - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromCanvas - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromVideo - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromFrame - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); - - /** - * @deprecated since 5.0.0 - * @member {boolean} PIXI.AbstractRenderer#autoResize - * @see PIXI.AbstractRenderer#autoDensity - */ - Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { - get() - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - return this.autoDensity; - }, - set(value) - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - this.autoDensity = value; - }, - }); -} diff --git a/bundles/pixi.js/src/index.js b/bundles/pixi.js/src/index.js index 9e80f0d..554ef58 100644 --- a/bundles/pixi.js/src/index.js +++ b/bundles/pixi.js/src/index.js @@ -1,26 +1,16 @@ import * as accessibility from '@pixi/accessibility'; -import * as app from '@pixi/app'; -import * as constants from '@pixi/constants'; -import * as core from '@pixi/core'; -import * as display from '@pixi/display'; import * as extract from '@pixi/extract'; -import * as graphics from '@pixi/graphics'; import * as interaction from '@pixi/interaction'; -import * as loaders from '@pixi/loaders'; -import * as math from '@pixi/math'; -import * as mesh from '@pixi/mesh'; -import * as meshExtras from '@pixi/mesh-extras'; -import * as particles from '@pixi/particles'; import * as prepare from '@pixi/prepare'; -import * as sprite from '@pixi/sprite'; -import * as spriteAnimated from '@pixi/sprite-animated'; -import * as spritesheet from '@pixi/spritesheet'; -import * as spriteTiling from '@pixi/sprite-tiling'; -import * as text from '@pixi/text'; -import * as textBitmap from '@pixi/text-bitmap'; -import * as ticker from '@pixi/ticker'; import * as utils from '@pixi/utils'; -import { settings } from '@pixi/settings'; +import { Application } from '@pixi/app'; +import { Renderer, BatchRenderer } from '@pixi/core'; +import { Loader, AppLoaderPlugin } from '@pixi/loaders'; +import { ParticleRenderer } from '@pixi/particles'; +import { SpritesheetLoader } from '@pixi/spritesheet'; +import { TilingSpriteRenderer } from '@pixi/sprite-tiling'; +import { BitmapFontLoader } from '@pixi/text-bitmap'; +import { TickerPlugin } from '@pixi/ticker'; import { AlphaFilter } from '@pixi/filter-alpha'; import { BlurFilter, BlurFilterPass } from '@pixi/filter-blur'; import { ColorMatrixFilter } from '@pixi/filter-color-matrix'; @@ -30,22 +20,26 @@ import '@pixi/mixin-cache-as-bitmap'; import '@pixi/mixin-get-child-by-name'; import '@pixi/mixin-get-global-position'; -import deprecated from './deprecated'; + +// Export deprecations so Rollup can call it +// in the footer after global is defined +// other module must call this manually +import useDeprecated from './useDeprecated'; // Install renderer plugins -core.Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); -core.Renderer.registerPlugin('extract', extract.Extract); -core.Renderer.registerPlugin('interaction', interaction.InteractionManager); -core.Renderer.registerPlugin('particle', particles.ParticleRenderer); -core.Renderer.registerPlugin('prepare', prepare.Prepare); -core.Renderer.registerPlugin('batch', core.BatchRenderer); -core.Renderer.registerPlugin('tilingSprite', spriteTiling.TilingSpriteRenderer); +Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); +Renderer.registerPlugin('extract', extract.Extract); +Renderer.registerPlugin('interaction', interaction.InteractionManager); +Renderer.registerPlugin('particle', ParticleRenderer); +Renderer.registerPlugin('prepare', prepare.Prepare); +Renderer.registerPlugin('batch', BatchRenderer); +Renderer.registerPlugin('tilingSprite', TilingSpriteRenderer); -loaders.Loader.registerPlugin(textBitmap.BitmapFontLoader); -loaders.Loader.registerPlugin(spritesheet.SpritesheetLoader); +Loader.registerPlugin(BitmapFontLoader); +Loader.registerPlugin(SpritesheetLoader); -app.Application.registerPlugin(ticker.TickerPlugin); -app.Application.registerPlugin(loaders.AppLoaderPlugin); +Application.registerPlugin(TickerPlugin); +Application.registerPlugin(AppLoaderPlugin); // Apply deplayed mixins utils.mixins.performMixins(); @@ -59,12 +53,11 @@ * @name VERSION * @type {string} */ -const VERSION = '__VERSION__'; +export const VERSION = '__VERSION__'; /** * @namespace PIXI */ -const PIXI = { VERSION }; /** * This namespace contains WebGL-only display filters that can be applied @@ -93,7 +86,7 @@ * document.body.appendChild(app.view); * @namespace PIXI.filters */ -const filters = { +export const filters = { AlphaFilter, BlurFilter, BlurFilterPass, @@ -103,47 +96,7 @@ NoiseFilter, }; -// Add to namespace window object for people doing `import 'pixi.js'` -if (typeof window !== 'undefined') -{ - const namespaces = { - accessibility, - extract, - filters, - interaction, - prepare, - settings, - utils, - }; - - window.PIXI = Object.assign( - PIXI, - namespaces, - app, - constants, - core, - display, - graphics, - loaders, - math, - mesh, - meshExtras, - particles, - sprite, - spriteAnimated, - spritesheet, - spriteTiling, - text, - textBitmap, - ticker - ); - - // Deprecations only apply to Window object - deprecated(PIXI); -} - // Export ES for those importing specifically by name, -// e.g., `import {autoDetectRenderer} from 'pixi.js'` export * from '@pixi/app'; export * from '@pixi/constants'; export * from '@pixi/core'; @@ -161,14 +114,12 @@ export * from '@pixi/text'; export * from '@pixi/text-bitmap'; export * from '@pixi/ticker'; +export * from '@pixi/settings'; export { - PIXI, - VERSION, accessibility, extract, - filters, interaction, prepare, - settings, utils, + useDeprecated, }; diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js new file mode 100644 index 0000000..4eaba3b --- /dev/null +++ b/bundles/pixi.js/src/useDeprecated.js @@ -0,0 +1,921 @@ +import { deprecation } from '@pixi/utils'; + +const v5 = '5.0.0'; + +/** + * Deprecations (backward compatibilities) are automatically applied for browser bundles + * in the UMD module format. If using Webpack or Rollup, you'll need to apply these + * deprecations manually by doing something like this: + * @example + * import * as PIXI from 'pixi.js'; + * PIXI.useDeprecated(); // MUST be bound to namespace + * @memberof PIXI + * @function useDeprecated + */ +export default function useDeprecated() +{ + const PIXI = this; + + Object.defineProperties(PIXI, { + /** + * @constant {RegExp|string} SVG_SIZE + * @memberof PIXI + * @see PIXI.resources.SVGResource.SVG_SIZE + * @deprecated since 5.0.0 + */ + SVG_SIZE: { + get() + { + deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + + return PIXI.SVGResource.SVG_SIZE; + }, + }, + + /** + * @class PIXI.TransformStatic + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformStatic: { + get() + { + deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * @class PIXI.TransformBase + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformBase: { + get() + { + deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * Constants that specify the transform type. + * + * @static + * @constant + * @name TRANSFORM_MODE + * @memberof PIXI + * @enum {number} + * @deprecated since 5.0.0 + * @property {number} STATIC + * @property {number} DYNAMIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + + return { STATIC: 0, DYNAMIC: 1 }; + }, + }, + + /** + * @class PIXI.WebGLRenderer + * @see PIXI.Renderer + * @deprecated since 5.0.0 + */ + WebGLRenderer: { + get() + { + deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + + return PIXI.Renderer; + }, + }, + + /** + * @class PIXI.CanvasRenderTarget + * @see PIXI.utils.CanvasRenderTarget + * @deprecated since 5.0.0 + */ + CanvasRenderTarget: { + get() + { + deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + + return PIXI.utils.CanvasRenderTarget; + }, + }, + + /** + * @memberof PIXI + * @name loader + * @type {PIXI.Loader} + * @see PIXI.Loader.shared + * @deprecated since 5.0.0 + */ + loader: { + get() + { + deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + + return PIXI.Loader.shared; + }, + }, + + /** + * @class PIXI.FilterManager + * @see PIXI.systems.FilterSystem + * @deprecated since 5.0.0 + */ + FilterManager: { + get() + { + deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + + return PIXI.systems.FilterManager; + }, + }, + }); + + /** + * This namespace has been removed. All classes previous nested + * under this namespace have been moved to the top-level `PIXI` object. + * @namespace PIXI.extras + * @deprecated since 5.0.0 + */ + PIXI.extras = {}; + + Object.defineProperties(PIXI.extras, { + /** + * @class PIXI.extras.TilingSprite + * @see PIXI.TilingSprite + * @deprecated since 5.0.0 + */ + TilingSprite: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + + return PIXI.TilingSprite; + }, + }, + /** + * @class PIXI.extras.TilingSpriteRenderer + * @see PIXI.TilingSpriteRenderer + * @deprecated since 5.0.0 + */ + TilingSpriteRenderer: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + + return PIXI.TilingSpriteRenderer; + }, + }, + /** + * @class PIXI.extras.AnimatedSprite + * @see PIXI.AnimatedSprite + * @deprecated since 5.0.0 + */ + AnimatedSprite: { + get() + { + deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + + return PIXI.AnimatedSprite; + }, + }, + /** + * @class PIXI.extras.BitmapText + * @see PIXI.BitmapText + * @deprecated since 5.0.0 + */ + BitmapText: { + get() + { + deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + + return PIXI.BitmapText; + }, + }, + }); + + Object.defineProperties(PIXI.utils, { + /** + * @function PIXI.utils.getSvgSize + * @see PIXI.resources.SVGResource.getSize + * @deprecated since 5.0.0 + */ + getSvgSize: { + get() + { + deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + + return PIXI.SVGResource.getSize; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.mesh + * @deprecated since 5.0.0 + */ + PIXI.mesh = {}; + + Object.defineProperties(PIXI.mesh, { + /** + * @class PIXI.mesh.Mesh + * @see PIXI.SimpleMesh + * @deprecated since 5.0.0 + */ + Mesh: { + get() + { + deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + + return PIXI.SimpleMesh; + }, + }, + /** + * @class PIXI.mesh.NineSlicePlane + * @see PIXI.NineSlicePlane + * @deprecated since 5.0.0 + */ + NineSlicePlane: { + get() + { + deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + + return PIXI.NineSlicePlane; + }, + }, + /** + * @class PIXI.mesh.Plane + * @see PIXI.SimplePlane + * @deprecated since 5.0.0 + */ + Plane: { + get() + { + deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + + return PIXI.SimplePlane; + }, + }, + /** + * @class PIXI.mesh.Rope + * @see PIXI.SimpleRope + * @deprecated since 5.0.0 + */ + Rope: { + get() + { + deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + + return PIXI.SimpleRope; + }, + }, + /** + * @class PIXI.mesh.RawMesh + * @see PIXI.Mesh + * @deprecated since 5.0.0 + */ + RawMesh: { + get() + { + deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + + return PIXI.Mesh; + }, + }, + /** + * @class PIXI.mesh.CanvasMeshRenderer + * @see PIXI.CanvasMeshRenderer + * @deprecated since 5.0.0 + */ + CanvasMeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + + return PIXI.CanvasMeshRenderer; + }, + }, + /** + * @class PIXI.mesh.MeshRenderer + * @see PIXI.MeshRenderer + * @deprecated since 5.0.0 + */ + MeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + + return PIXI.MeshRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.particles + * @deprecated since 5.0.0 + */ + PIXI.particles = {}; + + Object.defineProperties(PIXI.particles, { + /** + * @class PIXI.particles.ParticleContainer + * @deprecated since 5.0.0 + * @see PIXI.ParticleContainer + */ + ParticleContainer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + + return PIXI.ParticleContainer; + }, + }, + /** + * @class PIXI.particles.ParticleRenderer + * @deprecated since 5.0.0 + * @see PIXI.ParticleRenderer + */ + ParticleRenderer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + + return PIXI.ParticleRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.ticker + * @deprecated since 5.0.0 + */ + PIXI.ticker = {}; + + Object.defineProperties(PIXI.ticker, { + /** + * @class PIXI.ticker.Ticker + * @deprecated since 5.0.0 + * @see PIXI.Ticker + */ + Ticker: { + get() + { + deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + + return PIXI.Ticker; + }, + }, + /** + * @name PIXI.ticker.shared + * @type {PIXI.Ticker} + * @deprecated since 5.0.0 + * @see PIXI.Ticker.shared + */ + shared: { + get() + { + deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + + return PIXI.Ticker.shared; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.loaders + * @deprecated since 5.0.0 + */ + PIXI.loaders = {}; + + Object.defineProperties(PIXI.loaders, { + /** + * @class PIXI.loaders.Loader + * @see PIXI.Loader + * @deprecated since 5.0.0 + */ + Loader: { + get() + { + deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + + return PIXI.Loader; + }, + }, + /** + * @class PIXI.loaders.Resource + * @see PIXI.LoaderResource + * @deprecated since 5.0.0 + */ + Resource: { + get() + { + deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + + return PIXI.LoaderResource; + }, + }, + /** + * @function PIXI.loaders.bitmapFontParser + * @see PIXI.BitmapFontLoader.use + * @deprecated since 5.0.0 + */ + bitmapFontParser: { + get() + { + deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + + return PIXI.BitmapFontLoader.use; + }, + }, + /** + * @function PIXI.loaders.parseBitmapFontData + * @see PIXI.BitmapFontLoader.parse + * @deprecated since 5.0.0 + */ + parseBitmapFontData: { + get() + { + deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + + return PIXI.BitmapFontLoader.parse; + }, + }, + /** + * @function PIXI.loaders.spritesheetParser + * @see PIXI.SpritesheetLoader.use + * @deprecated since 5.0.0 + */ + spritesheetParser: { + get() + { + deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + + return PIXI.SpritesheetLoader.use; + }, + }, + /** + * @function PIXI.loaders.getResourcePath + * @see PIXI.SpritesheetLoader.getResourcePath + * @deprecated since 5.0.0 + */ + getResourcePath: { + get() + { + deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + + return PIXI.SpritesheetLoader.getResourcePath; + }, + }, + }); + + /** + * @function PIXI.loaders.Loader.addPixiMiddleware + * @see PIXI.Loader.registerPlugin + * @deprecated since 5.0.0 + * @param {function} middleware + */ + PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) + { + deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + + return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); + }; + + /** + * @class PIXI.extract.WebGLExtract + * @deprecated since 5.0.0 + * @see PIXI.extract.Extract + */ + Object.defineProperty(PIXI.extract, 'WebGLExtract', { + get() + { + deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + + return PIXI.extract.Extract; + }, + }); + + /** + * @class PIXI.prepare.WebGLPrepare + * @deprecated since 5.0.0 + * @see PIXI.prepare.Prepare + */ + Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { + get() + { + deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + + return PIXI.prepare.Prepare; + }, + }); + + /** + * @method PIXI.Container#_renderWebGL + * @private + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + + this._render(renderer); + }; + + /** + * @method PIXI.Container#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.DisplayObject#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.DisplayObject#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.Container#renderAdvancedWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#renderAdvanced + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + + this.renderAdvanced(renderer); + }; + + Object.defineProperties(PIXI.settings, { + /** + * Default transform type. + * + * @static + * @deprecated since 5.0.0 + * @memberof PIXI.settings + * @type {PIXI.TRANSFORM_MODE} + * @default PIXI.TRANSFORM_MODE.STATIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + + return 0; + }, + set() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + }, + }, + }); + + const { BaseTexture } = PIXI; + + /** + * @method fromImage + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method fromCanvas + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) + { + deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + + return BaseTexture.from(canvas, { scaleMode }); + }; + + /** + * @method fromSVG + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method PIXI.Point#copy + * @deprecated since 5.0.0 + * @see PIXI.Point#copyFrom + */ + PIXI.Point.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.ObservablePoint#copy + * @deprecated since 5.0.0 + * @see PIXI.ObservablePoint#copyFrom + */ + PIXI.ObservablePoint.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Rectangle#copy + * @deprecated since 5.0.0 + * @see PIXI.Rectangle#copyFrom + */ + PIXI.Rectangle.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Matrix#copy + * @deprecated since 5.0.0 + * @see PIXI.Matrix#copyTo + */ + PIXI.Matrix.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + + return this.copyTo(p); + }; + + Object.assign(PIXI.systems.FilterSystem.prototype, { + /** + * @method PIXI.FilterManager#getRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#getFilterTexture + */ + getRenderTarget(clear, resolution) + { + deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + + return this.getFilterTexture(resolution); + }, + + /** + * @method PIXI.FilterManager#returnRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#returnFilterTexture + */ + returnRenderTarget(renderTexture) + { + deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + + this.returnFilterTexture(renderTexture); + }, + }); + + Object.defineProperties(PIXI.RenderTexture.prototype, { + /** + * @name PIXI.RenderTexture#sourceFrame + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + sourceFrame: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + + return this.filterFrame; + }, + }, + /** + * @name PIXI.RenderTexture#size + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + size: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + + return this._frame; + }, + }, + }); + + /** + * @class BlurXFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurXFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(true, strength, quality, resolution, kernelSize); + } + } + + /** + * @class BlurYFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurYFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(false, strength, quality, resolution, kernelSize); + } + } + + Object.assign(PIXI.filters, { + BlurXFilter, + BlurYFilter, + }); + + const { Sprite, Texture } = PIXI; + + // 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`); + + return Sprite.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @see PIXI.Sprite.from + * @method PIXI.Sprite.fromImage + * @return {PIXI.Sprite} + */ + Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromSVG + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromCanvas + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromVideo + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromFrame + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); + + // 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`); + + return Texture.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromImage + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromImage = textureFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromSVG + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromCanvas + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromVideo + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromFrame + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); + + /** + * @deprecated since 5.0.0 + * @member {boolean} PIXI.AbstractRenderer#autoResize + * @see PIXI.AbstractRenderer#autoDensity + */ + Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { + get() + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + return this.autoDensity; + }, + set(value) + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + this.autoDensity = value; + }, + }); +} diff --git a/bundles/pixi.js-legacy/src/index.js b/bundles/pixi.js-legacy/src/index.js index 6c9d2b8..f71fdb7 100644 --- a/bundles/pixi.js-legacy/src/index.js +++ b/bundles/pixi.js-legacy/src/index.js @@ -1,6 +1,6 @@ import '@pixi/polyfill'; -import { PIXI } from 'pixi.js'; +import { Application, accessibility, interaction, prepare, extract } from 'pixi.js'; import { autoDetectRenderer, CanvasRenderer } from '@pixi/canvas-renderer'; import { CanvasMeshRenderer } from '@pixi/canvas-mesh'; import { CanvasGraphicsRenderer } from '@pixi/canvas-graphics'; @@ -11,28 +11,18 @@ import '@pixi/canvas-particles'; import '@pixi/canvas-display'; -CanvasRenderer.registerPlugin('accessibility', PIXI.accessibility.AccessibilityManager); +CanvasRenderer.registerPlugin('accessibility', accessibility.AccessibilityManager); CanvasRenderer.registerPlugin('extract', canvasExtract.CanvasExtract); CanvasRenderer.registerPlugin('graphics', CanvasGraphicsRenderer); -CanvasRenderer.registerPlugin('interaction', PIXI.interaction.InteractionManager); +CanvasRenderer.registerPlugin('interaction', interaction.InteractionManager); CanvasRenderer.registerPlugin('mesh', CanvasMeshRenderer); CanvasRenderer.registerPlugin('prepare', canvasPrepare.CanvasPrepare); CanvasRenderer.registerPlugin('sprite', CanvasSpriteRenderer); -Object.assign(PIXI.prepare, canvasPrepare); -Object.assign(PIXI.extract, canvasExtract); +Object.assign(prepare, canvasPrepare); +Object.assign(extract, canvasExtract); -PIXI.Application.prototype.createRenderer = autoDetectRenderer; - -// Add to namespace window object for people doing `import 'pixi.js-legacy'` -Object.assign(PIXI, { - autoDetectRenderer, - CanvasRenderer, - CanvasGraphicsRenderer, - CanvasMeshRenderer, - CanvasSpriteRenderer, - CanvasTinter, -}); +Application.prototype.createRenderer = autoDetectRenderer; // Export ES for those importing specifically by name, // e.g., `import {autoDetectRenderer} from 'pixi.js-legacy'` diff --git a/bundles/pixi.js-legacy/test/index.js b/bundles/pixi.js-legacy/test/index.js index a29651e..15e82dd 100755 --- a/bundles/pixi.js-legacy/test/index.js +++ b/bundles/pixi.js-legacy/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi-legacy'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js deleted file mode 100644 index ad04323..0000000 --- a/bundles/pixi.js/src/deprecated.js +++ /dev/null @@ -1,909 +0,0 @@ -import { deprecation } from '@pixi/utils'; - -const v5 = '5.0.0'; - -export default function deprecated(PIXI) -{ - Object.defineProperties(PIXI, { - /** - * @constant {RegExp|string} SVG_SIZE - * @memberof PIXI - * @see PIXI.resources.SVGResource.SVG_SIZE - * @deprecated since 5.0.0 - */ - SVG_SIZE: { - get() - { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); - - return PIXI.SVGResource.SVG_SIZE; - }, - }, - - /** - * @class PIXI.TransformStatic - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformStatic: { - get() - { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * @class PIXI.TransformBase - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformBase: { - get() - { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * Constants that specify the transform type. - * - * @static - * @constant - * @name TRANSFORM_MODE - * @memberof PIXI - * @enum {number} - * @deprecated since 5.0.0 - * @property {number} STATIC - * @property {number} DYNAMIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); - - return { STATIC: 0, DYNAMIC: 1 }; - }, - }, - - /** - * @class PIXI.WebGLRenderer - * @see PIXI.Renderer - * @deprecated since 5.0.0 - */ - WebGLRenderer: { - get() - { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); - - return PIXI.Renderer; - }, - }, - - /** - * @class PIXI.CanvasRenderTarget - * @see PIXI.utils.CanvasRenderTarget - * @deprecated since 5.0.0 - */ - CanvasRenderTarget: { - get() - { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); - - return PIXI.utils.CanvasRenderTarget; - }, - }, - - /** - * @memberof PIXI - * @name loader - * @type {PIXI.Loader} - * @see PIXI.Loader.shared - * @deprecated since 5.0.0 - */ - loader: { - get() - { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); - - return PIXI.Loader.shared; - }, - }, - - /** - * @class PIXI.FilterManager - * @see PIXI.systems.FilterSystem - * @deprecated since 5.0.0 - */ - FilterManager: { - get() - { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); - - return PIXI.systems.FilterManager; - }, - }, - }); - - /** - * This namespace has been removed. All classes previous nested - * under this namespace have been moved to the top-level `PIXI` object. - * @namespace PIXI.extras - * @deprecated since 5.0.0 - */ - PIXI.extras = {}; - - Object.defineProperties(PIXI.extras, { - /** - * @class PIXI.extras.TilingSprite - * @see PIXI.TilingSprite - * @deprecated since 5.0.0 - */ - TilingSprite: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); - - return PIXI.TilingSprite; - }, - }, - /** - * @class PIXI.extras.TilingSpriteRenderer - * @see PIXI.TilingSpriteRenderer - * @deprecated since 5.0.0 - */ - TilingSpriteRenderer: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); - - return PIXI.TilingSpriteRenderer; - }, - }, - /** - * @class PIXI.extras.AnimatedSprite - * @see PIXI.AnimatedSprite - * @deprecated since 5.0.0 - */ - AnimatedSprite: { - get() - { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); - - return PIXI.AnimatedSprite; - }, - }, - /** - * @class PIXI.extras.BitmapText - * @see PIXI.BitmapText - * @deprecated since 5.0.0 - */ - BitmapText: { - get() - { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); - - return PIXI.BitmapText; - }, - }, - }); - - Object.defineProperties(PIXI.utils, { - /** - * @function PIXI.utils.getSvgSize - * @see PIXI.resources.SVGResource.getSize - * @deprecated since 5.0.0 - */ - getSvgSize: { - get() - { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); - - return PIXI.SVGResource.getSize; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.mesh - * @deprecated since 5.0.0 - */ - PIXI.mesh = {}; - - Object.defineProperties(PIXI.mesh, { - /** - * @class PIXI.mesh.Mesh - * @see PIXI.SimpleMesh - * @deprecated since 5.0.0 - */ - Mesh: { - get() - { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); - - return PIXI.SimpleMesh; - }, - }, - /** - * @class PIXI.mesh.NineSlicePlane - * @see PIXI.NineSlicePlane - * @deprecated since 5.0.0 - */ - NineSlicePlane: { - get() - { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); - - return PIXI.NineSlicePlane; - }, - }, - /** - * @class PIXI.mesh.Plane - * @see PIXI.SimplePlane - * @deprecated since 5.0.0 - */ - Plane: { - get() - { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); - - return PIXI.SimplePlane; - }, - }, - /** - * @class PIXI.mesh.Rope - * @see PIXI.SimpleRope - * @deprecated since 5.0.0 - */ - Rope: { - get() - { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); - - return PIXI.SimpleRope; - }, - }, - /** - * @class PIXI.mesh.RawMesh - * @see PIXI.Mesh - * @deprecated since 5.0.0 - */ - RawMesh: { - get() - { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); - - return PIXI.Mesh; - }, - }, - /** - * @class PIXI.mesh.CanvasMeshRenderer - * @see PIXI.CanvasMeshRenderer - * @deprecated since 5.0.0 - */ - CanvasMeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); - - return PIXI.CanvasMeshRenderer; - }, - }, - /** - * @class PIXI.mesh.MeshRenderer - * @see PIXI.MeshRenderer - * @deprecated since 5.0.0 - */ - MeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); - - return PIXI.MeshRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.particles - * @deprecated since 5.0.0 - */ - PIXI.particles = {}; - - Object.defineProperties(PIXI.particles, { - /** - * @class PIXI.particles.ParticleContainer - * @deprecated since 5.0.0 - * @see PIXI.ParticleContainer - */ - ParticleContainer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); - - return PIXI.ParticleContainer; - }, - }, - /** - * @class PIXI.particles.ParticleRenderer - * @deprecated since 5.0.0 - * @see PIXI.ParticleRenderer - */ - ParticleRenderer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); - - return PIXI.ParticleRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.ticker - * @deprecated since 5.0.0 - */ - PIXI.ticker = {}; - - Object.defineProperties(PIXI.ticker, { - /** - * @class PIXI.ticker.Ticker - * @deprecated since 5.0.0 - * @see PIXI.Ticker - */ - Ticker: { - get() - { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); - - return PIXI.Ticker; - }, - }, - /** - * @name PIXI.ticker.shared - * @type {PIXI.Ticker} - * @deprecated since 5.0.0 - * @see PIXI.Ticker.shared - */ - shared: { - get() - { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); - - return PIXI.Ticker.shared; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.loaders - * @deprecated since 5.0.0 - */ - PIXI.loaders = {}; - - Object.defineProperties(PIXI.loaders, { - /** - * @class PIXI.loaders.Loader - * @see PIXI.Loader - * @deprecated since 5.0.0 - */ - Loader: { - get() - { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); - - return PIXI.Loader; - }, - }, - /** - * @class PIXI.loaders.Resource - * @see PIXI.LoaderResource - * @deprecated since 5.0.0 - */ - Resource: { - get() - { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); - - return PIXI.LoaderResource; - }, - }, - /** - * @function PIXI.loaders.bitmapFontParser - * @see PIXI.BitmapFontLoader.use - * @deprecated since 5.0.0 - */ - bitmapFontParser: { - get() - { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); - - return PIXI.BitmapFontLoader.use; - }, - }, - /** - * @function PIXI.loaders.parseBitmapFontData - * @see PIXI.BitmapFontLoader.parse - * @deprecated since 5.0.0 - */ - parseBitmapFontData: { - get() - { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); - - return PIXI.BitmapFontLoader.parse; - }, - }, - /** - * @function PIXI.loaders.spritesheetParser - * @see PIXI.SpritesheetLoader.use - * @deprecated since 5.0.0 - */ - spritesheetParser: { - get() - { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); - - return PIXI.SpritesheetLoader.use; - }, - }, - /** - * @function PIXI.loaders.getResourcePath - * @see PIXI.SpritesheetLoader.getResourcePath - * @deprecated since 5.0.0 - */ - getResourcePath: { - get() - { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); - - return PIXI.SpritesheetLoader.getResourcePath; - }, - }, - }); - - /** - * @function PIXI.loaders.Loader.addPixiMiddleware - * @see PIXI.Loader.registerPlugin - * @deprecated since 5.0.0 - * @param {function} middleware - */ - PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) - { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); - - return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); - }; - - /** - * @class PIXI.extract.WebGLExtract - * @deprecated since 5.0.0 - * @see PIXI.extract.Extract - */ - Object.defineProperty(PIXI.extract, 'WebGLExtract', { - get() - { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); - - return PIXI.extract.Extract; - }, - }); - - /** - * @class PIXI.prepare.WebGLPrepare - * @deprecated since 5.0.0 - * @see PIXI.prepare.Prepare - */ - Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { - get() - { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); - - return PIXI.prepare.Prepare; - }, - }); - - /** - * @method PIXI.Container#_renderWebGL - * @private - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); - - this._render(renderer); - }; - - /** - * @method PIXI.Container#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.DisplayObject#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.DisplayObject#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.Container#renderAdvancedWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#renderAdvanced - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); - - this.renderAdvanced(renderer); - }; - - Object.defineProperties(PIXI.settings, { - /** - * Default transform type. - * - * @static - * @deprecated since 5.0.0 - * @memberof PIXI.settings - * @type {PIXI.TRANSFORM_MODE} - * @default PIXI.TRANSFORM_MODE.STATIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - - return 0; - }, - set() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - }, - }, - }); - - const { BaseTexture } = PIXI; - - /** - * @method fromImage - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method fromCanvas - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) - { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); - - return BaseTexture.from(canvas, { scaleMode }); - }; - - /** - * @method fromSVG - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method PIXI.Point#copy - * @deprecated since 5.0.0 - * @see PIXI.Point#copyFrom - */ - PIXI.Point.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.ObservablePoint#copy - * @deprecated since 5.0.0 - * @see PIXI.ObservablePoint#copyFrom - */ - PIXI.ObservablePoint.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Rectangle#copy - * @deprecated since 5.0.0 - * @see PIXI.Rectangle#copyFrom - */ - PIXI.Rectangle.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Matrix#copy - * @deprecated since 5.0.0 - * @see PIXI.Matrix#copyTo - */ - PIXI.Matrix.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); - - return this.copyTo(p); - }; - - Object.assign(PIXI.systems.FilterSystem.prototype, { - /** - * @method PIXI.FilterManager#getRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#getFilterTexture - */ - getRenderTarget(clear, resolution) - { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); - - return this.getFilterTexture(resolution); - }, - - /** - * @method PIXI.FilterManager#returnRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#returnFilterTexture - */ - returnRenderTarget(renderTexture) - { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); - - this.returnFilterTexture(renderTexture); - }, - }); - - Object.defineProperties(PIXI.RenderTexture.prototype, { - /** - * @name PIXI.RenderTexture#sourceFrame - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - sourceFrame: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); - - return this.filterFrame; - }, - }, - /** - * @name PIXI.RenderTexture#size - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - size: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); - - return this._frame; - }, - }, - }); - - /** - * @class BlurXFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurXFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(true, strength, quality, resolution, kernelSize); - } - } - - /** - * @class BlurYFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurYFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(false, strength, quality, resolution, kernelSize); - } - } - - Object.assign(PIXI.filters, { - BlurXFilter, - BlurYFilter, - }); - - const { Sprite, Texture } = PIXI; - - // 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`); - - return Sprite.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @see PIXI.Sprite.from - * @method PIXI.Sprite.fromImage - * @return {PIXI.Sprite} - */ - Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromSVG - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromCanvas - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromVideo - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromFrame - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); - - // 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`); - - return Texture.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromImage - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromImage = textureFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromSVG - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromCanvas - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromVideo - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromFrame - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); - - /** - * @deprecated since 5.0.0 - * @member {boolean} PIXI.AbstractRenderer#autoResize - * @see PIXI.AbstractRenderer#autoDensity - */ - Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { - get() - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - return this.autoDensity; - }, - set(value) - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - this.autoDensity = value; - }, - }); -} diff --git a/bundles/pixi.js/src/index.js b/bundles/pixi.js/src/index.js index 9e80f0d..554ef58 100644 --- a/bundles/pixi.js/src/index.js +++ b/bundles/pixi.js/src/index.js @@ -1,26 +1,16 @@ import * as accessibility from '@pixi/accessibility'; -import * as app from '@pixi/app'; -import * as constants from '@pixi/constants'; -import * as core from '@pixi/core'; -import * as display from '@pixi/display'; import * as extract from '@pixi/extract'; -import * as graphics from '@pixi/graphics'; import * as interaction from '@pixi/interaction'; -import * as loaders from '@pixi/loaders'; -import * as math from '@pixi/math'; -import * as mesh from '@pixi/mesh'; -import * as meshExtras from '@pixi/mesh-extras'; -import * as particles from '@pixi/particles'; import * as prepare from '@pixi/prepare'; -import * as sprite from '@pixi/sprite'; -import * as spriteAnimated from '@pixi/sprite-animated'; -import * as spritesheet from '@pixi/spritesheet'; -import * as spriteTiling from '@pixi/sprite-tiling'; -import * as text from '@pixi/text'; -import * as textBitmap from '@pixi/text-bitmap'; -import * as ticker from '@pixi/ticker'; import * as utils from '@pixi/utils'; -import { settings } from '@pixi/settings'; +import { Application } from '@pixi/app'; +import { Renderer, BatchRenderer } from '@pixi/core'; +import { Loader, AppLoaderPlugin } from '@pixi/loaders'; +import { ParticleRenderer } from '@pixi/particles'; +import { SpritesheetLoader } from '@pixi/spritesheet'; +import { TilingSpriteRenderer } from '@pixi/sprite-tiling'; +import { BitmapFontLoader } from '@pixi/text-bitmap'; +import { TickerPlugin } from '@pixi/ticker'; import { AlphaFilter } from '@pixi/filter-alpha'; import { BlurFilter, BlurFilterPass } from '@pixi/filter-blur'; import { ColorMatrixFilter } from '@pixi/filter-color-matrix'; @@ -30,22 +20,26 @@ import '@pixi/mixin-cache-as-bitmap'; import '@pixi/mixin-get-child-by-name'; import '@pixi/mixin-get-global-position'; -import deprecated from './deprecated'; + +// Export deprecations so Rollup can call it +// in the footer after global is defined +// other module must call this manually +import useDeprecated from './useDeprecated'; // Install renderer plugins -core.Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); -core.Renderer.registerPlugin('extract', extract.Extract); -core.Renderer.registerPlugin('interaction', interaction.InteractionManager); -core.Renderer.registerPlugin('particle', particles.ParticleRenderer); -core.Renderer.registerPlugin('prepare', prepare.Prepare); -core.Renderer.registerPlugin('batch', core.BatchRenderer); -core.Renderer.registerPlugin('tilingSprite', spriteTiling.TilingSpriteRenderer); +Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); +Renderer.registerPlugin('extract', extract.Extract); +Renderer.registerPlugin('interaction', interaction.InteractionManager); +Renderer.registerPlugin('particle', ParticleRenderer); +Renderer.registerPlugin('prepare', prepare.Prepare); +Renderer.registerPlugin('batch', BatchRenderer); +Renderer.registerPlugin('tilingSprite', TilingSpriteRenderer); -loaders.Loader.registerPlugin(textBitmap.BitmapFontLoader); -loaders.Loader.registerPlugin(spritesheet.SpritesheetLoader); +Loader.registerPlugin(BitmapFontLoader); +Loader.registerPlugin(SpritesheetLoader); -app.Application.registerPlugin(ticker.TickerPlugin); -app.Application.registerPlugin(loaders.AppLoaderPlugin); +Application.registerPlugin(TickerPlugin); +Application.registerPlugin(AppLoaderPlugin); // Apply deplayed mixins utils.mixins.performMixins(); @@ -59,12 +53,11 @@ * @name VERSION * @type {string} */ -const VERSION = '__VERSION__'; +export const VERSION = '__VERSION__'; /** * @namespace PIXI */ -const PIXI = { VERSION }; /** * This namespace contains WebGL-only display filters that can be applied @@ -93,7 +86,7 @@ * document.body.appendChild(app.view); * @namespace PIXI.filters */ -const filters = { +export const filters = { AlphaFilter, BlurFilter, BlurFilterPass, @@ -103,47 +96,7 @@ NoiseFilter, }; -// Add to namespace window object for people doing `import 'pixi.js'` -if (typeof window !== 'undefined') -{ - const namespaces = { - accessibility, - extract, - filters, - interaction, - prepare, - settings, - utils, - }; - - window.PIXI = Object.assign( - PIXI, - namespaces, - app, - constants, - core, - display, - graphics, - loaders, - math, - mesh, - meshExtras, - particles, - sprite, - spriteAnimated, - spritesheet, - spriteTiling, - text, - textBitmap, - ticker - ); - - // Deprecations only apply to Window object - deprecated(PIXI); -} - // Export ES for those importing specifically by name, -// e.g., `import {autoDetectRenderer} from 'pixi.js'` export * from '@pixi/app'; export * from '@pixi/constants'; export * from '@pixi/core'; @@ -161,14 +114,12 @@ export * from '@pixi/text'; export * from '@pixi/text-bitmap'; export * from '@pixi/ticker'; +export * from '@pixi/settings'; export { - PIXI, - VERSION, accessibility, extract, - filters, interaction, prepare, - settings, utils, + useDeprecated, }; diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js new file mode 100644 index 0000000..4eaba3b --- /dev/null +++ b/bundles/pixi.js/src/useDeprecated.js @@ -0,0 +1,921 @@ +import { deprecation } from '@pixi/utils'; + +const v5 = '5.0.0'; + +/** + * Deprecations (backward compatibilities) are automatically applied for browser bundles + * in the UMD module format. If using Webpack or Rollup, you'll need to apply these + * deprecations manually by doing something like this: + * @example + * import * as PIXI from 'pixi.js'; + * PIXI.useDeprecated(); // MUST be bound to namespace + * @memberof PIXI + * @function useDeprecated + */ +export default function useDeprecated() +{ + const PIXI = this; + + Object.defineProperties(PIXI, { + /** + * @constant {RegExp|string} SVG_SIZE + * @memberof PIXI + * @see PIXI.resources.SVGResource.SVG_SIZE + * @deprecated since 5.0.0 + */ + SVG_SIZE: { + get() + { + deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + + return PIXI.SVGResource.SVG_SIZE; + }, + }, + + /** + * @class PIXI.TransformStatic + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformStatic: { + get() + { + deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * @class PIXI.TransformBase + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformBase: { + get() + { + deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * Constants that specify the transform type. + * + * @static + * @constant + * @name TRANSFORM_MODE + * @memberof PIXI + * @enum {number} + * @deprecated since 5.0.0 + * @property {number} STATIC + * @property {number} DYNAMIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + + return { STATIC: 0, DYNAMIC: 1 }; + }, + }, + + /** + * @class PIXI.WebGLRenderer + * @see PIXI.Renderer + * @deprecated since 5.0.0 + */ + WebGLRenderer: { + get() + { + deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + + return PIXI.Renderer; + }, + }, + + /** + * @class PIXI.CanvasRenderTarget + * @see PIXI.utils.CanvasRenderTarget + * @deprecated since 5.0.0 + */ + CanvasRenderTarget: { + get() + { + deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + + return PIXI.utils.CanvasRenderTarget; + }, + }, + + /** + * @memberof PIXI + * @name loader + * @type {PIXI.Loader} + * @see PIXI.Loader.shared + * @deprecated since 5.0.0 + */ + loader: { + get() + { + deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + + return PIXI.Loader.shared; + }, + }, + + /** + * @class PIXI.FilterManager + * @see PIXI.systems.FilterSystem + * @deprecated since 5.0.0 + */ + FilterManager: { + get() + { + deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + + return PIXI.systems.FilterManager; + }, + }, + }); + + /** + * This namespace has been removed. All classes previous nested + * under this namespace have been moved to the top-level `PIXI` object. + * @namespace PIXI.extras + * @deprecated since 5.0.0 + */ + PIXI.extras = {}; + + Object.defineProperties(PIXI.extras, { + /** + * @class PIXI.extras.TilingSprite + * @see PIXI.TilingSprite + * @deprecated since 5.0.0 + */ + TilingSprite: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + + return PIXI.TilingSprite; + }, + }, + /** + * @class PIXI.extras.TilingSpriteRenderer + * @see PIXI.TilingSpriteRenderer + * @deprecated since 5.0.0 + */ + TilingSpriteRenderer: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + + return PIXI.TilingSpriteRenderer; + }, + }, + /** + * @class PIXI.extras.AnimatedSprite + * @see PIXI.AnimatedSprite + * @deprecated since 5.0.0 + */ + AnimatedSprite: { + get() + { + deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + + return PIXI.AnimatedSprite; + }, + }, + /** + * @class PIXI.extras.BitmapText + * @see PIXI.BitmapText + * @deprecated since 5.0.0 + */ + BitmapText: { + get() + { + deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + + return PIXI.BitmapText; + }, + }, + }); + + Object.defineProperties(PIXI.utils, { + /** + * @function PIXI.utils.getSvgSize + * @see PIXI.resources.SVGResource.getSize + * @deprecated since 5.0.0 + */ + getSvgSize: { + get() + { + deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + + return PIXI.SVGResource.getSize; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.mesh + * @deprecated since 5.0.0 + */ + PIXI.mesh = {}; + + Object.defineProperties(PIXI.mesh, { + /** + * @class PIXI.mesh.Mesh + * @see PIXI.SimpleMesh + * @deprecated since 5.0.0 + */ + Mesh: { + get() + { + deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + + return PIXI.SimpleMesh; + }, + }, + /** + * @class PIXI.mesh.NineSlicePlane + * @see PIXI.NineSlicePlane + * @deprecated since 5.0.0 + */ + NineSlicePlane: { + get() + { + deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + + return PIXI.NineSlicePlane; + }, + }, + /** + * @class PIXI.mesh.Plane + * @see PIXI.SimplePlane + * @deprecated since 5.0.0 + */ + Plane: { + get() + { + deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + + return PIXI.SimplePlane; + }, + }, + /** + * @class PIXI.mesh.Rope + * @see PIXI.SimpleRope + * @deprecated since 5.0.0 + */ + Rope: { + get() + { + deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + + return PIXI.SimpleRope; + }, + }, + /** + * @class PIXI.mesh.RawMesh + * @see PIXI.Mesh + * @deprecated since 5.0.0 + */ + RawMesh: { + get() + { + deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + + return PIXI.Mesh; + }, + }, + /** + * @class PIXI.mesh.CanvasMeshRenderer + * @see PIXI.CanvasMeshRenderer + * @deprecated since 5.0.0 + */ + CanvasMeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + + return PIXI.CanvasMeshRenderer; + }, + }, + /** + * @class PIXI.mesh.MeshRenderer + * @see PIXI.MeshRenderer + * @deprecated since 5.0.0 + */ + MeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + + return PIXI.MeshRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.particles + * @deprecated since 5.0.0 + */ + PIXI.particles = {}; + + Object.defineProperties(PIXI.particles, { + /** + * @class PIXI.particles.ParticleContainer + * @deprecated since 5.0.0 + * @see PIXI.ParticleContainer + */ + ParticleContainer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + + return PIXI.ParticleContainer; + }, + }, + /** + * @class PIXI.particles.ParticleRenderer + * @deprecated since 5.0.0 + * @see PIXI.ParticleRenderer + */ + ParticleRenderer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + + return PIXI.ParticleRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.ticker + * @deprecated since 5.0.0 + */ + PIXI.ticker = {}; + + Object.defineProperties(PIXI.ticker, { + /** + * @class PIXI.ticker.Ticker + * @deprecated since 5.0.0 + * @see PIXI.Ticker + */ + Ticker: { + get() + { + deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + + return PIXI.Ticker; + }, + }, + /** + * @name PIXI.ticker.shared + * @type {PIXI.Ticker} + * @deprecated since 5.0.0 + * @see PIXI.Ticker.shared + */ + shared: { + get() + { + deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + + return PIXI.Ticker.shared; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.loaders + * @deprecated since 5.0.0 + */ + PIXI.loaders = {}; + + Object.defineProperties(PIXI.loaders, { + /** + * @class PIXI.loaders.Loader + * @see PIXI.Loader + * @deprecated since 5.0.0 + */ + Loader: { + get() + { + deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + + return PIXI.Loader; + }, + }, + /** + * @class PIXI.loaders.Resource + * @see PIXI.LoaderResource + * @deprecated since 5.0.0 + */ + Resource: { + get() + { + deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + + return PIXI.LoaderResource; + }, + }, + /** + * @function PIXI.loaders.bitmapFontParser + * @see PIXI.BitmapFontLoader.use + * @deprecated since 5.0.0 + */ + bitmapFontParser: { + get() + { + deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + + return PIXI.BitmapFontLoader.use; + }, + }, + /** + * @function PIXI.loaders.parseBitmapFontData + * @see PIXI.BitmapFontLoader.parse + * @deprecated since 5.0.0 + */ + parseBitmapFontData: { + get() + { + deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + + return PIXI.BitmapFontLoader.parse; + }, + }, + /** + * @function PIXI.loaders.spritesheetParser + * @see PIXI.SpritesheetLoader.use + * @deprecated since 5.0.0 + */ + spritesheetParser: { + get() + { + deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + + return PIXI.SpritesheetLoader.use; + }, + }, + /** + * @function PIXI.loaders.getResourcePath + * @see PIXI.SpritesheetLoader.getResourcePath + * @deprecated since 5.0.0 + */ + getResourcePath: { + get() + { + deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + + return PIXI.SpritesheetLoader.getResourcePath; + }, + }, + }); + + /** + * @function PIXI.loaders.Loader.addPixiMiddleware + * @see PIXI.Loader.registerPlugin + * @deprecated since 5.0.0 + * @param {function} middleware + */ + PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) + { + deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + + return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); + }; + + /** + * @class PIXI.extract.WebGLExtract + * @deprecated since 5.0.0 + * @see PIXI.extract.Extract + */ + Object.defineProperty(PIXI.extract, 'WebGLExtract', { + get() + { + deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + + return PIXI.extract.Extract; + }, + }); + + /** + * @class PIXI.prepare.WebGLPrepare + * @deprecated since 5.0.0 + * @see PIXI.prepare.Prepare + */ + Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { + get() + { + deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + + return PIXI.prepare.Prepare; + }, + }); + + /** + * @method PIXI.Container#_renderWebGL + * @private + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + + this._render(renderer); + }; + + /** + * @method PIXI.Container#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.DisplayObject#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.DisplayObject#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.Container#renderAdvancedWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#renderAdvanced + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + + this.renderAdvanced(renderer); + }; + + Object.defineProperties(PIXI.settings, { + /** + * Default transform type. + * + * @static + * @deprecated since 5.0.0 + * @memberof PIXI.settings + * @type {PIXI.TRANSFORM_MODE} + * @default PIXI.TRANSFORM_MODE.STATIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + + return 0; + }, + set() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + }, + }, + }); + + const { BaseTexture } = PIXI; + + /** + * @method fromImage + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method fromCanvas + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) + { + deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + + return BaseTexture.from(canvas, { scaleMode }); + }; + + /** + * @method fromSVG + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method PIXI.Point#copy + * @deprecated since 5.0.0 + * @see PIXI.Point#copyFrom + */ + PIXI.Point.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.ObservablePoint#copy + * @deprecated since 5.0.0 + * @see PIXI.ObservablePoint#copyFrom + */ + PIXI.ObservablePoint.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Rectangle#copy + * @deprecated since 5.0.0 + * @see PIXI.Rectangle#copyFrom + */ + PIXI.Rectangle.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Matrix#copy + * @deprecated since 5.0.0 + * @see PIXI.Matrix#copyTo + */ + PIXI.Matrix.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + + return this.copyTo(p); + }; + + Object.assign(PIXI.systems.FilterSystem.prototype, { + /** + * @method PIXI.FilterManager#getRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#getFilterTexture + */ + getRenderTarget(clear, resolution) + { + deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + + return this.getFilterTexture(resolution); + }, + + /** + * @method PIXI.FilterManager#returnRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#returnFilterTexture + */ + returnRenderTarget(renderTexture) + { + deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + + this.returnFilterTexture(renderTexture); + }, + }); + + Object.defineProperties(PIXI.RenderTexture.prototype, { + /** + * @name PIXI.RenderTexture#sourceFrame + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + sourceFrame: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + + return this.filterFrame; + }, + }, + /** + * @name PIXI.RenderTexture#size + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + size: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + + return this._frame; + }, + }, + }); + + /** + * @class BlurXFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurXFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(true, strength, quality, resolution, kernelSize); + } + } + + /** + * @class BlurYFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurYFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(false, strength, quality, resolution, kernelSize); + } + } + + Object.assign(PIXI.filters, { + BlurXFilter, + BlurYFilter, + }); + + const { Sprite, Texture } = PIXI; + + // 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`); + + return Sprite.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @see PIXI.Sprite.from + * @method PIXI.Sprite.fromImage + * @return {PIXI.Sprite} + */ + Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromSVG + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromCanvas + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromVideo + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromFrame + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); + + // 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`); + + return Texture.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromImage + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromImage = textureFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromSVG + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromCanvas + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromVideo + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromFrame + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); + + /** + * @deprecated since 5.0.0 + * @member {boolean} PIXI.AbstractRenderer#autoResize + * @see PIXI.AbstractRenderer#autoDensity + */ + Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { + get() + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + return this.autoDensity; + }, + set(value) + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + this.autoDensity = value; + }, + }); +} diff --git a/bundles/pixi.js/test/index.js b/bundles/pixi.js/test/index.js index a29651e..9d6ea9d 100644 --- a/bundles/pixi.js/test/index.js +++ b/bundles/pixi.js/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/bundles/pixi.js-legacy/src/index.js b/bundles/pixi.js-legacy/src/index.js index 6c9d2b8..f71fdb7 100644 --- a/bundles/pixi.js-legacy/src/index.js +++ b/bundles/pixi.js-legacy/src/index.js @@ -1,6 +1,6 @@ import '@pixi/polyfill'; -import { PIXI } from 'pixi.js'; +import { Application, accessibility, interaction, prepare, extract } from 'pixi.js'; import { autoDetectRenderer, CanvasRenderer } from '@pixi/canvas-renderer'; import { CanvasMeshRenderer } from '@pixi/canvas-mesh'; import { CanvasGraphicsRenderer } from '@pixi/canvas-graphics'; @@ -11,28 +11,18 @@ import '@pixi/canvas-particles'; import '@pixi/canvas-display'; -CanvasRenderer.registerPlugin('accessibility', PIXI.accessibility.AccessibilityManager); +CanvasRenderer.registerPlugin('accessibility', accessibility.AccessibilityManager); CanvasRenderer.registerPlugin('extract', canvasExtract.CanvasExtract); CanvasRenderer.registerPlugin('graphics', CanvasGraphicsRenderer); -CanvasRenderer.registerPlugin('interaction', PIXI.interaction.InteractionManager); +CanvasRenderer.registerPlugin('interaction', interaction.InteractionManager); CanvasRenderer.registerPlugin('mesh', CanvasMeshRenderer); CanvasRenderer.registerPlugin('prepare', canvasPrepare.CanvasPrepare); CanvasRenderer.registerPlugin('sprite', CanvasSpriteRenderer); -Object.assign(PIXI.prepare, canvasPrepare); -Object.assign(PIXI.extract, canvasExtract); +Object.assign(prepare, canvasPrepare); +Object.assign(extract, canvasExtract); -PIXI.Application.prototype.createRenderer = autoDetectRenderer; - -// Add to namespace window object for people doing `import 'pixi.js-legacy'` -Object.assign(PIXI, { - autoDetectRenderer, - CanvasRenderer, - CanvasGraphicsRenderer, - CanvasMeshRenderer, - CanvasSpriteRenderer, - CanvasTinter, -}); +Application.prototype.createRenderer = autoDetectRenderer; // Export ES for those importing specifically by name, // e.g., `import {autoDetectRenderer} from 'pixi.js-legacy'` diff --git a/bundles/pixi.js-legacy/test/index.js b/bundles/pixi.js-legacy/test/index.js index a29651e..15e82dd 100755 --- a/bundles/pixi.js-legacy/test/index.js +++ b/bundles/pixi.js-legacy/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi-legacy'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js deleted file mode 100644 index ad04323..0000000 --- a/bundles/pixi.js/src/deprecated.js +++ /dev/null @@ -1,909 +0,0 @@ -import { deprecation } from '@pixi/utils'; - -const v5 = '5.0.0'; - -export default function deprecated(PIXI) -{ - Object.defineProperties(PIXI, { - /** - * @constant {RegExp|string} SVG_SIZE - * @memberof PIXI - * @see PIXI.resources.SVGResource.SVG_SIZE - * @deprecated since 5.0.0 - */ - SVG_SIZE: { - get() - { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); - - return PIXI.SVGResource.SVG_SIZE; - }, - }, - - /** - * @class PIXI.TransformStatic - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformStatic: { - get() - { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * @class PIXI.TransformBase - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformBase: { - get() - { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * Constants that specify the transform type. - * - * @static - * @constant - * @name TRANSFORM_MODE - * @memberof PIXI - * @enum {number} - * @deprecated since 5.0.0 - * @property {number} STATIC - * @property {number} DYNAMIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); - - return { STATIC: 0, DYNAMIC: 1 }; - }, - }, - - /** - * @class PIXI.WebGLRenderer - * @see PIXI.Renderer - * @deprecated since 5.0.0 - */ - WebGLRenderer: { - get() - { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); - - return PIXI.Renderer; - }, - }, - - /** - * @class PIXI.CanvasRenderTarget - * @see PIXI.utils.CanvasRenderTarget - * @deprecated since 5.0.0 - */ - CanvasRenderTarget: { - get() - { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); - - return PIXI.utils.CanvasRenderTarget; - }, - }, - - /** - * @memberof PIXI - * @name loader - * @type {PIXI.Loader} - * @see PIXI.Loader.shared - * @deprecated since 5.0.0 - */ - loader: { - get() - { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); - - return PIXI.Loader.shared; - }, - }, - - /** - * @class PIXI.FilterManager - * @see PIXI.systems.FilterSystem - * @deprecated since 5.0.0 - */ - FilterManager: { - get() - { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); - - return PIXI.systems.FilterManager; - }, - }, - }); - - /** - * This namespace has been removed. All classes previous nested - * under this namespace have been moved to the top-level `PIXI` object. - * @namespace PIXI.extras - * @deprecated since 5.0.0 - */ - PIXI.extras = {}; - - Object.defineProperties(PIXI.extras, { - /** - * @class PIXI.extras.TilingSprite - * @see PIXI.TilingSprite - * @deprecated since 5.0.0 - */ - TilingSprite: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); - - return PIXI.TilingSprite; - }, - }, - /** - * @class PIXI.extras.TilingSpriteRenderer - * @see PIXI.TilingSpriteRenderer - * @deprecated since 5.0.0 - */ - TilingSpriteRenderer: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); - - return PIXI.TilingSpriteRenderer; - }, - }, - /** - * @class PIXI.extras.AnimatedSprite - * @see PIXI.AnimatedSprite - * @deprecated since 5.0.0 - */ - AnimatedSprite: { - get() - { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); - - return PIXI.AnimatedSprite; - }, - }, - /** - * @class PIXI.extras.BitmapText - * @see PIXI.BitmapText - * @deprecated since 5.0.0 - */ - BitmapText: { - get() - { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); - - return PIXI.BitmapText; - }, - }, - }); - - Object.defineProperties(PIXI.utils, { - /** - * @function PIXI.utils.getSvgSize - * @see PIXI.resources.SVGResource.getSize - * @deprecated since 5.0.0 - */ - getSvgSize: { - get() - { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); - - return PIXI.SVGResource.getSize; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.mesh - * @deprecated since 5.0.0 - */ - PIXI.mesh = {}; - - Object.defineProperties(PIXI.mesh, { - /** - * @class PIXI.mesh.Mesh - * @see PIXI.SimpleMesh - * @deprecated since 5.0.0 - */ - Mesh: { - get() - { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); - - return PIXI.SimpleMesh; - }, - }, - /** - * @class PIXI.mesh.NineSlicePlane - * @see PIXI.NineSlicePlane - * @deprecated since 5.0.0 - */ - NineSlicePlane: { - get() - { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); - - return PIXI.NineSlicePlane; - }, - }, - /** - * @class PIXI.mesh.Plane - * @see PIXI.SimplePlane - * @deprecated since 5.0.0 - */ - Plane: { - get() - { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); - - return PIXI.SimplePlane; - }, - }, - /** - * @class PIXI.mesh.Rope - * @see PIXI.SimpleRope - * @deprecated since 5.0.0 - */ - Rope: { - get() - { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); - - return PIXI.SimpleRope; - }, - }, - /** - * @class PIXI.mesh.RawMesh - * @see PIXI.Mesh - * @deprecated since 5.0.0 - */ - RawMesh: { - get() - { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); - - return PIXI.Mesh; - }, - }, - /** - * @class PIXI.mesh.CanvasMeshRenderer - * @see PIXI.CanvasMeshRenderer - * @deprecated since 5.0.0 - */ - CanvasMeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); - - return PIXI.CanvasMeshRenderer; - }, - }, - /** - * @class PIXI.mesh.MeshRenderer - * @see PIXI.MeshRenderer - * @deprecated since 5.0.0 - */ - MeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); - - return PIXI.MeshRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.particles - * @deprecated since 5.0.0 - */ - PIXI.particles = {}; - - Object.defineProperties(PIXI.particles, { - /** - * @class PIXI.particles.ParticleContainer - * @deprecated since 5.0.0 - * @see PIXI.ParticleContainer - */ - ParticleContainer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); - - return PIXI.ParticleContainer; - }, - }, - /** - * @class PIXI.particles.ParticleRenderer - * @deprecated since 5.0.0 - * @see PIXI.ParticleRenderer - */ - ParticleRenderer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); - - return PIXI.ParticleRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.ticker - * @deprecated since 5.0.0 - */ - PIXI.ticker = {}; - - Object.defineProperties(PIXI.ticker, { - /** - * @class PIXI.ticker.Ticker - * @deprecated since 5.0.0 - * @see PIXI.Ticker - */ - Ticker: { - get() - { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); - - return PIXI.Ticker; - }, - }, - /** - * @name PIXI.ticker.shared - * @type {PIXI.Ticker} - * @deprecated since 5.0.0 - * @see PIXI.Ticker.shared - */ - shared: { - get() - { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); - - return PIXI.Ticker.shared; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.loaders - * @deprecated since 5.0.0 - */ - PIXI.loaders = {}; - - Object.defineProperties(PIXI.loaders, { - /** - * @class PIXI.loaders.Loader - * @see PIXI.Loader - * @deprecated since 5.0.0 - */ - Loader: { - get() - { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); - - return PIXI.Loader; - }, - }, - /** - * @class PIXI.loaders.Resource - * @see PIXI.LoaderResource - * @deprecated since 5.0.0 - */ - Resource: { - get() - { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); - - return PIXI.LoaderResource; - }, - }, - /** - * @function PIXI.loaders.bitmapFontParser - * @see PIXI.BitmapFontLoader.use - * @deprecated since 5.0.0 - */ - bitmapFontParser: { - get() - { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); - - return PIXI.BitmapFontLoader.use; - }, - }, - /** - * @function PIXI.loaders.parseBitmapFontData - * @see PIXI.BitmapFontLoader.parse - * @deprecated since 5.0.0 - */ - parseBitmapFontData: { - get() - { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); - - return PIXI.BitmapFontLoader.parse; - }, - }, - /** - * @function PIXI.loaders.spritesheetParser - * @see PIXI.SpritesheetLoader.use - * @deprecated since 5.0.0 - */ - spritesheetParser: { - get() - { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); - - return PIXI.SpritesheetLoader.use; - }, - }, - /** - * @function PIXI.loaders.getResourcePath - * @see PIXI.SpritesheetLoader.getResourcePath - * @deprecated since 5.0.0 - */ - getResourcePath: { - get() - { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); - - return PIXI.SpritesheetLoader.getResourcePath; - }, - }, - }); - - /** - * @function PIXI.loaders.Loader.addPixiMiddleware - * @see PIXI.Loader.registerPlugin - * @deprecated since 5.0.0 - * @param {function} middleware - */ - PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) - { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); - - return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); - }; - - /** - * @class PIXI.extract.WebGLExtract - * @deprecated since 5.0.0 - * @see PIXI.extract.Extract - */ - Object.defineProperty(PIXI.extract, 'WebGLExtract', { - get() - { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); - - return PIXI.extract.Extract; - }, - }); - - /** - * @class PIXI.prepare.WebGLPrepare - * @deprecated since 5.0.0 - * @see PIXI.prepare.Prepare - */ - Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { - get() - { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); - - return PIXI.prepare.Prepare; - }, - }); - - /** - * @method PIXI.Container#_renderWebGL - * @private - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); - - this._render(renderer); - }; - - /** - * @method PIXI.Container#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.DisplayObject#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.DisplayObject#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.Container#renderAdvancedWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#renderAdvanced - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); - - this.renderAdvanced(renderer); - }; - - Object.defineProperties(PIXI.settings, { - /** - * Default transform type. - * - * @static - * @deprecated since 5.0.0 - * @memberof PIXI.settings - * @type {PIXI.TRANSFORM_MODE} - * @default PIXI.TRANSFORM_MODE.STATIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - - return 0; - }, - set() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - }, - }, - }); - - const { BaseTexture } = PIXI; - - /** - * @method fromImage - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method fromCanvas - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) - { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); - - return BaseTexture.from(canvas, { scaleMode }); - }; - - /** - * @method fromSVG - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method PIXI.Point#copy - * @deprecated since 5.0.0 - * @see PIXI.Point#copyFrom - */ - PIXI.Point.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.ObservablePoint#copy - * @deprecated since 5.0.0 - * @see PIXI.ObservablePoint#copyFrom - */ - PIXI.ObservablePoint.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Rectangle#copy - * @deprecated since 5.0.0 - * @see PIXI.Rectangle#copyFrom - */ - PIXI.Rectangle.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Matrix#copy - * @deprecated since 5.0.0 - * @see PIXI.Matrix#copyTo - */ - PIXI.Matrix.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); - - return this.copyTo(p); - }; - - Object.assign(PIXI.systems.FilterSystem.prototype, { - /** - * @method PIXI.FilterManager#getRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#getFilterTexture - */ - getRenderTarget(clear, resolution) - { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); - - return this.getFilterTexture(resolution); - }, - - /** - * @method PIXI.FilterManager#returnRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#returnFilterTexture - */ - returnRenderTarget(renderTexture) - { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); - - this.returnFilterTexture(renderTexture); - }, - }); - - Object.defineProperties(PIXI.RenderTexture.prototype, { - /** - * @name PIXI.RenderTexture#sourceFrame - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - sourceFrame: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); - - return this.filterFrame; - }, - }, - /** - * @name PIXI.RenderTexture#size - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - size: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); - - return this._frame; - }, - }, - }); - - /** - * @class BlurXFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurXFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(true, strength, quality, resolution, kernelSize); - } - } - - /** - * @class BlurYFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurYFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(false, strength, quality, resolution, kernelSize); - } - } - - Object.assign(PIXI.filters, { - BlurXFilter, - BlurYFilter, - }); - - const { Sprite, Texture } = PIXI; - - // 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`); - - return Sprite.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @see PIXI.Sprite.from - * @method PIXI.Sprite.fromImage - * @return {PIXI.Sprite} - */ - Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromSVG - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromCanvas - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromVideo - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromFrame - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); - - // 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`); - - return Texture.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromImage - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromImage = textureFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromSVG - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromCanvas - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromVideo - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromFrame - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); - - /** - * @deprecated since 5.0.0 - * @member {boolean} PIXI.AbstractRenderer#autoResize - * @see PIXI.AbstractRenderer#autoDensity - */ - Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { - get() - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - return this.autoDensity; - }, - set(value) - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - this.autoDensity = value; - }, - }); -} diff --git a/bundles/pixi.js/src/index.js b/bundles/pixi.js/src/index.js index 9e80f0d..554ef58 100644 --- a/bundles/pixi.js/src/index.js +++ b/bundles/pixi.js/src/index.js @@ -1,26 +1,16 @@ import * as accessibility from '@pixi/accessibility'; -import * as app from '@pixi/app'; -import * as constants from '@pixi/constants'; -import * as core from '@pixi/core'; -import * as display from '@pixi/display'; import * as extract from '@pixi/extract'; -import * as graphics from '@pixi/graphics'; import * as interaction from '@pixi/interaction'; -import * as loaders from '@pixi/loaders'; -import * as math from '@pixi/math'; -import * as mesh from '@pixi/mesh'; -import * as meshExtras from '@pixi/mesh-extras'; -import * as particles from '@pixi/particles'; import * as prepare from '@pixi/prepare'; -import * as sprite from '@pixi/sprite'; -import * as spriteAnimated from '@pixi/sprite-animated'; -import * as spritesheet from '@pixi/spritesheet'; -import * as spriteTiling from '@pixi/sprite-tiling'; -import * as text from '@pixi/text'; -import * as textBitmap from '@pixi/text-bitmap'; -import * as ticker from '@pixi/ticker'; import * as utils from '@pixi/utils'; -import { settings } from '@pixi/settings'; +import { Application } from '@pixi/app'; +import { Renderer, BatchRenderer } from '@pixi/core'; +import { Loader, AppLoaderPlugin } from '@pixi/loaders'; +import { ParticleRenderer } from '@pixi/particles'; +import { SpritesheetLoader } from '@pixi/spritesheet'; +import { TilingSpriteRenderer } from '@pixi/sprite-tiling'; +import { BitmapFontLoader } from '@pixi/text-bitmap'; +import { TickerPlugin } from '@pixi/ticker'; import { AlphaFilter } from '@pixi/filter-alpha'; import { BlurFilter, BlurFilterPass } from '@pixi/filter-blur'; import { ColorMatrixFilter } from '@pixi/filter-color-matrix'; @@ -30,22 +20,26 @@ import '@pixi/mixin-cache-as-bitmap'; import '@pixi/mixin-get-child-by-name'; import '@pixi/mixin-get-global-position'; -import deprecated from './deprecated'; + +// Export deprecations so Rollup can call it +// in the footer after global is defined +// other module must call this manually +import useDeprecated from './useDeprecated'; // Install renderer plugins -core.Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); -core.Renderer.registerPlugin('extract', extract.Extract); -core.Renderer.registerPlugin('interaction', interaction.InteractionManager); -core.Renderer.registerPlugin('particle', particles.ParticleRenderer); -core.Renderer.registerPlugin('prepare', prepare.Prepare); -core.Renderer.registerPlugin('batch', core.BatchRenderer); -core.Renderer.registerPlugin('tilingSprite', spriteTiling.TilingSpriteRenderer); +Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); +Renderer.registerPlugin('extract', extract.Extract); +Renderer.registerPlugin('interaction', interaction.InteractionManager); +Renderer.registerPlugin('particle', ParticleRenderer); +Renderer.registerPlugin('prepare', prepare.Prepare); +Renderer.registerPlugin('batch', BatchRenderer); +Renderer.registerPlugin('tilingSprite', TilingSpriteRenderer); -loaders.Loader.registerPlugin(textBitmap.BitmapFontLoader); -loaders.Loader.registerPlugin(spritesheet.SpritesheetLoader); +Loader.registerPlugin(BitmapFontLoader); +Loader.registerPlugin(SpritesheetLoader); -app.Application.registerPlugin(ticker.TickerPlugin); -app.Application.registerPlugin(loaders.AppLoaderPlugin); +Application.registerPlugin(TickerPlugin); +Application.registerPlugin(AppLoaderPlugin); // Apply deplayed mixins utils.mixins.performMixins(); @@ -59,12 +53,11 @@ * @name VERSION * @type {string} */ -const VERSION = '__VERSION__'; +export const VERSION = '__VERSION__'; /** * @namespace PIXI */ -const PIXI = { VERSION }; /** * This namespace contains WebGL-only display filters that can be applied @@ -93,7 +86,7 @@ * document.body.appendChild(app.view); * @namespace PIXI.filters */ -const filters = { +export const filters = { AlphaFilter, BlurFilter, BlurFilterPass, @@ -103,47 +96,7 @@ NoiseFilter, }; -// Add to namespace window object for people doing `import 'pixi.js'` -if (typeof window !== 'undefined') -{ - const namespaces = { - accessibility, - extract, - filters, - interaction, - prepare, - settings, - utils, - }; - - window.PIXI = Object.assign( - PIXI, - namespaces, - app, - constants, - core, - display, - graphics, - loaders, - math, - mesh, - meshExtras, - particles, - sprite, - spriteAnimated, - spritesheet, - spriteTiling, - text, - textBitmap, - ticker - ); - - // Deprecations only apply to Window object - deprecated(PIXI); -} - // Export ES for those importing specifically by name, -// e.g., `import {autoDetectRenderer} from 'pixi.js'` export * from '@pixi/app'; export * from '@pixi/constants'; export * from '@pixi/core'; @@ -161,14 +114,12 @@ export * from '@pixi/text'; export * from '@pixi/text-bitmap'; export * from '@pixi/ticker'; +export * from '@pixi/settings'; export { - PIXI, - VERSION, accessibility, extract, - filters, interaction, prepare, - settings, utils, + useDeprecated, }; diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js new file mode 100644 index 0000000..4eaba3b --- /dev/null +++ b/bundles/pixi.js/src/useDeprecated.js @@ -0,0 +1,921 @@ +import { deprecation } from '@pixi/utils'; + +const v5 = '5.0.0'; + +/** + * Deprecations (backward compatibilities) are automatically applied for browser bundles + * in the UMD module format. If using Webpack or Rollup, you'll need to apply these + * deprecations manually by doing something like this: + * @example + * import * as PIXI from 'pixi.js'; + * PIXI.useDeprecated(); // MUST be bound to namespace + * @memberof PIXI + * @function useDeprecated + */ +export default function useDeprecated() +{ + const PIXI = this; + + Object.defineProperties(PIXI, { + /** + * @constant {RegExp|string} SVG_SIZE + * @memberof PIXI + * @see PIXI.resources.SVGResource.SVG_SIZE + * @deprecated since 5.0.0 + */ + SVG_SIZE: { + get() + { + deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + + return PIXI.SVGResource.SVG_SIZE; + }, + }, + + /** + * @class PIXI.TransformStatic + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformStatic: { + get() + { + deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * @class PIXI.TransformBase + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformBase: { + get() + { + deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * Constants that specify the transform type. + * + * @static + * @constant + * @name TRANSFORM_MODE + * @memberof PIXI + * @enum {number} + * @deprecated since 5.0.0 + * @property {number} STATIC + * @property {number} DYNAMIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + + return { STATIC: 0, DYNAMIC: 1 }; + }, + }, + + /** + * @class PIXI.WebGLRenderer + * @see PIXI.Renderer + * @deprecated since 5.0.0 + */ + WebGLRenderer: { + get() + { + deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + + return PIXI.Renderer; + }, + }, + + /** + * @class PIXI.CanvasRenderTarget + * @see PIXI.utils.CanvasRenderTarget + * @deprecated since 5.0.0 + */ + CanvasRenderTarget: { + get() + { + deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + + return PIXI.utils.CanvasRenderTarget; + }, + }, + + /** + * @memberof PIXI + * @name loader + * @type {PIXI.Loader} + * @see PIXI.Loader.shared + * @deprecated since 5.0.0 + */ + loader: { + get() + { + deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + + return PIXI.Loader.shared; + }, + }, + + /** + * @class PIXI.FilterManager + * @see PIXI.systems.FilterSystem + * @deprecated since 5.0.0 + */ + FilterManager: { + get() + { + deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + + return PIXI.systems.FilterManager; + }, + }, + }); + + /** + * This namespace has been removed. All classes previous nested + * under this namespace have been moved to the top-level `PIXI` object. + * @namespace PIXI.extras + * @deprecated since 5.0.0 + */ + PIXI.extras = {}; + + Object.defineProperties(PIXI.extras, { + /** + * @class PIXI.extras.TilingSprite + * @see PIXI.TilingSprite + * @deprecated since 5.0.0 + */ + TilingSprite: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + + return PIXI.TilingSprite; + }, + }, + /** + * @class PIXI.extras.TilingSpriteRenderer + * @see PIXI.TilingSpriteRenderer + * @deprecated since 5.0.0 + */ + TilingSpriteRenderer: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + + return PIXI.TilingSpriteRenderer; + }, + }, + /** + * @class PIXI.extras.AnimatedSprite + * @see PIXI.AnimatedSprite + * @deprecated since 5.0.0 + */ + AnimatedSprite: { + get() + { + deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + + return PIXI.AnimatedSprite; + }, + }, + /** + * @class PIXI.extras.BitmapText + * @see PIXI.BitmapText + * @deprecated since 5.0.0 + */ + BitmapText: { + get() + { + deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + + return PIXI.BitmapText; + }, + }, + }); + + Object.defineProperties(PIXI.utils, { + /** + * @function PIXI.utils.getSvgSize + * @see PIXI.resources.SVGResource.getSize + * @deprecated since 5.0.0 + */ + getSvgSize: { + get() + { + deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + + return PIXI.SVGResource.getSize; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.mesh + * @deprecated since 5.0.0 + */ + PIXI.mesh = {}; + + Object.defineProperties(PIXI.mesh, { + /** + * @class PIXI.mesh.Mesh + * @see PIXI.SimpleMesh + * @deprecated since 5.0.0 + */ + Mesh: { + get() + { + deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + + return PIXI.SimpleMesh; + }, + }, + /** + * @class PIXI.mesh.NineSlicePlane + * @see PIXI.NineSlicePlane + * @deprecated since 5.0.0 + */ + NineSlicePlane: { + get() + { + deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + + return PIXI.NineSlicePlane; + }, + }, + /** + * @class PIXI.mesh.Plane + * @see PIXI.SimplePlane + * @deprecated since 5.0.0 + */ + Plane: { + get() + { + deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + + return PIXI.SimplePlane; + }, + }, + /** + * @class PIXI.mesh.Rope + * @see PIXI.SimpleRope + * @deprecated since 5.0.0 + */ + Rope: { + get() + { + deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + + return PIXI.SimpleRope; + }, + }, + /** + * @class PIXI.mesh.RawMesh + * @see PIXI.Mesh + * @deprecated since 5.0.0 + */ + RawMesh: { + get() + { + deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + + return PIXI.Mesh; + }, + }, + /** + * @class PIXI.mesh.CanvasMeshRenderer + * @see PIXI.CanvasMeshRenderer + * @deprecated since 5.0.0 + */ + CanvasMeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + + return PIXI.CanvasMeshRenderer; + }, + }, + /** + * @class PIXI.mesh.MeshRenderer + * @see PIXI.MeshRenderer + * @deprecated since 5.0.0 + */ + MeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + + return PIXI.MeshRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.particles + * @deprecated since 5.0.0 + */ + PIXI.particles = {}; + + Object.defineProperties(PIXI.particles, { + /** + * @class PIXI.particles.ParticleContainer + * @deprecated since 5.0.0 + * @see PIXI.ParticleContainer + */ + ParticleContainer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + + return PIXI.ParticleContainer; + }, + }, + /** + * @class PIXI.particles.ParticleRenderer + * @deprecated since 5.0.0 + * @see PIXI.ParticleRenderer + */ + ParticleRenderer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + + return PIXI.ParticleRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.ticker + * @deprecated since 5.0.0 + */ + PIXI.ticker = {}; + + Object.defineProperties(PIXI.ticker, { + /** + * @class PIXI.ticker.Ticker + * @deprecated since 5.0.0 + * @see PIXI.Ticker + */ + Ticker: { + get() + { + deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + + return PIXI.Ticker; + }, + }, + /** + * @name PIXI.ticker.shared + * @type {PIXI.Ticker} + * @deprecated since 5.0.0 + * @see PIXI.Ticker.shared + */ + shared: { + get() + { + deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + + return PIXI.Ticker.shared; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.loaders + * @deprecated since 5.0.0 + */ + PIXI.loaders = {}; + + Object.defineProperties(PIXI.loaders, { + /** + * @class PIXI.loaders.Loader + * @see PIXI.Loader + * @deprecated since 5.0.0 + */ + Loader: { + get() + { + deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + + return PIXI.Loader; + }, + }, + /** + * @class PIXI.loaders.Resource + * @see PIXI.LoaderResource + * @deprecated since 5.0.0 + */ + Resource: { + get() + { + deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + + return PIXI.LoaderResource; + }, + }, + /** + * @function PIXI.loaders.bitmapFontParser + * @see PIXI.BitmapFontLoader.use + * @deprecated since 5.0.0 + */ + bitmapFontParser: { + get() + { + deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + + return PIXI.BitmapFontLoader.use; + }, + }, + /** + * @function PIXI.loaders.parseBitmapFontData + * @see PIXI.BitmapFontLoader.parse + * @deprecated since 5.0.0 + */ + parseBitmapFontData: { + get() + { + deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + + return PIXI.BitmapFontLoader.parse; + }, + }, + /** + * @function PIXI.loaders.spritesheetParser + * @see PIXI.SpritesheetLoader.use + * @deprecated since 5.0.0 + */ + spritesheetParser: { + get() + { + deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + + return PIXI.SpritesheetLoader.use; + }, + }, + /** + * @function PIXI.loaders.getResourcePath + * @see PIXI.SpritesheetLoader.getResourcePath + * @deprecated since 5.0.0 + */ + getResourcePath: { + get() + { + deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + + return PIXI.SpritesheetLoader.getResourcePath; + }, + }, + }); + + /** + * @function PIXI.loaders.Loader.addPixiMiddleware + * @see PIXI.Loader.registerPlugin + * @deprecated since 5.0.0 + * @param {function} middleware + */ + PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) + { + deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + + return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); + }; + + /** + * @class PIXI.extract.WebGLExtract + * @deprecated since 5.0.0 + * @see PIXI.extract.Extract + */ + Object.defineProperty(PIXI.extract, 'WebGLExtract', { + get() + { + deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + + return PIXI.extract.Extract; + }, + }); + + /** + * @class PIXI.prepare.WebGLPrepare + * @deprecated since 5.0.0 + * @see PIXI.prepare.Prepare + */ + Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { + get() + { + deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + + return PIXI.prepare.Prepare; + }, + }); + + /** + * @method PIXI.Container#_renderWebGL + * @private + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + + this._render(renderer); + }; + + /** + * @method PIXI.Container#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.DisplayObject#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.DisplayObject#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.Container#renderAdvancedWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#renderAdvanced + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + + this.renderAdvanced(renderer); + }; + + Object.defineProperties(PIXI.settings, { + /** + * Default transform type. + * + * @static + * @deprecated since 5.0.0 + * @memberof PIXI.settings + * @type {PIXI.TRANSFORM_MODE} + * @default PIXI.TRANSFORM_MODE.STATIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + + return 0; + }, + set() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + }, + }, + }); + + const { BaseTexture } = PIXI; + + /** + * @method fromImage + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method fromCanvas + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) + { + deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + + return BaseTexture.from(canvas, { scaleMode }); + }; + + /** + * @method fromSVG + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method PIXI.Point#copy + * @deprecated since 5.0.0 + * @see PIXI.Point#copyFrom + */ + PIXI.Point.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.ObservablePoint#copy + * @deprecated since 5.0.0 + * @see PIXI.ObservablePoint#copyFrom + */ + PIXI.ObservablePoint.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Rectangle#copy + * @deprecated since 5.0.0 + * @see PIXI.Rectangle#copyFrom + */ + PIXI.Rectangle.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Matrix#copy + * @deprecated since 5.0.0 + * @see PIXI.Matrix#copyTo + */ + PIXI.Matrix.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + + return this.copyTo(p); + }; + + Object.assign(PIXI.systems.FilterSystem.prototype, { + /** + * @method PIXI.FilterManager#getRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#getFilterTexture + */ + getRenderTarget(clear, resolution) + { + deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + + return this.getFilterTexture(resolution); + }, + + /** + * @method PIXI.FilterManager#returnRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#returnFilterTexture + */ + returnRenderTarget(renderTexture) + { + deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + + this.returnFilterTexture(renderTexture); + }, + }); + + Object.defineProperties(PIXI.RenderTexture.prototype, { + /** + * @name PIXI.RenderTexture#sourceFrame + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + sourceFrame: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + + return this.filterFrame; + }, + }, + /** + * @name PIXI.RenderTexture#size + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + size: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + + return this._frame; + }, + }, + }); + + /** + * @class BlurXFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurXFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(true, strength, quality, resolution, kernelSize); + } + } + + /** + * @class BlurYFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurYFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(false, strength, quality, resolution, kernelSize); + } + } + + Object.assign(PIXI.filters, { + BlurXFilter, + BlurYFilter, + }); + + const { Sprite, Texture } = PIXI; + + // 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`); + + return Sprite.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @see PIXI.Sprite.from + * @method PIXI.Sprite.fromImage + * @return {PIXI.Sprite} + */ + Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromSVG + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromCanvas + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromVideo + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromFrame + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); + + // 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`); + + return Texture.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromImage + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromImage = textureFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromSVG + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromCanvas + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromVideo + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromFrame + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); + + /** + * @deprecated since 5.0.0 + * @member {boolean} PIXI.AbstractRenderer#autoResize + * @see PIXI.AbstractRenderer#autoDensity + */ + Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { + get() + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + return this.autoDensity; + }, + set(value) + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + this.autoDensity = value; + }, + }); +} diff --git a/bundles/pixi.js/test/index.js b/bundles/pixi.js/test/index.js index a29651e..9d6ea9d 100644 --- a/bundles/pixi.js/test/index.js +++ b/bundles/pixi.js/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/packages/math/test/Rectangle.js b/packages/math/test/Rectangle.js index be6f106..8e315db 100644 --- a/packages/math/test/Rectangle.js +++ b/packages/math/test/Rectangle.js @@ -165,8 +165,8 @@ expect(rect3.right).to.equal(20); expect(rect3.bottom).to.equal(20); - const rect5 = new PIXI.Rectangle(10, 10, 20, 25); - const rect6 = new PIXI.Rectangle(22, 24, 20, 20); + const rect5 = new Rectangle(10, 10, 20, 25); + const rect6 = new Rectangle(22, 24, 20, 20); rect5.fit(rect6); @@ -175,8 +175,8 @@ expect(rect5.right).to.equal(30); expect(rect5.bottom).to.equal(35); - const rect7 = new PIXI.Rectangle(11, 10, 20, 25); - const rect8 = new PIXI.Rectangle(10, 9, 13, 10); + const rect7 = new Rectangle(11, 10, 20, 25); + const rect8 = new Rectangle(10, 9, 13, 10); rect7.fit(rect8); diff --git a/bundles/pixi.js-legacy/src/index.js b/bundles/pixi.js-legacy/src/index.js index 6c9d2b8..f71fdb7 100644 --- a/bundles/pixi.js-legacy/src/index.js +++ b/bundles/pixi.js-legacy/src/index.js @@ -1,6 +1,6 @@ import '@pixi/polyfill'; -import { PIXI } from 'pixi.js'; +import { Application, accessibility, interaction, prepare, extract } from 'pixi.js'; import { autoDetectRenderer, CanvasRenderer } from '@pixi/canvas-renderer'; import { CanvasMeshRenderer } from '@pixi/canvas-mesh'; import { CanvasGraphicsRenderer } from '@pixi/canvas-graphics'; @@ -11,28 +11,18 @@ import '@pixi/canvas-particles'; import '@pixi/canvas-display'; -CanvasRenderer.registerPlugin('accessibility', PIXI.accessibility.AccessibilityManager); +CanvasRenderer.registerPlugin('accessibility', accessibility.AccessibilityManager); CanvasRenderer.registerPlugin('extract', canvasExtract.CanvasExtract); CanvasRenderer.registerPlugin('graphics', CanvasGraphicsRenderer); -CanvasRenderer.registerPlugin('interaction', PIXI.interaction.InteractionManager); +CanvasRenderer.registerPlugin('interaction', interaction.InteractionManager); CanvasRenderer.registerPlugin('mesh', CanvasMeshRenderer); CanvasRenderer.registerPlugin('prepare', canvasPrepare.CanvasPrepare); CanvasRenderer.registerPlugin('sprite', CanvasSpriteRenderer); -Object.assign(PIXI.prepare, canvasPrepare); -Object.assign(PIXI.extract, canvasExtract); +Object.assign(prepare, canvasPrepare); +Object.assign(extract, canvasExtract); -PIXI.Application.prototype.createRenderer = autoDetectRenderer; - -// Add to namespace window object for people doing `import 'pixi.js-legacy'` -Object.assign(PIXI, { - autoDetectRenderer, - CanvasRenderer, - CanvasGraphicsRenderer, - CanvasMeshRenderer, - CanvasSpriteRenderer, - CanvasTinter, -}); +Application.prototype.createRenderer = autoDetectRenderer; // Export ES for those importing specifically by name, // e.g., `import {autoDetectRenderer} from 'pixi.js-legacy'` diff --git a/bundles/pixi.js-legacy/test/index.js b/bundles/pixi.js-legacy/test/index.js index a29651e..15e82dd 100755 --- a/bundles/pixi.js-legacy/test/index.js +++ b/bundles/pixi.js-legacy/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi-legacy'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js deleted file mode 100644 index ad04323..0000000 --- a/bundles/pixi.js/src/deprecated.js +++ /dev/null @@ -1,909 +0,0 @@ -import { deprecation } from '@pixi/utils'; - -const v5 = '5.0.0'; - -export default function deprecated(PIXI) -{ - Object.defineProperties(PIXI, { - /** - * @constant {RegExp|string} SVG_SIZE - * @memberof PIXI - * @see PIXI.resources.SVGResource.SVG_SIZE - * @deprecated since 5.0.0 - */ - SVG_SIZE: { - get() - { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); - - return PIXI.SVGResource.SVG_SIZE; - }, - }, - - /** - * @class PIXI.TransformStatic - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformStatic: { - get() - { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * @class PIXI.TransformBase - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformBase: { - get() - { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * Constants that specify the transform type. - * - * @static - * @constant - * @name TRANSFORM_MODE - * @memberof PIXI - * @enum {number} - * @deprecated since 5.0.0 - * @property {number} STATIC - * @property {number} DYNAMIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); - - return { STATIC: 0, DYNAMIC: 1 }; - }, - }, - - /** - * @class PIXI.WebGLRenderer - * @see PIXI.Renderer - * @deprecated since 5.0.0 - */ - WebGLRenderer: { - get() - { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); - - return PIXI.Renderer; - }, - }, - - /** - * @class PIXI.CanvasRenderTarget - * @see PIXI.utils.CanvasRenderTarget - * @deprecated since 5.0.0 - */ - CanvasRenderTarget: { - get() - { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); - - return PIXI.utils.CanvasRenderTarget; - }, - }, - - /** - * @memberof PIXI - * @name loader - * @type {PIXI.Loader} - * @see PIXI.Loader.shared - * @deprecated since 5.0.0 - */ - loader: { - get() - { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); - - return PIXI.Loader.shared; - }, - }, - - /** - * @class PIXI.FilterManager - * @see PIXI.systems.FilterSystem - * @deprecated since 5.0.0 - */ - FilterManager: { - get() - { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); - - return PIXI.systems.FilterManager; - }, - }, - }); - - /** - * This namespace has been removed. All classes previous nested - * under this namespace have been moved to the top-level `PIXI` object. - * @namespace PIXI.extras - * @deprecated since 5.0.0 - */ - PIXI.extras = {}; - - Object.defineProperties(PIXI.extras, { - /** - * @class PIXI.extras.TilingSprite - * @see PIXI.TilingSprite - * @deprecated since 5.0.0 - */ - TilingSprite: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); - - return PIXI.TilingSprite; - }, - }, - /** - * @class PIXI.extras.TilingSpriteRenderer - * @see PIXI.TilingSpriteRenderer - * @deprecated since 5.0.0 - */ - TilingSpriteRenderer: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); - - return PIXI.TilingSpriteRenderer; - }, - }, - /** - * @class PIXI.extras.AnimatedSprite - * @see PIXI.AnimatedSprite - * @deprecated since 5.0.0 - */ - AnimatedSprite: { - get() - { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); - - return PIXI.AnimatedSprite; - }, - }, - /** - * @class PIXI.extras.BitmapText - * @see PIXI.BitmapText - * @deprecated since 5.0.0 - */ - BitmapText: { - get() - { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); - - return PIXI.BitmapText; - }, - }, - }); - - Object.defineProperties(PIXI.utils, { - /** - * @function PIXI.utils.getSvgSize - * @see PIXI.resources.SVGResource.getSize - * @deprecated since 5.0.0 - */ - getSvgSize: { - get() - { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); - - return PIXI.SVGResource.getSize; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.mesh - * @deprecated since 5.0.0 - */ - PIXI.mesh = {}; - - Object.defineProperties(PIXI.mesh, { - /** - * @class PIXI.mesh.Mesh - * @see PIXI.SimpleMesh - * @deprecated since 5.0.0 - */ - Mesh: { - get() - { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); - - return PIXI.SimpleMesh; - }, - }, - /** - * @class PIXI.mesh.NineSlicePlane - * @see PIXI.NineSlicePlane - * @deprecated since 5.0.0 - */ - NineSlicePlane: { - get() - { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); - - return PIXI.NineSlicePlane; - }, - }, - /** - * @class PIXI.mesh.Plane - * @see PIXI.SimplePlane - * @deprecated since 5.0.0 - */ - Plane: { - get() - { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); - - return PIXI.SimplePlane; - }, - }, - /** - * @class PIXI.mesh.Rope - * @see PIXI.SimpleRope - * @deprecated since 5.0.0 - */ - Rope: { - get() - { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); - - return PIXI.SimpleRope; - }, - }, - /** - * @class PIXI.mesh.RawMesh - * @see PIXI.Mesh - * @deprecated since 5.0.0 - */ - RawMesh: { - get() - { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); - - return PIXI.Mesh; - }, - }, - /** - * @class PIXI.mesh.CanvasMeshRenderer - * @see PIXI.CanvasMeshRenderer - * @deprecated since 5.0.0 - */ - CanvasMeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); - - return PIXI.CanvasMeshRenderer; - }, - }, - /** - * @class PIXI.mesh.MeshRenderer - * @see PIXI.MeshRenderer - * @deprecated since 5.0.0 - */ - MeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); - - return PIXI.MeshRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.particles - * @deprecated since 5.0.0 - */ - PIXI.particles = {}; - - Object.defineProperties(PIXI.particles, { - /** - * @class PIXI.particles.ParticleContainer - * @deprecated since 5.0.0 - * @see PIXI.ParticleContainer - */ - ParticleContainer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); - - return PIXI.ParticleContainer; - }, - }, - /** - * @class PIXI.particles.ParticleRenderer - * @deprecated since 5.0.0 - * @see PIXI.ParticleRenderer - */ - ParticleRenderer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); - - return PIXI.ParticleRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.ticker - * @deprecated since 5.0.0 - */ - PIXI.ticker = {}; - - Object.defineProperties(PIXI.ticker, { - /** - * @class PIXI.ticker.Ticker - * @deprecated since 5.0.0 - * @see PIXI.Ticker - */ - Ticker: { - get() - { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); - - return PIXI.Ticker; - }, - }, - /** - * @name PIXI.ticker.shared - * @type {PIXI.Ticker} - * @deprecated since 5.0.0 - * @see PIXI.Ticker.shared - */ - shared: { - get() - { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); - - return PIXI.Ticker.shared; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.loaders - * @deprecated since 5.0.0 - */ - PIXI.loaders = {}; - - Object.defineProperties(PIXI.loaders, { - /** - * @class PIXI.loaders.Loader - * @see PIXI.Loader - * @deprecated since 5.0.0 - */ - Loader: { - get() - { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); - - return PIXI.Loader; - }, - }, - /** - * @class PIXI.loaders.Resource - * @see PIXI.LoaderResource - * @deprecated since 5.0.0 - */ - Resource: { - get() - { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); - - return PIXI.LoaderResource; - }, - }, - /** - * @function PIXI.loaders.bitmapFontParser - * @see PIXI.BitmapFontLoader.use - * @deprecated since 5.0.0 - */ - bitmapFontParser: { - get() - { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); - - return PIXI.BitmapFontLoader.use; - }, - }, - /** - * @function PIXI.loaders.parseBitmapFontData - * @see PIXI.BitmapFontLoader.parse - * @deprecated since 5.0.0 - */ - parseBitmapFontData: { - get() - { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); - - return PIXI.BitmapFontLoader.parse; - }, - }, - /** - * @function PIXI.loaders.spritesheetParser - * @see PIXI.SpritesheetLoader.use - * @deprecated since 5.0.0 - */ - spritesheetParser: { - get() - { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); - - return PIXI.SpritesheetLoader.use; - }, - }, - /** - * @function PIXI.loaders.getResourcePath - * @see PIXI.SpritesheetLoader.getResourcePath - * @deprecated since 5.0.0 - */ - getResourcePath: { - get() - { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); - - return PIXI.SpritesheetLoader.getResourcePath; - }, - }, - }); - - /** - * @function PIXI.loaders.Loader.addPixiMiddleware - * @see PIXI.Loader.registerPlugin - * @deprecated since 5.0.0 - * @param {function} middleware - */ - PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) - { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); - - return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); - }; - - /** - * @class PIXI.extract.WebGLExtract - * @deprecated since 5.0.0 - * @see PIXI.extract.Extract - */ - Object.defineProperty(PIXI.extract, 'WebGLExtract', { - get() - { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); - - return PIXI.extract.Extract; - }, - }); - - /** - * @class PIXI.prepare.WebGLPrepare - * @deprecated since 5.0.0 - * @see PIXI.prepare.Prepare - */ - Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { - get() - { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); - - return PIXI.prepare.Prepare; - }, - }); - - /** - * @method PIXI.Container#_renderWebGL - * @private - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); - - this._render(renderer); - }; - - /** - * @method PIXI.Container#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.DisplayObject#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.DisplayObject#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.Container#renderAdvancedWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#renderAdvanced - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); - - this.renderAdvanced(renderer); - }; - - Object.defineProperties(PIXI.settings, { - /** - * Default transform type. - * - * @static - * @deprecated since 5.0.0 - * @memberof PIXI.settings - * @type {PIXI.TRANSFORM_MODE} - * @default PIXI.TRANSFORM_MODE.STATIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - - return 0; - }, - set() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - }, - }, - }); - - const { BaseTexture } = PIXI; - - /** - * @method fromImage - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method fromCanvas - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) - { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); - - return BaseTexture.from(canvas, { scaleMode }); - }; - - /** - * @method fromSVG - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method PIXI.Point#copy - * @deprecated since 5.0.0 - * @see PIXI.Point#copyFrom - */ - PIXI.Point.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.ObservablePoint#copy - * @deprecated since 5.0.0 - * @see PIXI.ObservablePoint#copyFrom - */ - PIXI.ObservablePoint.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Rectangle#copy - * @deprecated since 5.0.0 - * @see PIXI.Rectangle#copyFrom - */ - PIXI.Rectangle.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Matrix#copy - * @deprecated since 5.0.0 - * @see PIXI.Matrix#copyTo - */ - PIXI.Matrix.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); - - return this.copyTo(p); - }; - - Object.assign(PIXI.systems.FilterSystem.prototype, { - /** - * @method PIXI.FilterManager#getRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#getFilterTexture - */ - getRenderTarget(clear, resolution) - { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); - - return this.getFilterTexture(resolution); - }, - - /** - * @method PIXI.FilterManager#returnRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#returnFilterTexture - */ - returnRenderTarget(renderTexture) - { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); - - this.returnFilterTexture(renderTexture); - }, - }); - - Object.defineProperties(PIXI.RenderTexture.prototype, { - /** - * @name PIXI.RenderTexture#sourceFrame - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - sourceFrame: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); - - return this.filterFrame; - }, - }, - /** - * @name PIXI.RenderTexture#size - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - size: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); - - return this._frame; - }, - }, - }); - - /** - * @class BlurXFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurXFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(true, strength, quality, resolution, kernelSize); - } - } - - /** - * @class BlurYFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurYFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(false, strength, quality, resolution, kernelSize); - } - } - - Object.assign(PIXI.filters, { - BlurXFilter, - BlurYFilter, - }); - - const { Sprite, Texture } = PIXI; - - // 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`); - - return Sprite.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @see PIXI.Sprite.from - * @method PIXI.Sprite.fromImage - * @return {PIXI.Sprite} - */ - Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromSVG - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromCanvas - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromVideo - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromFrame - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); - - // 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`); - - return Texture.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromImage - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromImage = textureFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromSVG - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromCanvas - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromVideo - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromFrame - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); - - /** - * @deprecated since 5.0.0 - * @member {boolean} PIXI.AbstractRenderer#autoResize - * @see PIXI.AbstractRenderer#autoDensity - */ - Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { - get() - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - return this.autoDensity; - }, - set(value) - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - this.autoDensity = value; - }, - }); -} diff --git a/bundles/pixi.js/src/index.js b/bundles/pixi.js/src/index.js index 9e80f0d..554ef58 100644 --- a/bundles/pixi.js/src/index.js +++ b/bundles/pixi.js/src/index.js @@ -1,26 +1,16 @@ import * as accessibility from '@pixi/accessibility'; -import * as app from '@pixi/app'; -import * as constants from '@pixi/constants'; -import * as core from '@pixi/core'; -import * as display from '@pixi/display'; import * as extract from '@pixi/extract'; -import * as graphics from '@pixi/graphics'; import * as interaction from '@pixi/interaction'; -import * as loaders from '@pixi/loaders'; -import * as math from '@pixi/math'; -import * as mesh from '@pixi/mesh'; -import * as meshExtras from '@pixi/mesh-extras'; -import * as particles from '@pixi/particles'; import * as prepare from '@pixi/prepare'; -import * as sprite from '@pixi/sprite'; -import * as spriteAnimated from '@pixi/sprite-animated'; -import * as spritesheet from '@pixi/spritesheet'; -import * as spriteTiling from '@pixi/sprite-tiling'; -import * as text from '@pixi/text'; -import * as textBitmap from '@pixi/text-bitmap'; -import * as ticker from '@pixi/ticker'; import * as utils from '@pixi/utils'; -import { settings } from '@pixi/settings'; +import { Application } from '@pixi/app'; +import { Renderer, BatchRenderer } from '@pixi/core'; +import { Loader, AppLoaderPlugin } from '@pixi/loaders'; +import { ParticleRenderer } from '@pixi/particles'; +import { SpritesheetLoader } from '@pixi/spritesheet'; +import { TilingSpriteRenderer } from '@pixi/sprite-tiling'; +import { BitmapFontLoader } from '@pixi/text-bitmap'; +import { TickerPlugin } from '@pixi/ticker'; import { AlphaFilter } from '@pixi/filter-alpha'; import { BlurFilter, BlurFilterPass } from '@pixi/filter-blur'; import { ColorMatrixFilter } from '@pixi/filter-color-matrix'; @@ -30,22 +20,26 @@ import '@pixi/mixin-cache-as-bitmap'; import '@pixi/mixin-get-child-by-name'; import '@pixi/mixin-get-global-position'; -import deprecated from './deprecated'; + +// Export deprecations so Rollup can call it +// in the footer after global is defined +// other module must call this manually +import useDeprecated from './useDeprecated'; // Install renderer plugins -core.Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); -core.Renderer.registerPlugin('extract', extract.Extract); -core.Renderer.registerPlugin('interaction', interaction.InteractionManager); -core.Renderer.registerPlugin('particle', particles.ParticleRenderer); -core.Renderer.registerPlugin('prepare', prepare.Prepare); -core.Renderer.registerPlugin('batch', core.BatchRenderer); -core.Renderer.registerPlugin('tilingSprite', spriteTiling.TilingSpriteRenderer); +Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); +Renderer.registerPlugin('extract', extract.Extract); +Renderer.registerPlugin('interaction', interaction.InteractionManager); +Renderer.registerPlugin('particle', ParticleRenderer); +Renderer.registerPlugin('prepare', prepare.Prepare); +Renderer.registerPlugin('batch', BatchRenderer); +Renderer.registerPlugin('tilingSprite', TilingSpriteRenderer); -loaders.Loader.registerPlugin(textBitmap.BitmapFontLoader); -loaders.Loader.registerPlugin(spritesheet.SpritesheetLoader); +Loader.registerPlugin(BitmapFontLoader); +Loader.registerPlugin(SpritesheetLoader); -app.Application.registerPlugin(ticker.TickerPlugin); -app.Application.registerPlugin(loaders.AppLoaderPlugin); +Application.registerPlugin(TickerPlugin); +Application.registerPlugin(AppLoaderPlugin); // Apply deplayed mixins utils.mixins.performMixins(); @@ -59,12 +53,11 @@ * @name VERSION * @type {string} */ -const VERSION = '__VERSION__'; +export const VERSION = '__VERSION__'; /** * @namespace PIXI */ -const PIXI = { VERSION }; /** * This namespace contains WebGL-only display filters that can be applied @@ -93,7 +86,7 @@ * document.body.appendChild(app.view); * @namespace PIXI.filters */ -const filters = { +export const filters = { AlphaFilter, BlurFilter, BlurFilterPass, @@ -103,47 +96,7 @@ NoiseFilter, }; -// Add to namespace window object for people doing `import 'pixi.js'` -if (typeof window !== 'undefined') -{ - const namespaces = { - accessibility, - extract, - filters, - interaction, - prepare, - settings, - utils, - }; - - window.PIXI = Object.assign( - PIXI, - namespaces, - app, - constants, - core, - display, - graphics, - loaders, - math, - mesh, - meshExtras, - particles, - sprite, - spriteAnimated, - spritesheet, - spriteTiling, - text, - textBitmap, - ticker - ); - - // Deprecations only apply to Window object - deprecated(PIXI); -} - // Export ES for those importing specifically by name, -// e.g., `import {autoDetectRenderer} from 'pixi.js'` export * from '@pixi/app'; export * from '@pixi/constants'; export * from '@pixi/core'; @@ -161,14 +114,12 @@ export * from '@pixi/text'; export * from '@pixi/text-bitmap'; export * from '@pixi/ticker'; +export * from '@pixi/settings'; export { - PIXI, - VERSION, accessibility, extract, - filters, interaction, prepare, - settings, utils, + useDeprecated, }; diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js new file mode 100644 index 0000000..4eaba3b --- /dev/null +++ b/bundles/pixi.js/src/useDeprecated.js @@ -0,0 +1,921 @@ +import { deprecation } from '@pixi/utils'; + +const v5 = '5.0.0'; + +/** + * Deprecations (backward compatibilities) are automatically applied for browser bundles + * in the UMD module format. If using Webpack or Rollup, you'll need to apply these + * deprecations manually by doing something like this: + * @example + * import * as PIXI from 'pixi.js'; + * PIXI.useDeprecated(); // MUST be bound to namespace + * @memberof PIXI + * @function useDeprecated + */ +export default function useDeprecated() +{ + const PIXI = this; + + Object.defineProperties(PIXI, { + /** + * @constant {RegExp|string} SVG_SIZE + * @memberof PIXI + * @see PIXI.resources.SVGResource.SVG_SIZE + * @deprecated since 5.0.0 + */ + SVG_SIZE: { + get() + { + deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + + return PIXI.SVGResource.SVG_SIZE; + }, + }, + + /** + * @class PIXI.TransformStatic + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformStatic: { + get() + { + deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * @class PIXI.TransformBase + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformBase: { + get() + { + deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * Constants that specify the transform type. + * + * @static + * @constant + * @name TRANSFORM_MODE + * @memberof PIXI + * @enum {number} + * @deprecated since 5.0.0 + * @property {number} STATIC + * @property {number} DYNAMIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + + return { STATIC: 0, DYNAMIC: 1 }; + }, + }, + + /** + * @class PIXI.WebGLRenderer + * @see PIXI.Renderer + * @deprecated since 5.0.0 + */ + WebGLRenderer: { + get() + { + deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + + return PIXI.Renderer; + }, + }, + + /** + * @class PIXI.CanvasRenderTarget + * @see PIXI.utils.CanvasRenderTarget + * @deprecated since 5.0.0 + */ + CanvasRenderTarget: { + get() + { + deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + + return PIXI.utils.CanvasRenderTarget; + }, + }, + + /** + * @memberof PIXI + * @name loader + * @type {PIXI.Loader} + * @see PIXI.Loader.shared + * @deprecated since 5.0.0 + */ + loader: { + get() + { + deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + + return PIXI.Loader.shared; + }, + }, + + /** + * @class PIXI.FilterManager + * @see PIXI.systems.FilterSystem + * @deprecated since 5.0.0 + */ + FilterManager: { + get() + { + deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + + return PIXI.systems.FilterManager; + }, + }, + }); + + /** + * This namespace has been removed. All classes previous nested + * under this namespace have been moved to the top-level `PIXI` object. + * @namespace PIXI.extras + * @deprecated since 5.0.0 + */ + PIXI.extras = {}; + + Object.defineProperties(PIXI.extras, { + /** + * @class PIXI.extras.TilingSprite + * @see PIXI.TilingSprite + * @deprecated since 5.0.0 + */ + TilingSprite: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + + return PIXI.TilingSprite; + }, + }, + /** + * @class PIXI.extras.TilingSpriteRenderer + * @see PIXI.TilingSpriteRenderer + * @deprecated since 5.0.0 + */ + TilingSpriteRenderer: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + + return PIXI.TilingSpriteRenderer; + }, + }, + /** + * @class PIXI.extras.AnimatedSprite + * @see PIXI.AnimatedSprite + * @deprecated since 5.0.0 + */ + AnimatedSprite: { + get() + { + deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + + return PIXI.AnimatedSprite; + }, + }, + /** + * @class PIXI.extras.BitmapText + * @see PIXI.BitmapText + * @deprecated since 5.0.0 + */ + BitmapText: { + get() + { + deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + + return PIXI.BitmapText; + }, + }, + }); + + Object.defineProperties(PIXI.utils, { + /** + * @function PIXI.utils.getSvgSize + * @see PIXI.resources.SVGResource.getSize + * @deprecated since 5.0.0 + */ + getSvgSize: { + get() + { + deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + + return PIXI.SVGResource.getSize; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.mesh + * @deprecated since 5.0.0 + */ + PIXI.mesh = {}; + + Object.defineProperties(PIXI.mesh, { + /** + * @class PIXI.mesh.Mesh + * @see PIXI.SimpleMesh + * @deprecated since 5.0.0 + */ + Mesh: { + get() + { + deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + + return PIXI.SimpleMesh; + }, + }, + /** + * @class PIXI.mesh.NineSlicePlane + * @see PIXI.NineSlicePlane + * @deprecated since 5.0.0 + */ + NineSlicePlane: { + get() + { + deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + + return PIXI.NineSlicePlane; + }, + }, + /** + * @class PIXI.mesh.Plane + * @see PIXI.SimplePlane + * @deprecated since 5.0.0 + */ + Plane: { + get() + { + deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + + return PIXI.SimplePlane; + }, + }, + /** + * @class PIXI.mesh.Rope + * @see PIXI.SimpleRope + * @deprecated since 5.0.0 + */ + Rope: { + get() + { + deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + + return PIXI.SimpleRope; + }, + }, + /** + * @class PIXI.mesh.RawMesh + * @see PIXI.Mesh + * @deprecated since 5.0.0 + */ + RawMesh: { + get() + { + deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + + return PIXI.Mesh; + }, + }, + /** + * @class PIXI.mesh.CanvasMeshRenderer + * @see PIXI.CanvasMeshRenderer + * @deprecated since 5.0.0 + */ + CanvasMeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + + return PIXI.CanvasMeshRenderer; + }, + }, + /** + * @class PIXI.mesh.MeshRenderer + * @see PIXI.MeshRenderer + * @deprecated since 5.0.0 + */ + MeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + + return PIXI.MeshRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.particles + * @deprecated since 5.0.0 + */ + PIXI.particles = {}; + + Object.defineProperties(PIXI.particles, { + /** + * @class PIXI.particles.ParticleContainer + * @deprecated since 5.0.0 + * @see PIXI.ParticleContainer + */ + ParticleContainer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + + return PIXI.ParticleContainer; + }, + }, + /** + * @class PIXI.particles.ParticleRenderer + * @deprecated since 5.0.0 + * @see PIXI.ParticleRenderer + */ + ParticleRenderer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + + return PIXI.ParticleRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.ticker + * @deprecated since 5.0.0 + */ + PIXI.ticker = {}; + + Object.defineProperties(PIXI.ticker, { + /** + * @class PIXI.ticker.Ticker + * @deprecated since 5.0.0 + * @see PIXI.Ticker + */ + Ticker: { + get() + { + deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + + return PIXI.Ticker; + }, + }, + /** + * @name PIXI.ticker.shared + * @type {PIXI.Ticker} + * @deprecated since 5.0.0 + * @see PIXI.Ticker.shared + */ + shared: { + get() + { + deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + + return PIXI.Ticker.shared; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.loaders + * @deprecated since 5.0.0 + */ + PIXI.loaders = {}; + + Object.defineProperties(PIXI.loaders, { + /** + * @class PIXI.loaders.Loader + * @see PIXI.Loader + * @deprecated since 5.0.0 + */ + Loader: { + get() + { + deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + + return PIXI.Loader; + }, + }, + /** + * @class PIXI.loaders.Resource + * @see PIXI.LoaderResource + * @deprecated since 5.0.0 + */ + Resource: { + get() + { + deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + + return PIXI.LoaderResource; + }, + }, + /** + * @function PIXI.loaders.bitmapFontParser + * @see PIXI.BitmapFontLoader.use + * @deprecated since 5.0.0 + */ + bitmapFontParser: { + get() + { + deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + + return PIXI.BitmapFontLoader.use; + }, + }, + /** + * @function PIXI.loaders.parseBitmapFontData + * @see PIXI.BitmapFontLoader.parse + * @deprecated since 5.0.0 + */ + parseBitmapFontData: { + get() + { + deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + + return PIXI.BitmapFontLoader.parse; + }, + }, + /** + * @function PIXI.loaders.spritesheetParser + * @see PIXI.SpritesheetLoader.use + * @deprecated since 5.0.0 + */ + spritesheetParser: { + get() + { + deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + + return PIXI.SpritesheetLoader.use; + }, + }, + /** + * @function PIXI.loaders.getResourcePath + * @see PIXI.SpritesheetLoader.getResourcePath + * @deprecated since 5.0.0 + */ + getResourcePath: { + get() + { + deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + + return PIXI.SpritesheetLoader.getResourcePath; + }, + }, + }); + + /** + * @function PIXI.loaders.Loader.addPixiMiddleware + * @see PIXI.Loader.registerPlugin + * @deprecated since 5.0.0 + * @param {function} middleware + */ + PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) + { + deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + + return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); + }; + + /** + * @class PIXI.extract.WebGLExtract + * @deprecated since 5.0.0 + * @see PIXI.extract.Extract + */ + Object.defineProperty(PIXI.extract, 'WebGLExtract', { + get() + { + deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + + return PIXI.extract.Extract; + }, + }); + + /** + * @class PIXI.prepare.WebGLPrepare + * @deprecated since 5.0.0 + * @see PIXI.prepare.Prepare + */ + Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { + get() + { + deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + + return PIXI.prepare.Prepare; + }, + }); + + /** + * @method PIXI.Container#_renderWebGL + * @private + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + + this._render(renderer); + }; + + /** + * @method PIXI.Container#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.DisplayObject#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.DisplayObject#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.Container#renderAdvancedWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#renderAdvanced + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + + this.renderAdvanced(renderer); + }; + + Object.defineProperties(PIXI.settings, { + /** + * Default transform type. + * + * @static + * @deprecated since 5.0.0 + * @memberof PIXI.settings + * @type {PIXI.TRANSFORM_MODE} + * @default PIXI.TRANSFORM_MODE.STATIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + + return 0; + }, + set() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + }, + }, + }); + + const { BaseTexture } = PIXI; + + /** + * @method fromImage + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method fromCanvas + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) + { + deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + + return BaseTexture.from(canvas, { scaleMode }); + }; + + /** + * @method fromSVG + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method PIXI.Point#copy + * @deprecated since 5.0.0 + * @see PIXI.Point#copyFrom + */ + PIXI.Point.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.ObservablePoint#copy + * @deprecated since 5.0.0 + * @see PIXI.ObservablePoint#copyFrom + */ + PIXI.ObservablePoint.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Rectangle#copy + * @deprecated since 5.0.0 + * @see PIXI.Rectangle#copyFrom + */ + PIXI.Rectangle.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Matrix#copy + * @deprecated since 5.0.0 + * @see PIXI.Matrix#copyTo + */ + PIXI.Matrix.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + + return this.copyTo(p); + }; + + Object.assign(PIXI.systems.FilterSystem.prototype, { + /** + * @method PIXI.FilterManager#getRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#getFilterTexture + */ + getRenderTarget(clear, resolution) + { + deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + + return this.getFilterTexture(resolution); + }, + + /** + * @method PIXI.FilterManager#returnRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#returnFilterTexture + */ + returnRenderTarget(renderTexture) + { + deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + + this.returnFilterTexture(renderTexture); + }, + }); + + Object.defineProperties(PIXI.RenderTexture.prototype, { + /** + * @name PIXI.RenderTexture#sourceFrame + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + sourceFrame: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + + return this.filterFrame; + }, + }, + /** + * @name PIXI.RenderTexture#size + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + size: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + + return this._frame; + }, + }, + }); + + /** + * @class BlurXFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurXFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(true, strength, quality, resolution, kernelSize); + } + } + + /** + * @class BlurYFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurYFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(false, strength, quality, resolution, kernelSize); + } + } + + Object.assign(PIXI.filters, { + BlurXFilter, + BlurYFilter, + }); + + const { Sprite, Texture } = PIXI; + + // 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`); + + return Sprite.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @see PIXI.Sprite.from + * @method PIXI.Sprite.fromImage + * @return {PIXI.Sprite} + */ + Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromSVG + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromCanvas + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromVideo + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromFrame + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); + + // 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`); + + return Texture.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromImage + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromImage = textureFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromSVG + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromCanvas + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromVideo + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromFrame + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); + + /** + * @deprecated since 5.0.0 + * @member {boolean} PIXI.AbstractRenderer#autoResize + * @see PIXI.AbstractRenderer#autoDensity + */ + Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { + get() + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + return this.autoDensity; + }, + set(value) + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + this.autoDensity = value; + }, + }); +} diff --git a/bundles/pixi.js/test/index.js b/bundles/pixi.js/test/index.js index a29651e..9d6ea9d 100644 --- a/bundles/pixi.js/test/index.js +++ b/bundles/pixi.js/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/packages/math/test/Rectangle.js b/packages/math/test/Rectangle.js index be6f106..8e315db 100644 --- a/packages/math/test/Rectangle.js +++ b/packages/math/test/Rectangle.js @@ -165,8 +165,8 @@ expect(rect3.right).to.equal(20); expect(rect3.bottom).to.equal(20); - const rect5 = new PIXI.Rectangle(10, 10, 20, 25); - const rect6 = new PIXI.Rectangle(22, 24, 20, 20); + const rect5 = new Rectangle(10, 10, 20, 25); + const rect6 = new Rectangle(22, 24, 20, 20); rect5.fit(rect6); @@ -175,8 +175,8 @@ expect(rect5.right).to.equal(30); expect(rect5.bottom).to.equal(35); - const rect7 = new PIXI.Rectangle(11, 10, 20, 25); - const rect8 = new PIXI.Rectangle(10, 9, 13, 10); + const rect7 = new Rectangle(11, 10, 20, 25); + const rect8 = new Rectangle(10, 9, 13, 10); rect7.fit(rect8); diff --git a/packages/text/test/TextMetrics.js b/packages/text/test/TextMetrics.js index 9b29d0d..7dccc0f 100644 --- a/packages/text/test/TextMetrics.js +++ b/packages/text/test/TextMetrics.js @@ -128,7 +128,7 @@ it('should be able to override wordWrap to false in measureText', function () { - const metrics = PIXI.TextMetrics.measureText(longText, new PIXI.TextStyle(defaultStyle), false); + const metrics = TextMetrics.measureText(longText, new TextStyle(defaultStyle), false); expect(metrics.lines.length).to.equal(1); }); diff --git a/bundles/pixi.js-legacy/src/index.js b/bundles/pixi.js-legacy/src/index.js index 6c9d2b8..f71fdb7 100644 --- a/bundles/pixi.js-legacy/src/index.js +++ b/bundles/pixi.js-legacy/src/index.js @@ -1,6 +1,6 @@ import '@pixi/polyfill'; -import { PIXI } from 'pixi.js'; +import { Application, accessibility, interaction, prepare, extract } from 'pixi.js'; import { autoDetectRenderer, CanvasRenderer } from '@pixi/canvas-renderer'; import { CanvasMeshRenderer } from '@pixi/canvas-mesh'; import { CanvasGraphicsRenderer } from '@pixi/canvas-graphics'; @@ -11,28 +11,18 @@ import '@pixi/canvas-particles'; import '@pixi/canvas-display'; -CanvasRenderer.registerPlugin('accessibility', PIXI.accessibility.AccessibilityManager); +CanvasRenderer.registerPlugin('accessibility', accessibility.AccessibilityManager); CanvasRenderer.registerPlugin('extract', canvasExtract.CanvasExtract); CanvasRenderer.registerPlugin('graphics', CanvasGraphicsRenderer); -CanvasRenderer.registerPlugin('interaction', PIXI.interaction.InteractionManager); +CanvasRenderer.registerPlugin('interaction', interaction.InteractionManager); CanvasRenderer.registerPlugin('mesh', CanvasMeshRenderer); CanvasRenderer.registerPlugin('prepare', canvasPrepare.CanvasPrepare); CanvasRenderer.registerPlugin('sprite', CanvasSpriteRenderer); -Object.assign(PIXI.prepare, canvasPrepare); -Object.assign(PIXI.extract, canvasExtract); +Object.assign(prepare, canvasPrepare); +Object.assign(extract, canvasExtract); -PIXI.Application.prototype.createRenderer = autoDetectRenderer; - -// Add to namespace window object for people doing `import 'pixi.js-legacy'` -Object.assign(PIXI, { - autoDetectRenderer, - CanvasRenderer, - CanvasGraphicsRenderer, - CanvasMeshRenderer, - CanvasSpriteRenderer, - CanvasTinter, -}); +Application.prototype.createRenderer = autoDetectRenderer; // Export ES for those importing specifically by name, // e.g., `import {autoDetectRenderer} from 'pixi.js-legacy'` diff --git a/bundles/pixi.js-legacy/test/index.js b/bundles/pixi.js-legacy/test/index.js index a29651e..15e82dd 100755 --- a/bundles/pixi.js-legacy/test/index.js +++ b/bundles/pixi.js-legacy/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi-legacy'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js deleted file mode 100644 index ad04323..0000000 --- a/bundles/pixi.js/src/deprecated.js +++ /dev/null @@ -1,909 +0,0 @@ -import { deprecation } from '@pixi/utils'; - -const v5 = '5.0.0'; - -export default function deprecated(PIXI) -{ - Object.defineProperties(PIXI, { - /** - * @constant {RegExp|string} SVG_SIZE - * @memberof PIXI - * @see PIXI.resources.SVGResource.SVG_SIZE - * @deprecated since 5.0.0 - */ - SVG_SIZE: { - get() - { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); - - return PIXI.SVGResource.SVG_SIZE; - }, - }, - - /** - * @class PIXI.TransformStatic - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformStatic: { - get() - { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * @class PIXI.TransformBase - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformBase: { - get() - { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * Constants that specify the transform type. - * - * @static - * @constant - * @name TRANSFORM_MODE - * @memberof PIXI - * @enum {number} - * @deprecated since 5.0.0 - * @property {number} STATIC - * @property {number} DYNAMIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); - - return { STATIC: 0, DYNAMIC: 1 }; - }, - }, - - /** - * @class PIXI.WebGLRenderer - * @see PIXI.Renderer - * @deprecated since 5.0.0 - */ - WebGLRenderer: { - get() - { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); - - return PIXI.Renderer; - }, - }, - - /** - * @class PIXI.CanvasRenderTarget - * @see PIXI.utils.CanvasRenderTarget - * @deprecated since 5.0.0 - */ - CanvasRenderTarget: { - get() - { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); - - return PIXI.utils.CanvasRenderTarget; - }, - }, - - /** - * @memberof PIXI - * @name loader - * @type {PIXI.Loader} - * @see PIXI.Loader.shared - * @deprecated since 5.0.0 - */ - loader: { - get() - { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); - - return PIXI.Loader.shared; - }, - }, - - /** - * @class PIXI.FilterManager - * @see PIXI.systems.FilterSystem - * @deprecated since 5.0.0 - */ - FilterManager: { - get() - { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); - - return PIXI.systems.FilterManager; - }, - }, - }); - - /** - * This namespace has been removed. All classes previous nested - * under this namespace have been moved to the top-level `PIXI` object. - * @namespace PIXI.extras - * @deprecated since 5.0.0 - */ - PIXI.extras = {}; - - Object.defineProperties(PIXI.extras, { - /** - * @class PIXI.extras.TilingSprite - * @see PIXI.TilingSprite - * @deprecated since 5.0.0 - */ - TilingSprite: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); - - return PIXI.TilingSprite; - }, - }, - /** - * @class PIXI.extras.TilingSpriteRenderer - * @see PIXI.TilingSpriteRenderer - * @deprecated since 5.0.0 - */ - TilingSpriteRenderer: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); - - return PIXI.TilingSpriteRenderer; - }, - }, - /** - * @class PIXI.extras.AnimatedSprite - * @see PIXI.AnimatedSprite - * @deprecated since 5.0.0 - */ - AnimatedSprite: { - get() - { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); - - return PIXI.AnimatedSprite; - }, - }, - /** - * @class PIXI.extras.BitmapText - * @see PIXI.BitmapText - * @deprecated since 5.0.0 - */ - BitmapText: { - get() - { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); - - return PIXI.BitmapText; - }, - }, - }); - - Object.defineProperties(PIXI.utils, { - /** - * @function PIXI.utils.getSvgSize - * @see PIXI.resources.SVGResource.getSize - * @deprecated since 5.0.0 - */ - getSvgSize: { - get() - { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); - - return PIXI.SVGResource.getSize; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.mesh - * @deprecated since 5.0.0 - */ - PIXI.mesh = {}; - - Object.defineProperties(PIXI.mesh, { - /** - * @class PIXI.mesh.Mesh - * @see PIXI.SimpleMesh - * @deprecated since 5.0.0 - */ - Mesh: { - get() - { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); - - return PIXI.SimpleMesh; - }, - }, - /** - * @class PIXI.mesh.NineSlicePlane - * @see PIXI.NineSlicePlane - * @deprecated since 5.0.0 - */ - NineSlicePlane: { - get() - { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); - - return PIXI.NineSlicePlane; - }, - }, - /** - * @class PIXI.mesh.Plane - * @see PIXI.SimplePlane - * @deprecated since 5.0.0 - */ - Plane: { - get() - { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); - - return PIXI.SimplePlane; - }, - }, - /** - * @class PIXI.mesh.Rope - * @see PIXI.SimpleRope - * @deprecated since 5.0.0 - */ - Rope: { - get() - { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); - - return PIXI.SimpleRope; - }, - }, - /** - * @class PIXI.mesh.RawMesh - * @see PIXI.Mesh - * @deprecated since 5.0.0 - */ - RawMesh: { - get() - { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); - - return PIXI.Mesh; - }, - }, - /** - * @class PIXI.mesh.CanvasMeshRenderer - * @see PIXI.CanvasMeshRenderer - * @deprecated since 5.0.0 - */ - CanvasMeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); - - return PIXI.CanvasMeshRenderer; - }, - }, - /** - * @class PIXI.mesh.MeshRenderer - * @see PIXI.MeshRenderer - * @deprecated since 5.0.0 - */ - MeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); - - return PIXI.MeshRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.particles - * @deprecated since 5.0.0 - */ - PIXI.particles = {}; - - Object.defineProperties(PIXI.particles, { - /** - * @class PIXI.particles.ParticleContainer - * @deprecated since 5.0.0 - * @see PIXI.ParticleContainer - */ - ParticleContainer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); - - return PIXI.ParticleContainer; - }, - }, - /** - * @class PIXI.particles.ParticleRenderer - * @deprecated since 5.0.0 - * @see PIXI.ParticleRenderer - */ - ParticleRenderer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); - - return PIXI.ParticleRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.ticker - * @deprecated since 5.0.0 - */ - PIXI.ticker = {}; - - Object.defineProperties(PIXI.ticker, { - /** - * @class PIXI.ticker.Ticker - * @deprecated since 5.0.0 - * @see PIXI.Ticker - */ - Ticker: { - get() - { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); - - return PIXI.Ticker; - }, - }, - /** - * @name PIXI.ticker.shared - * @type {PIXI.Ticker} - * @deprecated since 5.0.0 - * @see PIXI.Ticker.shared - */ - shared: { - get() - { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); - - return PIXI.Ticker.shared; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.loaders - * @deprecated since 5.0.0 - */ - PIXI.loaders = {}; - - Object.defineProperties(PIXI.loaders, { - /** - * @class PIXI.loaders.Loader - * @see PIXI.Loader - * @deprecated since 5.0.0 - */ - Loader: { - get() - { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); - - return PIXI.Loader; - }, - }, - /** - * @class PIXI.loaders.Resource - * @see PIXI.LoaderResource - * @deprecated since 5.0.0 - */ - Resource: { - get() - { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); - - return PIXI.LoaderResource; - }, - }, - /** - * @function PIXI.loaders.bitmapFontParser - * @see PIXI.BitmapFontLoader.use - * @deprecated since 5.0.0 - */ - bitmapFontParser: { - get() - { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); - - return PIXI.BitmapFontLoader.use; - }, - }, - /** - * @function PIXI.loaders.parseBitmapFontData - * @see PIXI.BitmapFontLoader.parse - * @deprecated since 5.0.0 - */ - parseBitmapFontData: { - get() - { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); - - return PIXI.BitmapFontLoader.parse; - }, - }, - /** - * @function PIXI.loaders.spritesheetParser - * @see PIXI.SpritesheetLoader.use - * @deprecated since 5.0.0 - */ - spritesheetParser: { - get() - { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); - - return PIXI.SpritesheetLoader.use; - }, - }, - /** - * @function PIXI.loaders.getResourcePath - * @see PIXI.SpritesheetLoader.getResourcePath - * @deprecated since 5.0.0 - */ - getResourcePath: { - get() - { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); - - return PIXI.SpritesheetLoader.getResourcePath; - }, - }, - }); - - /** - * @function PIXI.loaders.Loader.addPixiMiddleware - * @see PIXI.Loader.registerPlugin - * @deprecated since 5.0.0 - * @param {function} middleware - */ - PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) - { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); - - return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); - }; - - /** - * @class PIXI.extract.WebGLExtract - * @deprecated since 5.0.0 - * @see PIXI.extract.Extract - */ - Object.defineProperty(PIXI.extract, 'WebGLExtract', { - get() - { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); - - return PIXI.extract.Extract; - }, - }); - - /** - * @class PIXI.prepare.WebGLPrepare - * @deprecated since 5.0.0 - * @see PIXI.prepare.Prepare - */ - Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { - get() - { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); - - return PIXI.prepare.Prepare; - }, - }); - - /** - * @method PIXI.Container#_renderWebGL - * @private - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); - - this._render(renderer); - }; - - /** - * @method PIXI.Container#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.DisplayObject#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.DisplayObject#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.Container#renderAdvancedWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#renderAdvanced - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); - - this.renderAdvanced(renderer); - }; - - Object.defineProperties(PIXI.settings, { - /** - * Default transform type. - * - * @static - * @deprecated since 5.0.0 - * @memberof PIXI.settings - * @type {PIXI.TRANSFORM_MODE} - * @default PIXI.TRANSFORM_MODE.STATIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - - return 0; - }, - set() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - }, - }, - }); - - const { BaseTexture } = PIXI; - - /** - * @method fromImage - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method fromCanvas - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) - { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); - - return BaseTexture.from(canvas, { scaleMode }); - }; - - /** - * @method fromSVG - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method PIXI.Point#copy - * @deprecated since 5.0.0 - * @see PIXI.Point#copyFrom - */ - PIXI.Point.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.ObservablePoint#copy - * @deprecated since 5.0.0 - * @see PIXI.ObservablePoint#copyFrom - */ - PIXI.ObservablePoint.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Rectangle#copy - * @deprecated since 5.0.0 - * @see PIXI.Rectangle#copyFrom - */ - PIXI.Rectangle.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Matrix#copy - * @deprecated since 5.0.0 - * @see PIXI.Matrix#copyTo - */ - PIXI.Matrix.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); - - return this.copyTo(p); - }; - - Object.assign(PIXI.systems.FilterSystem.prototype, { - /** - * @method PIXI.FilterManager#getRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#getFilterTexture - */ - getRenderTarget(clear, resolution) - { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); - - return this.getFilterTexture(resolution); - }, - - /** - * @method PIXI.FilterManager#returnRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#returnFilterTexture - */ - returnRenderTarget(renderTexture) - { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); - - this.returnFilterTexture(renderTexture); - }, - }); - - Object.defineProperties(PIXI.RenderTexture.prototype, { - /** - * @name PIXI.RenderTexture#sourceFrame - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - sourceFrame: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); - - return this.filterFrame; - }, - }, - /** - * @name PIXI.RenderTexture#size - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - size: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); - - return this._frame; - }, - }, - }); - - /** - * @class BlurXFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurXFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(true, strength, quality, resolution, kernelSize); - } - } - - /** - * @class BlurYFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurYFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(false, strength, quality, resolution, kernelSize); - } - } - - Object.assign(PIXI.filters, { - BlurXFilter, - BlurYFilter, - }); - - const { Sprite, Texture } = PIXI; - - // 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`); - - return Sprite.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @see PIXI.Sprite.from - * @method PIXI.Sprite.fromImage - * @return {PIXI.Sprite} - */ - Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromSVG - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromCanvas - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromVideo - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromFrame - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); - - // 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`); - - return Texture.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromImage - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromImage = textureFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromSVG - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromCanvas - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromVideo - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromFrame - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); - - /** - * @deprecated since 5.0.0 - * @member {boolean} PIXI.AbstractRenderer#autoResize - * @see PIXI.AbstractRenderer#autoDensity - */ - Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { - get() - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - return this.autoDensity; - }, - set(value) - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - this.autoDensity = value; - }, - }); -} diff --git a/bundles/pixi.js/src/index.js b/bundles/pixi.js/src/index.js index 9e80f0d..554ef58 100644 --- a/bundles/pixi.js/src/index.js +++ b/bundles/pixi.js/src/index.js @@ -1,26 +1,16 @@ import * as accessibility from '@pixi/accessibility'; -import * as app from '@pixi/app'; -import * as constants from '@pixi/constants'; -import * as core from '@pixi/core'; -import * as display from '@pixi/display'; import * as extract from '@pixi/extract'; -import * as graphics from '@pixi/graphics'; import * as interaction from '@pixi/interaction'; -import * as loaders from '@pixi/loaders'; -import * as math from '@pixi/math'; -import * as mesh from '@pixi/mesh'; -import * as meshExtras from '@pixi/mesh-extras'; -import * as particles from '@pixi/particles'; import * as prepare from '@pixi/prepare'; -import * as sprite from '@pixi/sprite'; -import * as spriteAnimated from '@pixi/sprite-animated'; -import * as spritesheet from '@pixi/spritesheet'; -import * as spriteTiling from '@pixi/sprite-tiling'; -import * as text from '@pixi/text'; -import * as textBitmap from '@pixi/text-bitmap'; -import * as ticker from '@pixi/ticker'; import * as utils from '@pixi/utils'; -import { settings } from '@pixi/settings'; +import { Application } from '@pixi/app'; +import { Renderer, BatchRenderer } from '@pixi/core'; +import { Loader, AppLoaderPlugin } from '@pixi/loaders'; +import { ParticleRenderer } from '@pixi/particles'; +import { SpritesheetLoader } from '@pixi/spritesheet'; +import { TilingSpriteRenderer } from '@pixi/sprite-tiling'; +import { BitmapFontLoader } from '@pixi/text-bitmap'; +import { TickerPlugin } from '@pixi/ticker'; import { AlphaFilter } from '@pixi/filter-alpha'; import { BlurFilter, BlurFilterPass } from '@pixi/filter-blur'; import { ColorMatrixFilter } from '@pixi/filter-color-matrix'; @@ -30,22 +20,26 @@ import '@pixi/mixin-cache-as-bitmap'; import '@pixi/mixin-get-child-by-name'; import '@pixi/mixin-get-global-position'; -import deprecated from './deprecated'; + +// Export deprecations so Rollup can call it +// in the footer after global is defined +// other module must call this manually +import useDeprecated from './useDeprecated'; // Install renderer plugins -core.Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); -core.Renderer.registerPlugin('extract', extract.Extract); -core.Renderer.registerPlugin('interaction', interaction.InteractionManager); -core.Renderer.registerPlugin('particle', particles.ParticleRenderer); -core.Renderer.registerPlugin('prepare', prepare.Prepare); -core.Renderer.registerPlugin('batch', core.BatchRenderer); -core.Renderer.registerPlugin('tilingSprite', spriteTiling.TilingSpriteRenderer); +Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); +Renderer.registerPlugin('extract', extract.Extract); +Renderer.registerPlugin('interaction', interaction.InteractionManager); +Renderer.registerPlugin('particle', ParticleRenderer); +Renderer.registerPlugin('prepare', prepare.Prepare); +Renderer.registerPlugin('batch', BatchRenderer); +Renderer.registerPlugin('tilingSprite', TilingSpriteRenderer); -loaders.Loader.registerPlugin(textBitmap.BitmapFontLoader); -loaders.Loader.registerPlugin(spritesheet.SpritesheetLoader); +Loader.registerPlugin(BitmapFontLoader); +Loader.registerPlugin(SpritesheetLoader); -app.Application.registerPlugin(ticker.TickerPlugin); -app.Application.registerPlugin(loaders.AppLoaderPlugin); +Application.registerPlugin(TickerPlugin); +Application.registerPlugin(AppLoaderPlugin); // Apply deplayed mixins utils.mixins.performMixins(); @@ -59,12 +53,11 @@ * @name VERSION * @type {string} */ -const VERSION = '__VERSION__'; +export const VERSION = '__VERSION__'; /** * @namespace PIXI */ -const PIXI = { VERSION }; /** * This namespace contains WebGL-only display filters that can be applied @@ -93,7 +86,7 @@ * document.body.appendChild(app.view); * @namespace PIXI.filters */ -const filters = { +export const filters = { AlphaFilter, BlurFilter, BlurFilterPass, @@ -103,47 +96,7 @@ NoiseFilter, }; -// Add to namespace window object for people doing `import 'pixi.js'` -if (typeof window !== 'undefined') -{ - const namespaces = { - accessibility, - extract, - filters, - interaction, - prepare, - settings, - utils, - }; - - window.PIXI = Object.assign( - PIXI, - namespaces, - app, - constants, - core, - display, - graphics, - loaders, - math, - mesh, - meshExtras, - particles, - sprite, - spriteAnimated, - spritesheet, - spriteTiling, - text, - textBitmap, - ticker - ); - - // Deprecations only apply to Window object - deprecated(PIXI); -} - // Export ES for those importing specifically by name, -// e.g., `import {autoDetectRenderer} from 'pixi.js'` export * from '@pixi/app'; export * from '@pixi/constants'; export * from '@pixi/core'; @@ -161,14 +114,12 @@ export * from '@pixi/text'; export * from '@pixi/text-bitmap'; export * from '@pixi/ticker'; +export * from '@pixi/settings'; export { - PIXI, - VERSION, accessibility, extract, - filters, interaction, prepare, - settings, utils, + useDeprecated, }; diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js new file mode 100644 index 0000000..4eaba3b --- /dev/null +++ b/bundles/pixi.js/src/useDeprecated.js @@ -0,0 +1,921 @@ +import { deprecation } from '@pixi/utils'; + +const v5 = '5.0.0'; + +/** + * Deprecations (backward compatibilities) are automatically applied for browser bundles + * in the UMD module format. If using Webpack or Rollup, you'll need to apply these + * deprecations manually by doing something like this: + * @example + * import * as PIXI from 'pixi.js'; + * PIXI.useDeprecated(); // MUST be bound to namespace + * @memberof PIXI + * @function useDeprecated + */ +export default function useDeprecated() +{ + const PIXI = this; + + Object.defineProperties(PIXI, { + /** + * @constant {RegExp|string} SVG_SIZE + * @memberof PIXI + * @see PIXI.resources.SVGResource.SVG_SIZE + * @deprecated since 5.0.0 + */ + SVG_SIZE: { + get() + { + deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + + return PIXI.SVGResource.SVG_SIZE; + }, + }, + + /** + * @class PIXI.TransformStatic + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformStatic: { + get() + { + deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * @class PIXI.TransformBase + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformBase: { + get() + { + deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * Constants that specify the transform type. + * + * @static + * @constant + * @name TRANSFORM_MODE + * @memberof PIXI + * @enum {number} + * @deprecated since 5.0.0 + * @property {number} STATIC + * @property {number} DYNAMIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + + return { STATIC: 0, DYNAMIC: 1 }; + }, + }, + + /** + * @class PIXI.WebGLRenderer + * @see PIXI.Renderer + * @deprecated since 5.0.0 + */ + WebGLRenderer: { + get() + { + deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + + return PIXI.Renderer; + }, + }, + + /** + * @class PIXI.CanvasRenderTarget + * @see PIXI.utils.CanvasRenderTarget + * @deprecated since 5.0.0 + */ + CanvasRenderTarget: { + get() + { + deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + + return PIXI.utils.CanvasRenderTarget; + }, + }, + + /** + * @memberof PIXI + * @name loader + * @type {PIXI.Loader} + * @see PIXI.Loader.shared + * @deprecated since 5.0.0 + */ + loader: { + get() + { + deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + + return PIXI.Loader.shared; + }, + }, + + /** + * @class PIXI.FilterManager + * @see PIXI.systems.FilterSystem + * @deprecated since 5.0.0 + */ + FilterManager: { + get() + { + deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + + return PIXI.systems.FilterManager; + }, + }, + }); + + /** + * This namespace has been removed. All classes previous nested + * under this namespace have been moved to the top-level `PIXI` object. + * @namespace PIXI.extras + * @deprecated since 5.0.0 + */ + PIXI.extras = {}; + + Object.defineProperties(PIXI.extras, { + /** + * @class PIXI.extras.TilingSprite + * @see PIXI.TilingSprite + * @deprecated since 5.0.0 + */ + TilingSprite: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + + return PIXI.TilingSprite; + }, + }, + /** + * @class PIXI.extras.TilingSpriteRenderer + * @see PIXI.TilingSpriteRenderer + * @deprecated since 5.0.0 + */ + TilingSpriteRenderer: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + + return PIXI.TilingSpriteRenderer; + }, + }, + /** + * @class PIXI.extras.AnimatedSprite + * @see PIXI.AnimatedSprite + * @deprecated since 5.0.0 + */ + AnimatedSprite: { + get() + { + deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + + return PIXI.AnimatedSprite; + }, + }, + /** + * @class PIXI.extras.BitmapText + * @see PIXI.BitmapText + * @deprecated since 5.0.0 + */ + BitmapText: { + get() + { + deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + + return PIXI.BitmapText; + }, + }, + }); + + Object.defineProperties(PIXI.utils, { + /** + * @function PIXI.utils.getSvgSize + * @see PIXI.resources.SVGResource.getSize + * @deprecated since 5.0.0 + */ + getSvgSize: { + get() + { + deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + + return PIXI.SVGResource.getSize; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.mesh + * @deprecated since 5.0.0 + */ + PIXI.mesh = {}; + + Object.defineProperties(PIXI.mesh, { + /** + * @class PIXI.mesh.Mesh + * @see PIXI.SimpleMesh + * @deprecated since 5.0.0 + */ + Mesh: { + get() + { + deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + + return PIXI.SimpleMesh; + }, + }, + /** + * @class PIXI.mesh.NineSlicePlane + * @see PIXI.NineSlicePlane + * @deprecated since 5.0.0 + */ + NineSlicePlane: { + get() + { + deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + + return PIXI.NineSlicePlane; + }, + }, + /** + * @class PIXI.mesh.Plane + * @see PIXI.SimplePlane + * @deprecated since 5.0.0 + */ + Plane: { + get() + { + deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + + return PIXI.SimplePlane; + }, + }, + /** + * @class PIXI.mesh.Rope + * @see PIXI.SimpleRope + * @deprecated since 5.0.0 + */ + Rope: { + get() + { + deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + + return PIXI.SimpleRope; + }, + }, + /** + * @class PIXI.mesh.RawMesh + * @see PIXI.Mesh + * @deprecated since 5.0.0 + */ + RawMesh: { + get() + { + deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + + return PIXI.Mesh; + }, + }, + /** + * @class PIXI.mesh.CanvasMeshRenderer + * @see PIXI.CanvasMeshRenderer + * @deprecated since 5.0.0 + */ + CanvasMeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + + return PIXI.CanvasMeshRenderer; + }, + }, + /** + * @class PIXI.mesh.MeshRenderer + * @see PIXI.MeshRenderer + * @deprecated since 5.0.0 + */ + MeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + + return PIXI.MeshRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.particles + * @deprecated since 5.0.0 + */ + PIXI.particles = {}; + + Object.defineProperties(PIXI.particles, { + /** + * @class PIXI.particles.ParticleContainer + * @deprecated since 5.0.0 + * @see PIXI.ParticleContainer + */ + ParticleContainer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + + return PIXI.ParticleContainer; + }, + }, + /** + * @class PIXI.particles.ParticleRenderer + * @deprecated since 5.0.0 + * @see PIXI.ParticleRenderer + */ + ParticleRenderer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + + return PIXI.ParticleRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.ticker + * @deprecated since 5.0.0 + */ + PIXI.ticker = {}; + + Object.defineProperties(PIXI.ticker, { + /** + * @class PIXI.ticker.Ticker + * @deprecated since 5.0.0 + * @see PIXI.Ticker + */ + Ticker: { + get() + { + deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + + return PIXI.Ticker; + }, + }, + /** + * @name PIXI.ticker.shared + * @type {PIXI.Ticker} + * @deprecated since 5.0.0 + * @see PIXI.Ticker.shared + */ + shared: { + get() + { + deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + + return PIXI.Ticker.shared; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.loaders + * @deprecated since 5.0.0 + */ + PIXI.loaders = {}; + + Object.defineProperties(PIXI.loaders, { + /** + * @class PIXI.loaders.Loader + * @see PIXI.Loader + * @deprecated since 5.0.0 + */ + Loader: { + get() + { + deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + + return PIXI.Loader; + }, + }, + /** + * @class PIXI.loaders.Resource + * @see PIXI.LoaderResource + * @deprecated since 5.0.0 + */ + Resource: { + get() + { + deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + + return PIXI.LoaderResource; + }, + }, + /** + * @function PIXI.loaders.bitmapFontParser + * @see PIXI.BitmapFontLoader.use + * @deprecated since 5.0.0 + */ + bitmapFontParser: { + get() + { + deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + + return PIXI.BitmapFontLoader.use; + }, + }, + /** + * @function PIXI.loaders.parseBitmapFontData + * @see PIXI.BitmapFontLoader.parse + * @deprecated since 5.0.0 + */ + parseBitmapFontData: { + get() + { + deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + + return PIXI.BitmapFontLoader.parse; + }, + }, + /** + * @function PIXI.loaders.spritesheetParser + * @see PIXI.SpritesheetLoader.use + * @deprecated since 5.0.0 + */ + spritesheetParser: { + get() + { + deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + + return PIXI.SpritesheetLoader.use; + }, + }, + /** + * @function PIXI.loaders.getResourcePath + * @see PIXI.SpritesheetLoader.getResourcePath + * @deprecated since 5.0.0 + */ + getResourcePath: { + get() + { + deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + + return PIXI.SpritesheetLoader.getResourcePath; + }, + }, + }); + + /** + * @function PIXI.loaders.Loader.addPixiMiddleware + * @see PIXI.Loader.registerPlugin + * @deprecated since 5.0.0 + * @param {function} middleware + */ + PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) + { + deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + + return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); + }; + + /** + * @class PIXI.extract.WebGLExtract + * @deprecated since 5.0.0 + * @see PIXI.extract.Extract + */ + Object.defineProperty(PIXI.extract, 'WebGLExtract', { + get() + { + deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + + return PIXI.extract.Extract; + }, + }); + + /** + * @class PIXI.prepare.WebGLPrepare + * @deprecated since 5.0.0 + * @see PIXI.prepare.Prepare + */ + Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { + get() + { + deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + + return PIXI.prepare.Prepare; + }, + }); + + /** + * @method PIXI.Container#_renderWebGL + * @private + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + + this._render(renderer); + }; + + /** + * @method PIXI.Container#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.DisplayObject#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.DisplayObject#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.Container#renderAdvancedWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#renderAdvanced + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + + this.renderAdvanced(renderer); + }; + + Object.defineProperties(PIXI.settings, { + /** + * Default transform type. + * + * @static + * @deprecated since 5.0.0 + * @memberof PIXI.settings + * @type {PIXI.TRANSFORM_MODE} + * @default PIXI.TRANSFORM_MODE.STATIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + + return 0; + }, + set() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + }, + }, + }); + + const { BaseTexture } = PIXI; + + /** + * @method fromImage + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method fromCanvas + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) + { + deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + + return BaseTexture.from(canvas, { scaleMode }); + }; + + /** + * @method fromSVG + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method PIXI.Point#copy + * @deprecated since 5.0.0 + * @see PIXI.Point#copyFrom + */ + PIXI.Point.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.ObservablePoint#copy + * @deprecated since 5.0.0 + * @see PIXI.ObservablePoint#copyFrom + */ + PIXI.ObservablePoint.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Rectangle#copy + * @deprecated since 5.0.0 + * @see PIXI.Rectangle#copyFrom + */ + PIXI.Rectangle.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Matrix#copy + * @deprecated since 5.0.0 + * @see PIXI.Matrix#copyTo + */ + PIXI.Matrix.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + + return this.copyTo(p); + }; + + Object.assign(PIXI.systems.FilterSystem.prototype, { + /** + * @method PIXI.FilterManager#getRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#getFilterTexture + */ + getRenderTarget(clear, resolution) + { + deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + + return this.getFilterTexture(resolution); + }, + + /** + * @method PIXI.FilterManager#returnRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#returnFilterTexture + */ + returnRenderTarget(renderTexture) + { + deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + + this.returnFilterTexture(renderTexture); + }, + }); + + Object.defineProperties(PIXI.RenderTexture.prototype, { + /** + * @name PIXI.RenderTexture#sourceFrame + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + sourceFrame: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + + return this.filterFrame; + }, + }, + /** + * @name PIXI.RenderTexture#size + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + size: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + + return this._frame; + }, + }, + }); + + /** + * @class BlurXFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurXFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(true, strength, quality, resolution, kernelSize); + } + } + + /** + * @class BlurYFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurYFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(false, strength, quality, resolution, kernelSize); + } + } + + Object.assign(PIXI.filters, { + BlurXFilter, + BlurYFilter, + }); + + const { Sprite, Texture } = PIXI; + + // 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`); + + return Sprite.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @see PIXI.Sprite.from + * @method PIXI.Sprite.fromImage + * @return {PIXI.Sprite} + */ + Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromSVG + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromCanvas + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromVideo + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromFrame + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); + + // 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`); + + return Texture.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromImage + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromImage = textureFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromSVG + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromCanvas + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromVideo + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromFrame + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); + + /** + * @deprecated since 5.0.0 + * @member {boolean} PIXI.AbstractRenderer#autoResize + * @see PIXI.AbstractRenderer#autoDensity + */ + Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { + get() + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + return this.autoDensity; + }, + set(value) + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + this.autoDensity = value; + }, + }); +} diff --git a/bundles/pixi.js/test/index.js b/bundles/pixi.js/test/index.js index a29651e..9d6ea9d 100644 --- a/bundles/pixi.js/test/index.js +++ b/bundles/pixi.js/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/packages/math/test/Rectangle.js b/packages/math/test/Rectangle.js index be6f106..8e315db 100644 --- a/packages/math/test/Rectangle.js +++ b/packages/math/test/Rectangle.js @@ -165,8 +165,8 @@ expect(rect3.right).to.equal(20); expect(rect3.bottom).to.equal(20); - const rect5 = new PIXI.Rectangle(10, 10, 20, 25); - const rect6 = new PIXI.Rectangle(22, 24, 20, 20); + const rect5 = new Rectangle(10, 10, 20, 25); + const rect6 = new Rectangle(22, 24, 20, 20); rect5.fit(rect6); @@ -175,8 +175,8 @@ expect(rect5.right).to.equal(30); expect(rect5.bottom).to.equal(35); - const rect7 = new PIXI.Rectangle(11, 10, 20, 25); - const rect8 = new PIXI.Rectangle(10, 9, 13, 10); + const rect7 = new Rectangle(11, 10, 20, 25); + const rect8 = new Rectangle(10, 9, 13, 10); rect7.fit(rect8); diff --git a/packages/text/test/TextMetrics.js b/packages/text/test/TextMetrics.js index 9b29d0d..7dccc0f 100644 --- a/packages/text/test/TextMetrics.js +++ b/packages/text/test/TextMetrics.js @@ -128,7 +128,7 @@ it('should be able to override wordWrap to false in measureText', function () { - const metrics = PIXI.TextMetrics.measureText(longText, new PIXI.TextStyle(defaultStyle), false); + const metrics = TextMetrics.measureText(longText, new TextStyle(defaultStyle), false); expect(metrics.lines.length).to.equal(1); }); diff --git a/packages/utils/test/index.js b/packages/utils/test/index.js index 40018a4..82f0f2a 100755 --- a/packages/utils/test/index.js +++ b/packages/utils/test/index.js @@ -241,7 +241,7 @@ { it('should exist', function () { - expect(PIXI.utils.earcut).to.be.a('function'); + expect(utils.earcut).to.be.a('function'); }); }); }); diff --git a/bundles/pixi.js-legacy/src/index.js b/bundles/pixi.js-legacy/src/index.js index 6c9d2b8..f71fdb7 100644 --- a/bundles/pixi.js-legacy/src/index.js +++ b/bundles/pixi.js-legacy/src/index.js @@ -1,6 +1,6 @@ import '@pixi/polyfill'; -import { PIXI } from 'pixi.js'; +import { Application, accessibility, interaction, prepare, extract } from 'pixi.js'; import { autoDetectRenderer, CanvasRenderer } from '@pixi/canvas-renderer'; import { CanvasMeshRenderer } from '@pixi/canvas-mesh'; import { CanvasGraphicsRenderer } from '@pixi/canvas-graphics'; @@ -11,28 +11,18 @@ import '@pixi/canvas-particles'; import '@pixi/canvas-display'; -CanvasRenderer.registerPlugin('accessibility', PIXI.accessibility.AccessibilityManager); +CanvasRenderer.registerPlugin('accessibility', accessibility.AccessibilityManager); CanvasRenderer.registerPlugin('extract', canvasExtract.CanvasExtract); CanvasRenderer.registerPlugin('graphics', CanvasGraphicsRenderer); -CanvasRenderer.registerPlugin('interaction', PIXI.interaction.InteractionManager); +CanvasRenderer.registerPlugin('interaction', interaction.InteractionManager); CanvasRenderer.registerPlugin('mesh', CanvasMeshRenderer); CanvasRenderer.registerPlugin('prepare', canvasPrepare.CanvasPrepare); CanvasRenderer.registerPlugin('sprite', CanvasSpriteRenderer); -Object.assign(PIXI.prepare, canvasPrepare); -Object.assign(PIXI.extract, canvasExtract); +Object.assign(prepare, canvasPrepare); +Object.assign(extract, canvasExtract); -PIXI.Application.prototype.createRenderer = autoDetectRenderer; - -// Add to namespace window object for people doing `import 'pixi.js-legacy'` -Object.assign(PIXI, { - autoDetectRenderer, - CanvasRenderer, - CanvasGraphicsRenderer, - CanvasMeshRenderer, - CanvasSpriteRenderer, - CanvasTinter, -}); +Application.prototype.createRenderer = autoDetectRenderer; // Export ES for those importing specifically by name, // e.g., `import {autoDetectRenderer} from 'pixi.js-legacy'` diff --git a/bundles/pixi.js-legacy/test/index.js b/bundles/pixi.js-legacy/test/index.js index a29651e..15e82dd 100755 --- a/bundles/pixi.js-legacy/test/index.js +++ b/bundles/pixi.js-legacy/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi-legacy'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/bundles/pixi.js/src/deprecated.js b/bundles/pixi.js/src/deprecated.js deleted file mode 100644 index ad04323..0000000 --- a/bundles/pixi.js/src/deprecated.js +++ /dev/null @@ -1,909 +0,0 @@ -import { deprecation } from '@pixi/utils'; - -const v5 = '5.0.0'; - -export default function deprecated(PIXI) -{ - Object.defineProperties(PIXI, { - /** - * @constant {RegExp|string} SVG_SIZE - * @memberof PIXI - * @see PIXI.resources.SVGResource.SVG_SIZE - * @deprecated since 5.0.0 - */ - SVG_SIZE: { - get() - { - deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); - - return PIXI.SVGResource.SVG_SIZE; - }, - }, - - /** - * @class PIXI.TransformStatic - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformStatic: { - get() - { - deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * @class PIXI.TransformBase - * @deprecated since 5.0.0 - * @see PIXI.Transform - */ - TransformBase: { - get() - { - deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); - - return PIXI.Transform; - }, - }, - - /** - * Constants that specify the transform type. - * - * @static - * @constant - * @name TRANSFORM_MODE - * @memberof PIXI - * @enum {number} - * @deprecated since 5.0.0 - * @property {number} STATIC - * @property {number} DYNAMIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); - - return { STATIC: 0, DYNAMIC: 1 }; - }, - }, - - /** - * @class PIXI.WebGLRenderer - * @see PIXI.Renderer - * @deprecated since 5.0.0 - */ - WebGLRenderer: { - get() - { - deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); - - return PIXI.Renderer; - }, - }, - - /** - * @class PIXI.CanvasRenderTarget - * @see PIXI.utils.CanvasRenderTarget - * @deprecated since 5.0.0 - */ - CanvasRenderTarget: { - get() - { - deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); - - return PIXI.utils.CanvasRenderTarget; - }, - }, - - /** - * @memberof PIXI - * @name loader - * @type {PIXI.Loader} - * @see PIXI.Loader.shared - * @deprecated since 5.0.0 - */ - loader: { - get() - { - deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); - - return PIXI.Loader.shared; - }, - }, - - /** - * @class PIXI.FilterManager - * @see PIXI.systems.FilterSystem - * @deprecated since 5.0.0 - */ - FilterManager: { - get() - { - deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); - - return PIXI.systems.FilterManager; - }, - }, - }); - - /** - * This namespace has been removed. All classes previous nested - * under this namespace have been moved to the top-level `PIXI` object. - * @namespace PIXI.extras - * @deprecated since 5.0.0 - */ - PIXI.extras = {}; - - Object.defineProperties(PIXI.extras, { - /** - * @class PIXI.extras.TilingSprite - * @see PIXI.TilingSprite - * @deprecated since 5.0.0 - */ - TilingSprite: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); - - return PIXI.TilingSprite; - }, - }, - /** - * @class PIXI.extras.TilingSpriteRenderer - * @see PIXI.TilingSpriteRenderer - * @deprecated since 5.0.0 - */ - TilingSpriteRenderer: { - get() - { - deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); - - return PIXI.TilingSpriteRenderer; - }, - }, - /** - * @class PIXI.extras.AnimatedSprite - * @see PIXI.AnimatedSprite - * @deprecated since 5.0.0 - */ - AnimatedSprite: { - get() - { - deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); - - return PIXI.AnimatedSprite; - }, - }, - /** - * @class PIXI.extras.BitmapText - * @see PIXI.BitmapText - * @deprecated since 5.0.0 - */ - BitmapText: { - get() - { - deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); - - return PIXI.BitmapText; - }, - }, - }); - - Object.defineProperties(PIXI.utils, { - /** - * @function PIXI.utils.getSvgSize - * @see PIXI.resources.SVGResource.getSize - * @deprecated since 5.0.0 - */ - getSvgSize: { - get() - { - deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); - - return PIXI.SVGResource.getSize; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.mesh - * @deprecated since 5.0.0 - */ - PIXI.mesh = {}; - - Object.defineProperties(PIXI.mesh, { - /** - * @class PIXI.mesh.Mesh - * @see PIXI.SimpleMesh - * @deprecated since 5.0.0 - */ - Mesh: { - get() - { - deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); - - return PIXI.SimpleMesh; - }, - }, - /** - * @class PIXI.mesh.NineSlicePlane - * @see PIXI.NineSlicePlane - * @deprecated since 5.0.0 - */ - NineSlicePlane: { - get() - { - deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); - - return PIXI.NineSlicePlane; - }, - }, - /** - * @class PIXI.mesh.Plane - * @see PIXI.SimplePlane - * @deprecated since 5.0.0 - */ - Plane: { - get() - { - deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); - - return PIXI.SimplePlane; - }, - }, - /** - * @class PIXI.mesh.Rope - * @see PIXI.SimpleRope - * @deprecated since 5.0.0 - */ - Rope: { - get() - { - deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); - - return PIXI.SimpleRope; - }, - }, - /** - * @class PIXI.mesh.RawMesh - * @see PIXI.Mesh - * @deprecated since 5.0.0 - */ - RawMesh: { - get() - { - deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); - - return PIXI.Mesh; - }, - }, - /** - * @class PIXI.mesh.CanvasMeshRenderer - * @see PIXI.CanvasMeshRenderer - * @deprecated since 5.0.0 - */ - CanvasMeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); - - return PIXI.CanvasMeshRenderer; - }, - }, - /** - * @class PIXI.mesh.MeshRenderer - * @see PIXI.MeshRenderer - * @deprecated since 5.0.0 - */ - MeshRenderer: { - get() - { - deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); - - return PIXI.MeshRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.particles - * @deprecated since 5.0.0 - */ - PIXI.particles = {}; - - Object.defineProperties(PIXI.particles, { - /** - * @class PIXI.particles.ParticleContainer - * @deprecated since 5.0.0 - * @see PIXI.ParticleContainer - */ - ParticleContainer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); - - return PIXI.ParticleContainer; - }, - }, - /** - * @class PIXI.particles.ParticleRenderer - * @deprecated since 5.0.0 - * @see PIXI.ParticleRenderer - */ - ParticleRenderer: { - get() - { - deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); - - return PIXI.ParticleRenderer; - }, - }, - }); - - /** - * This namespace has been removed and items have been moved to - * the top-level `PIXI` object. - * @namespace PIXI.ticker - * @deprecated since 5.0.0 - */ - PIXI.ticker = {}; - - Object.defineProperties(PIXI.ticker, { - /** - * @class PIXI.ticker.Ticker - * @deprecated since 5.0.0 - * @see PIXI.Ticker - */ - Ticker: { - get() - { - deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); - - return PIXI.Ticker; - }, - }, - /** - * @name PIXI.ticker.shared - * @type {PIXI.Ticker} - * @deprecated since 5.0.0 - * @see PIXI.Ticker.shared - */ - shared: { - get() - { - deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); - - return PIXI.Ticker.shared; - }, - }, - }); - - /** - * All classes on this namespace have moved to the high-level `PIXI` object. - * @namespace PIXI.loaders - * @deprecated since 5.0.0 - */ - PIXI.loaders = {}; - - Object.defineProperties(PIXI.loaders, { - /** - * @class PIXI.loaders.Loader - * @see PIXI.Loader - * @deprecated since 5.0.0 - */ - Loader: { - get() - { - deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); - - return PIXI.Loader; - }, - }, - /** - * @class PIXI.loaders.Resource - * @see PIXI.LoaderResource - * @deprecated since 5.0.0 - */ - Resource: { - get() - { - deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); - - return PIXI.LoaderResource; - }, - }, - /** - * @function PIXI.loaders.bitmapFontParser - * @see PIXI.BitmapFontLoader.use - * @deprecated since 5.0.0 - */ - bitmapFontParser: { - get() - { - deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); - - return PIXI.BitmapFontLoader.use; - }, - }, - /** - * @function PIXI.loaders.parseBitmapFontData - * @see PIXI.BitmapFontLoader.parse - * @deprecated since 5.0.0 - */ - parseBitmapFontData: { - get() - { - deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); - - return PIXI.BitmapFontLoader.parse; - }, - }, - /** - * @function PIXI.loaders.spritesheetParser - * @see PIXI.SpritesheetLoader.use - * @deprecated since 5.0.0 - */ - spritesheetParser: { - get() - { - deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); - - return PIXI.SpritesheetLoader.use; - }, - }, - /** - * @function PIXI.loaders.getResourcePath - * @see PIXI.SpritesheetLoader.getResourcePath - * @deprecated since 5.0.0 - */ - getResourcePath: { - get() - { - deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); - - return PIXI.SpritesheetLoader.getResourcePath; - }, - }, - }); - - /** - * @function PIXI.loaders.Loader.addPixiMiddleware - * @see PIXI.Loader.registerPlugin - * @deprecated since 5.0.0 - * @param {function} middleware - */ - PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) - { - deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); - - return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); - }; - - /** - * @class PIXI.extract.WebGLExtract - * @deprecated since 5.0.0 - * @see PIXI.extract.Extract - */ - Object.defineProperty(PIXI.extract, 'WebGLExtract', { - get() - { - deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); - - return PIXI.extract.Extract; - }, - }); - - /** - * @class PIXI.prepare.WebGLPrepare - * @deprecated since 5.0.0 - * @see PIXI.prepare.Prepare - */ - Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { - get() - { - deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); - - return PIXI.prepare.Prepare; - }, - }); - - /** - * @method PIXI.Container#_renderWebGL - * @private - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); - - this._render(renderer); - }; - - /** - * @method PIXI.Container#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.DisplayObject#renderWebGL - * @deprecated since 5.0.0 - * @see PIXI.DisplayObject#render - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) - { - deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); - - this.render(renderer); - }; - - /** - * @method PIXI.Container#renderAdvancedWebGL - * @deprecated since 5.0.0 - * @see PIXI.Container#renderAdvanced - * @param {PIXI.Renderer} renderer Instance of renderer - */ - PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) - { - deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); - - this.renderAdvanced(renderer); - }; - - Object.defineProperties(PIXI.settings, { - /** - * Default transform type. - * - * @static - * @deprecated since 5.0.0 - * @memberof PIXI.settings - * @type {PIXI.TRANSFORM_MODE} - * @default PIXI.TRANSFORM_MODE.STATIC - */ - TRANSFORM_MODE: { - get() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - - return 0; - }, - set() - { - deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); - }, - }, - }); - - const { BaseTexture } = PIXI; - - /** - * @method fromImage - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method fromCanvas - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) - { - deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); - - return BaseTexture.from(canvas, { scaleMode }); - }; - - /** - * @method fromSVG - * @static - * @memberof PIXI.BaseTexture - * @deprecated since 5.0.0 - * @see PIXI.BaseTexture.from - */ - BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) - { - deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); - - const resourceOptions = { scale, crossorigin }; - - return BaseTexture.from(canvas, { scaleMode, resourceOptions }); - }; - - /** - * @method PIXI.Point#copy - * @deprecated since 5.0.0 - * @see PIXI.Point#copyFrom - */ - PIXI.Point.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.ObservablePoint#copy - * @deprecated since 5.0.0 - * @see PIXI.ObservablePoint#copyFrom - */ - PIXI.ObservablePoint.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Rectangle#copy - * @deprecated since 5.0.0 - * @see PIXI.Rectangle#copyFrom - */ - PIXI.Rectangle.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); - - return this.copyFrom(p); - }; - - /** - * @method PIXI.Matrix#copy - * @deprecated since 5.0.0 - * @see PIXI.Matrix#copyTo - */ - PIXI.Matrix.prototype.copy = function copy(p) - { - deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); - - return this.copyTo(p); - }; - - Object.assign(PIXI.systems.FilterSystem.prototype, { - /** - * @method PIXI.FilterManager#getRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#getFilterTexture - */ - getRenderTarget(clear, resolution) - { - deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); - - return this.getFilterTexture(resolution); - }, - - /** - * @method PIXI.FilterManager#returnRenderTarget - * @deprecated since 5.0.0 - * @see PIXI.systems.FilterSystem#returnFilterTexture - */ - returnRenderTarget(renderTexture) - { - deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); - - this.returnFilterTexture(renderTexture); - }, - }); - - Object.defineProperties(PIXI.RenderTexture.prototype, { - /** - * @name PIXI.RenderTexture#sourceFrame - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - sourceFrame: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); - - return this.filterFrame; - }, - }, - /** - * @name PIXI.RenderTexture#size - * @type {PIXI.Rectangle} - * @deprecated since 5.0.0 - * @readonly - */ - size: { - get() - { - deprecation(v5, 'PIXI.RenderTexture#size has been removed'); - - return this._frame; - }, - }, - }); - - /** - * @class BlurXFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurXFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(true, strength, quality, resolution, kernelSize); - } - } - - /** - * @class BlurYFilter - * @memberof PIXI.filters - * @deprecated since 5.0.0 - * @see PIXI.filters.BlurFilterPass - */ - class BlurYFilter extends PIXI.filters.BlurFilterPass - { - constructor(strength, quality, resolution, kernelSize) - { - deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); - - super(false, strength, quality, resolution, kernelSize); - } - } - - Object.assign(PIXI.filters, { - BlurXFilter, - BlurYFilter, - }); - - const { Sprite, Texture } = PIXI; - - // 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`); - - return Sprite.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @see PIXI.Sprite.from - * @method PIXI.Sprite.fromImage - * @return {PIXI.Sprite} - */ - Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromSVG - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromCanvas - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromVideo - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Sprite.fromFrame - * @see PIXI.Sprite.from - * @return {PIXI.Sprite} - */ - Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); - - // 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`); - - return Texture.from(source, { - resourceOptions: { - scale: scaleMode, - crossorigin, - }, - }); - } - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromImage - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromImage = textureFrom.bind(null, 'fromImage'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromSVG - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromCanvas - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromVideo - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); - - /** - * @deprecated since 5.0.0 - * @method PIXI.Texture.fromFrame - * @see PIXI.Texture.from - * @return {PIXI.Texture} - */ - Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); - - /** - * @deprecated since 5.0.0 - * @member {boolean} PIXI.AbstractRenderer#autoResize - * @see PIXI.AbstractRenderer#autoDensity - */ - Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { - get() - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - return this.autoDensity; - }, - set(value) - { - deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); - - this.autoDensity = value; - }, - }); -} diff --git a/bundles/pixi.js/src/index.js b/bundles/pixi.js/src/index.js index 9e80f0d..554ef58 100644 --- a/bundles/pixi.js/src/index.js +++ b/bundles/pixi.js/src/index.js @@ -1,26 +1,16 @@ import * as accessibility from '@pixi/accessibility'; -import * as app from '@pixi/app'; -import * as constants from '@pixi/constants'; -import * as core from '@pixi/core'; -import * as display from '@pixi/display'; import * as extract from '@pixi/extract'; -import * as graphics from '@pixi/graphics'; import * as interaction from '@pixi/interaction'; -import * as loaders from '@pixi/loaders'; -import * as math from '@pixi/math'; -import * as mesh from '@pixi/mesh'; -import * as meshExtras from '@pixi/mesh-extras'; -import * as particles from '@pixi/particles'; import * as prepare from '@pixi/prepare'; -import * as sprite from '@pixi/sprite'; -import * as spriteAnimated from '@pixi/sprite-animated'; -import * as spritesheet from '@pixi/spritesheet'; -import * as spriteTiling from '@pixi/sprite-tiling'; -import * as text from '@pixi/text'; -import * as textBitmap from '@pixi/text-bitmap'; -import * as ticker from '@pixi/ticker'; import * as utils from '@pixi/utils'; -import { settings } from '@pixi/settings'; +import { Application } from '@pixi/app'; +import { Renderer, BatchRenderer } from '@pixi/core'; +import { Loader, AppLoaderPlugin } from '@pixi/loaders'; +import { ParticleRenderer } from '@pixi/particles'; +import { SpritesheetLoader } from '@pixi/spritesheet'; +import { TilingSpriteRenderer } from '@pixi/sprite-tiling'; +import { BitmapFontLoader } from '@pixi/text-bitmap'; +import { TickerPlugin } from '@pixi/ticker'; import { AlphaFilter } from '@pixi/filter-alpha'; import { BlurFilter, BlurFilterPass } from '@pixi/filter-blur'; import { ColorMatrixFilter } from '@pixi/filter-color-matrix'; @@ -30,22 +20,26 @@ import '@pixi/mixin-cache-as-bitmap'; import '@pixi/mixin-get-child-by-name'; import '@pixi/mixin-get-global-position'; -import deprecated from './deprecated'; + +// Export deprecations so Rollup can call it +// in the footer after global is defined +// other module must call this manually +import useDeprecated from './useDeprecated'; // Install renderer plugins -core.Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); -core.Renderer.registerPlugin('extract', extract.Extract); -core.Renderer.registerPlugin('interaction', interaction.InteractionManager); -core.Renderer.registerPlugin('particle', particles.ParticleRenderer); -core.Renderer.registerPlugin('prepare', prepare.Prepare); -core.Renderer.registerPlugin('batch', core.BatchRenderer); -core.Renderer.registerPlugin('tilingSprite', spriteTiling.TilingSpriteRenderer); +Renderer.registerPlugin('accessibility', accessibility.AccessibilityManager); +Renderer.registerPlugin('extract', extract.Extract); +Renderer.registerPlugin('interaction', interaction.InteractionManager); +Renderer.registerPlugin('particle', ParticleRenderer); +Renderer.registerPlugin('prepare', prepare.Prepare); +Renderer.registerPlugin('batch', BatchRenderer); +Renderer.registerPlugin('tilingSprite', TilingSpriteRenderer); -loaders.Loader.registerPlugin(textBitmap.BitmapFontLoader); -loaders.Loader.registerPlugin(spritesheet.SpritesheetLoader); +Loader.registerPlugin(BitmapFontLoader); +Loader.registerPlugin(SpritesheetLoader); -app.Application.registerPlugin(ticker.TickerPlugin); -app.Application.registerPlugin(loaders.AppLoaderPlugin); +Application.registerPlugin(TickerPlugin); +Application.registerPlugin(AppLoaderPlugin); // Apply deplayed mixins utils.mixins.performMixins(); @@ -59,12 +53,11 @@ * @name VERSION * @type {string} */ -const VERSION = '__VERSION__'; +export const VERSION = '__VERSION__'; /** * @namespace PIXI */ -const PIXI = { VERSION }; /** * This namespace contains WebGL-only display filters that can be applied @@ -93,7 +86,7 @@ * document.body.appendChild(app.view); * @namespace PIXI.filters */ -const filters = { +export const filters = { AlphaFilter, BlurFilter, BlurFilterPass, @@ -103,47 +96,7 @@ NoiseFilter, }; -// Add to namespace window object for people doing `import 'pixi.js'` -if (typeof window !== 'undefined') -{ - const namespaces = { - accessibility, - extract, - filters, - interaction, - prepare, - settings, - utils, - }; - - window.PIXI = Object.assign( - PIXI, - namespaces, - app, - constants, - core, - display, - graphics, - loaders, - math, - mesh, - meshExtras, - particles, - sprite, - spriteAnimated, - spritesheet, - spriteTiling, - text, - textBitmap, - ticker - ); - - // Deprecations only apply to Window object - deprecated(PIXI); -} - // Export ES for those importing specifically by name, -// e.g., `import {autoDetectRenderer} from 'pixi.js'` export * from '@pixi/app'; export * from '@pixi/constants'; export * from '@pixi/core'; @@ -161,14 +114,12 @@ export * from '@pixi/text'; export * from '@pixi/text-bitmap'; export * from '@pixi/ticker'; +export * from '@pixi/settings'; export { - PIXI, - VERSION, accessibility, extract, - filters, interaction, prepare, - settings, utils, + useDeprecated, }; diff --git a/bundles/pixi.js/src/useDeprecated.js b/bundles/pixi.js/src/useDeprecated.js new file mode 100644 index 0000000..4eaba3b --- /dev/null +++ b/bundles/pixi.js/src/useDeprecated.js @@ -0,0 +1,921 @@ +import { deprecation } from '@pixi/utils'; + +const v5 = '5.0.0'; + +/** + * Deprecations (backward compatibilities) are automatically applied for browser bundles + * in the UMD module format. If using Webpack or Rollup, you'll need to apply these + * deprecations manually by doing something like this: + * @example + * import * as PIXI from 'pixi.js'; + * PIXI.useDeprecated(); // MUST be bound to namespace + * @memberof PIXI + * @function useDeprecated + */ +export default function useDeprecated() +{ + const PIXI = this; + + Object.defineProperties(PIXI, { + /** + * @constant {RegExp|string} SVG_SIZE + * @memberof PIXI + * @see PIXI.resources.SVGResource.SVG_SIZE + * @deprecated since 5.0.0 + */ + SVG_SIZE: { + get() + { + deprecation(v5, 'PIXI.utils.SVG_SIZE has moved to PIXI.SVGResource.SVG_SIZE'); + + return PIXI.SVGResource.SVG_SIZE; + }, + }, + + /** + * @class PIXI.TransformStatic + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformStatic: { + get() + { + deprecation(v5, 'PIXI.TransformStatic has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * @class PIXI.TransformBase + * @deprecated since 5.0.0 + * @see PIXI.Transform + */ + TransformBase: { + get() + { + deprecation(v5, 'PIXI.TransformBase has been removed, use PIXI.Transform'); + + return PIXI.Transform; + }, + }, + + /** + * Constants that specify the transform type. + * + * @static + * @constant + * @name TRANSFORM_MODE + * @memberof PIXI + * @enum {number} + * @deprecated since 5.0.0 + * @property {number} STATIC + * @property {number} DYNAMIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.TRANSFORM_MODE has been removed'); + + return { STATIC: 0, DYNAMIC: 1 }; + }, + }, + + /** + * @class PIXI.WebGLRenderer + * @see PIXI.Renderer + * @deprecated since 5.0.0 + */ + WebGLRenderer: { + get() + { + deprecation(v5, 'PIXI.WebGLRenderer has moved to PIXI.Renderer'); + + return PIXI.Renderer; + }, + }, + + /** + * @class PIXI.CanvasRenderTarget + * @see PIXI.utils.CanvasRenderTarget + * @deprecated since 5.0.0 + */ + CanvasRenderTarget: { + get() + { + deprecation(v5, 'PIXI.CanvasRenderTarget has moved to PIXI.utils.CanvasRenderTarget'); + + return PIXI.utils.CanvasRenderTarget; + }, + }, + + /** + * @memberof PIXI + * @name loader + * @type {PIXI.Loader} + * @see PIXI.Loader.shared + * @deprecated since 5.0.0 + */ + loader: { + get() + { + deprecation(v5, 'PIXI.loader has moved to PIXI.Loader.shared'); + + return PIXI.Loader.shared; + }, + }, + + /** + * @class PIXI.FilterManager + * @see PIXI.systems.FilterSystem + * @deprecated since 5.0.0 + */ + FilterManager: { + get() + { + deprecation(v5, 'PIXI.FilterManager has moved to PIXI.systems.FilterSystem'); + + return PIXI.systems.FilterManager; + }, + }, + }); + + /** + * This namespace has been removed. All classes previous nested + * under this namespace have been moved to the top-level `PIXI` object. + * @namespace PIXI.extras + * @deprecated since 5.0.0 + */ + PIXI.extras = {}; + + Object.defineProperties(PIXI.extras, { + /** + * @class PIXI.extras.TilingSprite + * @see PIXI.TilingSprite + * @deprecated since 5.0.0 + */ + TilingSprite: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSprite has moved to PIXI.TilingSprite'); + + return PIXI.TilingSprite; + }, + }, + /** + * @class PIXI.extras.TilingSpriteRenderer + * @see PIXI.TilingSpriteRenderer + * @deprecated since 5.0.0 + */ + TilingSpriteRenderer: { + get() + { + deprecation(v5, 'PIXI.extras.TilingSpriteRenderer has moved to PIXI.TilingSpriteRenderer'); + + return PIXI.TilingSpriteRenderer; + }, + }, + /** + * @class PIXI.extras.AnimatedSprite + * @see PIXI.AnimatedSprite + * @deprecated since 5.0.0 + */ + AnimatedSprite: { + get() + { + deprecation(v5, 'PIXI.extras.AnimatedSprite has moved to PIXI.AnimatedSprite'); + + return PIXI.AnimatedSprite; + }, + }, + /** + * @class PIXI.extras.BitmapText + * @see PIXI.BitmapText + * @deprecated since 5.0.0 + */ + BitmapText: { + get() + { + deprecation(v5, 'PIXI.extras.BitmapText has moved to PIXI.BitmapText'); + + return PIXI.BitmapText; + }, + }, + }); + + Object.defineProperties(PIXI.utils, { + /** + * @function PIXI.utils.getSvgSize + * @see PIXI.resources.SVGResource.getSize + * @deprecated since 5.0.0 + */ + getSvgSize: { + get() + { + deprecation(v5, 'PIXI.utils.getSvgSize has moved to PIXI.SVGResource.getSize'); + + return PIXI.SVGResource.getSize; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.mesh + * @deprecated since 5.0.0 + */ + PIXI.mesh = {}; + + Object.defineProperties(PIXI.mesh, { + /** + * @class PIXI.mesh.Mesh + * @see PIXI.SimpleMesh + * @deprecated since 5.0.0 + */ + Mesh: { + get() + { + deprecation(v5, 'PIXI.mesh.Mesh has moved to PIXI.SimpleMesh'); + + return PIXI.SimpleMesh; + }, + }, + /** + * @class PIXI.mesh.NineSlicePlane + * @see PIXI.NineSlicePlane + * @deprecated since 5.0.0 + */ + NineSlicePlane: { + get() + { + deprecation(v5, 'PIXI.mesh.NineSlicePlane has moved to PIXI.NineSlicePlane'); + + return PIXI.NineSlicePlane; + }, + }, + /** + * @class PIXI.mesh.Plane + * @see PIXI.SimplePlane + * @deprecated since 5.0.0 + */ + Plane: { + get() + { + deprecation(v5, 'PIXI.mesh.Plane has moved to PIXI.SimplePlane'); + + return PIXI.SimplePlane; + }, + }, + /** + * @class PIXI.mesh.Rope + * @see PIXI.SimpleRope + * @deprecated since 5.0.0 + */ + Rope: { + get() + { + deprecation(v5, 'PIXI.mesh.Rope has moved to PIXI.SimpleRope'); + + return PIXI.SimpleRope; + }, + }, + /** + * @class PIXI.mesh.RawMesh + * @see PIXI.Mesh + * @deprecated since 5.0.0 + */ + RawMesh: { + get() + { + deprecation(v5, 'PIXI.mesh.RawMesh has moved to PIXI.Mesh'); + + return PIXI.Mesh; + }, + }, + /** + * @class PIXI.mesh.CanvasMeshRenderer + * @see PIXI.CanvasMeshRenderer + * @deprecated since 5.0.0 + */ + CanvasMeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.CanvasMeshRenderer has moved to PIXI.CanvasMeshRenderer'); + + return PIXI.CanvasMeshRenderer; + }, + }, + /** + * @class PIXI.mesh.MeshRenderer + * @see PIXI.MeshRenderer + * @deprecated since 5.0.0 + */ + MeshRenderer: { + get() + { + deprecation(v5, 'PIXI.mesh.MeshRenderer has moved to PIXI.MeshRenderer'); + + return PIXI.MeshRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.particles + * @deprecated since 5.0.0 + */ + PIXI.particles = {}; + + Object.defineProperties(PIXI.particles, { + /** + * @class PIXI.particles.ParticleContainer + * @deprecated since 5.0.0 + * @see PIXI.ParticleContainer + */ + ParticleContainer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleContainer has moved to PIXI.ParticleContainer'); + + return PIXI.ParticleContainer; + }, + }, + /** + * @class PIXI.particles.ParticleRenderer + * @deprecated since 5.0.0 + * @see PIXI.ParticleRenderer + */ + ParticleRenderer: { + get() + { + deprecation(v5, 'PIXI.particles.ParticleRenderer has moved to PIXI.ParticleRenderer'); + + return PIXI.ParticleRenderer; + }, + }, + }); + + /** + * This namespace has been removed and items have been moved to + * the top-level `PIXI` object. + * @namespace PIXI.ticker + * @deprecated since 5.0.0 + */ + PIXI.ticker = {}; + + Object.defineProperties(PIXI.ticker, { + /** + * @class PIXI.ticker.Ticker + * @deprecated since 5.0.0 + * @see PIXI.Ticker + */ + Ticker: { + get() + { + deprecation(v5, 'PIXI.ticker.Ticker has moved to PIXI.Ticker'); + + return PIXI.Ticker; + }, + }, + /** + * @name PIXI.ticker.shared + * @type {PIXI.Ticker} + * @deprecated since 5.0.0 + * @see PIXI.Ticker.shared + */ + shared: { + get() + { + deprecation(v5, 'PIXI.ticker.shared has moved to PIXI.Ticker.shared'); + + return PIXI.Ticker.shared; + }, + }, + }); + + /** + * All classes on this namespace have moved to the high-level `PIXI` object. + * @namespace PIXI.loaders + * @deprecated since 5.0.0 + */ + PIXI.loaders = {}; + + Object.defineProperties(PIXI.loaders, { + /** + * @class PIXI.loaders.Loader + * @see PIXI.Loader + * @deprecated since 5.0.0 + */ + Loader: { + get() + { + deprecation(v5, 'PIXI.loaders.Loader has moved to PIXI.Loader'); + + return PIXI.Loader; + }, + }, + /** + * @class PIXI.loaders.Resource + * @see PIXI.LoaderResource + * @deprecated since 5.0.0 + */ + Resource: { + get() + { + deprecation(v5, 'PIXI.loaders.Resource has moved to PIXI.LoaderResource'); + + return PIXI.LoaderResource; + }, + }, + /** + * @function PIXI.loaders.bitmapFontParser + * @see PIXI.BitmapFontLoader.use + * @deprecated since 5.0.0 + */ + bitmapFontParser: { + get() + { + deprecation(v5, 'PIXI.loaders.bitmapFontParser has moved to PIXI.BitmapFontLoader.use'); + + return PIXI.BitmapFontLoader.use; + }, + }, + /** + * @function PIXI.loaders.parseBitmapFontData + * @see PIXI.BitmapFontLoader.parse + * @deprecated since 5.0.0 + */ + parseBitmapFontData: { + get() + { + deprecation(v5, 'PIXI.loaders.parseBitmapFontData has moved to PIXI.BitmapFontLoader.parse'); + + return PIXI.BitmapFontLoader.parse; + }, + }, + /** + * @function PIXI.loaders.spritesheetParser + * @see PIXI.SpritesheetLoader.use + * @deprecated since 5.0.0 + */ + spritesheetParser: { + get() + { + deprecation(v5, 'PIXI.loaders.spritesheetParser has moved to PIXI.SpritesheetLoader.use'); + + return PIXI.SpritesheetLoader.use; + }, + }, + /** + * @function PIXI.loaders.getResourcePath + * @see PIXI.SpritesheetLoader.getResourcePath + * @deprecated since 5.0.0 + */ + getResourcePath: { + get() + { + deprecation(v5, 'PIXI.loaders.getResourcePath has moved to PIXI.SpritesheetLoader.getResourcePath'); + + return PIXI.SpritesheetLoader.getResourcePath; + }, + }, + }); + + /** + * @function PIXI.loaders.Loader.addPixiMiddleware + * @see PIXI.Loader.registerPlugin + * @deprecated since 5.0.0 + * @param {function} middleware + */ + PIXI.Loader.addPixiMiddleware = function addPixiMiddleware(middleware) + { + deprecation(v5, 'PIXI.loaders.Loader.addPixiMiddleware is deprecated, use PIXI.loaders.Loader.registerPlugin'); + + return PIXI.loaders.Loader.registerPlugin({ use: middleware() }); + }; + + /** + * @class PIXI.extract.WebGLExtract + * @deprecated since 5.0.0 + * @see PIXI.extract.Extract + */ + Object.defineProperty(PIXI.extract, 'WebGLExtract', { + get() + { + deprecation(v5, 'PIXI.extract.WebGLExtract has moved to PIXI.extract.Extract'); + + return PIXI.extract.Extract; + }, + }); + + /** + * @class PIXI.prepare.WebGLPrepare + * @deprecated since 5.0.0 + * @see PIXI.prepare.Prepare + */ + Object.defineProperty(PIXI.prepare, 'WebGLPrepare', { + get() + { + deprecation(v5, 'PIXI.prepare.WebGLPrepare has moved to PIXI.prepare.Prepare'); + + return PIXI.prepare.Prepare; + }, + }); + + /** + * @method PIXI.Container#_renderWebGL + * @private + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype._renderWebGL = function _renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#_renderWebGL has moved to PIXI.Container#_render'); + + this._render(renderer); + }; + + /** + * @method PIXI.Container#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderWebGL has moved to PIXI.Container#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.DisplayObject#renderWebGL + * @deprecated since 5.0.0 + * @see PIXI.DisplayObject#render + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.DisplayObject.prototype.renderWebGL = function renderWebGL(renderer) + { + deprecation(v5, 'PIXI.DisplayObject#renderWebGL has moved to PIXI.DisplayObject#render'); + + this.render(renderer); + }; + + /** + * @method PIXI.Container#renderAdvancedWebGL + * @deprecated since 5.0.0 + * @see PIXI.Container#renderAdvanced + * @param {PIXI.Renderer} renderer Instance of renderer + */ + PIXI.Container.prototype.renderAdvancedWebGL = function renderAdvancedWebGL(renderer) + { + deprecation(v5, 'PIXI.Container#renderAdvancedWebGL has moved to PIXI.Container#renderAdvanced'); + + this.renderAdvanced(renderer); + }; + + Object.defineProperties(PIXI.settings, { + /** + * Default transform type. + * + * @static + * @deprecated since 5.0.0 + * @memberof PIXI.settings + * @type {PIXI.TRANSFORM_MODE} + * @default PIXI.TRANSFORM_MODE.STATIC + */ + TRANSFORM_MODE: { + get() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + + return 0; + }, + set() + { + deprecation(v5, 'PIXI.settings.TRANSFORM_MODE has been removed.'); + }, + }, + }); + + const { BaseTexture } = PIXI; + + /** + * @method fromImage + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromImage has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method fromCanvas + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromCanvas = function fromCanvas(canvas, scaleMode) + { + deprecation(v5, 'PIXI.BaseTexture.fromCanvas has been replaced with PIXI.BaseTexture.from'); + + return BaseTexture.from(canvas, { scaleMode }); + }; + + /** + * @method fromSVG + * @static + * @memberof PIXI.BaseTexture + * @deprecated since 5.0.0 + * @see PIXI.BaseTexture.from + */ + BaseTexture.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) + { + deprecation(v5, 'PIXI.BaseTexture.fromSVG has been replaced with PIXI.BaseTexture.from'); + + const resourceOptions = { scale, crossorigin }; + + return BaseTexture.from(canvas, { scaleMode, resourceOptions }); + }; + + /** + * @method PIXI.Point#copy + * @deprecated since 5.0.0 + * @see PIXI.Point#copyFrom + */ + PIXI.Point.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Point.copy has been replaced with PIXI.Point#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.ObservablePoint#copy + * @deprecated since 5.0.0 + * @see PIXI.ObservablePoint#copyFrom + */ + PIXI.ObservablePoint.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.ObservablePoint.copy has been replaced with PIXI.ObservablePoint#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Rectangle#copy + * @deprecated since 5.0.0 + * @see PIXI.Rectangle#copyFrom + */ + PIXI.Rectangle.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Rectangle.copy has been replaced with PIXI.Rectangle#copyFrom'); + + return this.copyFrom(p); + }; + + /** + * @method PIXI.Matrix#copy + * @deprecated since 5.0.0 + * @see PIXI.Matrix#copyTo + */ + PIXI.Matrix.prototype.copy = function copy(p) + { + deprecation(v5, 'PIXI.Matrix.copy has been replaced with PIXI.Matrix#copyTo'); + + return this.copyTo(p); + }; + + Object.assign(PIXI.systems.FilterSystem.prototype, { + /** + * @method PIXI.FilterManager#getRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#getFilterTexture + */ + getRenderTarget(clear, resolution) + { + deprecation(v5, 'FilterManager#getRenderTarget has been replaced with FilterSystem#getFilterTexture'); + + return this.getFilterTexture(resolution); + }, + + /** + * @method PIXI.FilterManager#returnRenderTarget + * @deprecated since 5.0.0 + * @see PIXI.systems.FilterSystem#returnFilterTexture + */ + returnRenderTarget(renderTexture) + { + deprecation(v5, 'FilterManager#returnRenderTarget has been replaced with FilterSystem#returnFilterTexture'); + + this.returnFilterTexture(renderTexture); + }, + }); + + Object.defineProperties(PIXI.RenderTexture.prototype, { + /** + * @name PIXI.RenderTexture#sourceFrame + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + sourceFrame: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#sourceFrame has been removed'); + + return this.filterFrame; + }, + }, + /** + * @name PIXI.RenderTexture#size + * @type {PIXI.Rectangle} + * @deprecated since 5.0.0 + * @readonly + */ + size: { + get() + { + deprecation(v5, 'PIXI.RenderTexture#size has been removed'); + + return this._frame; + }, + }, + }); + + /** + * @class BlurXFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurXFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurXFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(true, strength, quality, resolution, kernelSize); + } + } + + /** + * @class BlurYFilter + * @memberof PIXI.filters + * @deprecated since 5.0.0 + * @see PIXI.filters.BlurFilterPass + */ + class BlurYFilter extends PIXI.filters.BlurFilterPass + { + constructor(strength, quality, resolution, kernelSize) + { + deprecation(v5, 'PIXI.filters.BlurYFilter is deprecated, use PIXI.filters.BlurFilterPass'); + + super(false, strength, quality, resolution, kernelSize); + } + } + + Object.assign(PIXI.filters, { + BlurXFilter, + BlurYFilter, + }); + + const { Sprite, Texture } = PIXI; + + // 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`); + + return Sprite.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @see PIXI.Sprite.from + * @method PIXI.Sprite.fromImage + * @return {PIXI.Sprite} + */ + Sprite.fromImage = spriteFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromSVG + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromSVG = spriteFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromCanvas + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromCanvas = spriteFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromVideo + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromVideo = spriteFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Sprite.fromFrame + * @see PIXI.Sprite.from + * @return {PIXI.Sprite} + */ + Sprite.fromFrame = spriteFrom.bind(null, 'fromFrame'); + + // 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`); + + return Texture.from(source, { + resourceOptions: { + scale: scaleMode, + crossorigin, + }, + }); + } + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromImage + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromImage = textureFrom.bind(null, 'fromImage'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromSVG + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromSVG = textureFrom.bind(null, 'fromSVG'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromCanvas + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromCanvas = textureFrom.bind(null, 'fromCanvas'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromVideo + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromVideo = textureFrom.bind(null, 'fromVideo'); + + /** + * @deprecated since 5.0.0 + * @method PIXI.Texture.fromFrame + * @see PIXI.Texture.from + * @return {PIXI.Texture} + */ + Texture.fromFrame = textureFrom.bind(null, 'fromFrame'); + + /** + * @deprecated since 5.0.0 + * @member {boolean} PIXI.AbstractRenderer#autoResize + * @see PIXI.AbstractRenderer#autoDensity + */ + Object.defineProperty(PIXI.AbstractRenderer.prototype, 'autoResize', { + get() + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + return this.autoDensity; + }, + set(value) + { + deprecation(v5, 'PIXI.AbstractRenderer autoResize is deprecated, use autoDensity'); + + this.autoDensity = value; + }, + }); +} diff --git a/bundles/pixi.js/test/index.js b/bundles/pixi.js/test/index.js index a29651e..9d6ea9d 100644 --- a/bundles/pixi.js/test/index.js +++ b/bundles/pixi.js/test/index.js @@ -1,8 +1,23 @@ /* eslint-disable global-require */ -const PIXI = require('../'); - describe('PIXI', function () { + before(function (done) + { + this.head = document.querySelector('head'); + this.script = document.createElement('script'); + this.script.onload = () => done(); + this.script.src = require.resolve('../dist/pixi'); + this.head.appendChild(this.script); + }); + + after(function () + { + this.head.removeChild(this.script); + delete this.script; + delete this.head; + delete window.PIXI; + }); + it('should exist as a global object', function () { expect(window.PIXI).to.not.be.undefined; @@ -16,7 +31,6 @@ it('should contain deprecations on window, not import', function () { - expect(PIXI.extras).to.be.undefined; - expect(window.PIXI.extras).to.not.be.undefined; + expect(PIXI.extras).to.not.be.undefined; }); }); diff --git a/packages/math/test/Rectangle.js b/packages/math/test/Rectangle.js index be6f106..8e315db 100644 --- a/packages/math/test/Rectangle.js +++ b/packages/math/test/Rectangle.js @@ -165,8 +165,8 @@ expect(rect3.right).to.equal(20); expect(rect3.bottom).to.equal(20); - const rect5 = new PIXI.Rectangle(10, 10, 20, 25); - const rect6 = new PIXI.Rectangle(22, 24, 20, 20); + const rect5 = new Rectangle(10, 10, 20, 25); + const rect6 = new Rectangle(22, 24, 20, 20); rect5.fit(rect6); @@ -175,8 +175,8 @@ expect(rect5.right).to.equal(30); expect(rect5.bottom).to.equal(35); - const rect7 = new PIXI.Rectangle(11, 10, 20, 25); - const rect8 = new PIXI.Rectangle(10, 9, 13, 10); + const rect7 = new Rectangle(11, 10, 20, 25); + const rect8 = new Rectangle(10, 9, 13, 10); rect7.fit(rect8); diff --git a/packages/text/test/TextMetrics.js b/packages/text/test/TextMetrics.js index 9b29d0d..7dccc0f 100644 --- a/packages/text/test/TextMetrics.js +++ b/packages/text/test/TextMetrics.js @@ -128,7 +128,7 @@ it('should be able to override wordWrap to false in measureText', function () { - const metrics = PIXI.TextMetrics.measureText(longText, new PIXI.TextStyle(defaultStyle), false); + const metrics = TextMetrics.measureText(longText, new TextStyle(defaultStyle), false); expect(metrics.lines.length).to.equal(1); }); diff --git a/packages/utils/test/index.js b/packages/utils/test/index.js index 40018a4..82f0f2a 100755 --- a/packages/utils/test/index.js +++ b/packages/utils/test/index.js @@ -241,7 +241,7 @@ { it('should exist', function () { - expect(PIXI.utils.earcut).to.be.a('function'); + expect(utils.earcut).to.be.a('function'); }); }); }); diff --git a/rollup.config.js b/rollup.config.js index 763d25c..19323aa 100644 --- a/rollup.config.js +++ b/rollup.config.js @@ -114,7 +114,8 @@ output: { banner, file: path.join(basePath, bundle), - format: 'umd', + format: 'iife', + footer: 'PIXI.useDeprecated();', freeze, name: 'PIXI', sourcemap,