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
*/
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
export function useDeprecated() {
// eslint-disable-next-line @typescript-eslint/no-this-alias
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 property has moved to PIXI.resources.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 class 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 class 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 property 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 class 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 class 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 instance 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 class has moved to PIXI.systems.FilterSystem');
return PIXI.systems.FilterSystem;
},
},
/**
* @namespace PIXI.CanvasTinter
* @see PIXI.canvasUtils
* @deprecated since 5.2.0
*/
CanvasTinter: {
get() {
deprecation('5.2.0', 'PIXI.CanvasTinter namespace has moved to PIXI.canvasUtils');
return PIXI.canvasUtils;
},
},
/**
* @namespace PIXI.GroupD8
* @see PIXI.groupD8
* @deprecated since 5.2.0
*/
GroupD8: {
get() {
deprecation('5.2.0', 'PIXI.GroupD8 namespace has moved to PIXI.groupD8');
return PIXI.groupD8;
},
},
});
/**
* @namespace PIXI.accessibility
* @see PIXI
* @deprecated since 5.3.0
*/
PIXI.accessibility = {};
Object.defineProperties(PIXI.accessibility, {
/**
* @class PIXI.accessibility.AccessibilityManager
* @deprecated since 5.3.0
* @see PIXI.AccessibilityManager
*/
AccessibilityManager: {
get() {
deprecation('5.3.0', 'PIXI.accessibility.AccessibilityManager moved to PIXI.AccessibilityManager');
return PIXI.AccessibilityManager;
},
},
});
/**
* @namespace PIXI.interaction
* @see PIXI
* @deprecated since 5.3.0
*/
PIXI.interaction = {};
Object.defineProperties(PIXI.interaction, {
/**
* @class PIXI.interaction.InteractionManager
* @deprecated since 5.3.0
* @see PIXI.InteractionManager
*/
InteractionManager: {
get() {
deprecation('5.3.0', 'PIXI.interaction.InteractionManager moved to PIXI.InteractionManager');
return PIXI.InteractionManager;
},
},
/**
* @class PIXI.interaction.InteractionData
* @deprecated since 5.3.0
* @see PIXI.InteractionData
*/
InteractionData: {
get() {
deprecation('5.3.0', 'PIXI.interaction.InteractionData moved to PIXI.InteractionData');
return PIXI.InteractionData;
},
},
/**
* @class PIXI.interaction.InteractionEvent
* @deprecated since 5.3.0
* @see PIXI.InteractionEvent
*/
InteractionEvent: {
get() {
deprecation('5.3.0', 'PIXI.interaction.InteractionEvent moved to PIXI.InteractionEvent');
return PIXI.InteractionEvent;
},
},
});
/**
* @namespace PIXI.prepare
* @see PIXI
* @deprecated since 5.2.1
*/
PIXI.prepare = {};
Object.defineProperties(PIXI.prepare, {
/**
* @class PIXI.prepare.BasePrepare
* @deprecated since 5.2.1
* @see PIXI.BasePrepare
*/
BasePrepare: {
get() {
deprecation('5.2.1', 'PIXI.prepare.BasePrepare moved to PIXI.BasePrepare');
return PIXI.BasePrepare;
},
},
/**
* @class PIXI.prepare.Prepare
* @deprecated since 5.2.1
* @see PIXI.Prepare
*/
Prepare: {
get() {
deprecation('5.2.1', 'PIXI.prepare.Prepare moved to PIXI.Prepare');
return PIXI.Prepare;
},
},
/**
* @class PIXI.prepare.CanvasPrepare
* @deprecated since 5.2.1
* @see PIXI.CanvasPrepare
*/
CanvasPrepare: {
get() {
deprecation('5.2.1', 'PIXI.prepare.CanvasPrepare moved to PIXI.CanvasPrepare');
return PIXI.CanvasPrepare;
},
},
});
/**
* @namespace PIXI.extract
* @see PIXI
* @deprecated since 5.2.1
*/
PIXI.extract = {};
Object.defineProperties(PIXI.extract, {
/**
* @class PIXI.extract.Extract
* @deprecated since 5.2.1
* @see PIXI.Extract
*/
Extract: {
get() {
deprecation('5.2.1', 'PIXI.extract.Extract moved to PIXI.Extract');
return PIXI.Extract;
},
},
/**
* @class PIXI.extract.CanvasExtract
* @deprecated since 5.2.1
* @see PIXI.CanvasExtract
*/
CanvasExtract: {
get() {
deprecation('5.2.1', 'PIXI.extract.CanvasExtract moved to PIXI.CanvasExtract');
return PIXI.CanvasExtract;
},
},
});
/**
* 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 class 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 class 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 class 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 class has moved to PIXI.BitmapText');
return PIXI.BitmapText;
},
},
});
/**
* @static
* @method PIXI.TilingSprite.fromFrame
* @deprecated since 5.3.0
* @see PIXI.TilingSprite.from
*/
PIXI.TilingSprite.fromFrame = function fromFrame(frameId, width, height) {
deprecation('5.3.0', 'TilingSprite.fromFrame is deprecated, use TilingSprite.from');
return PIXI.TilingSprite.from(frameId, { width, height });
};
/**
* @static
* @method PIXI.TilingSprite.fromImage
* @deprecated since 5.3.0
* @see PIXI.TilingSprite.from
*/
PIXI.TilingSprite.fromImage = function fromImage(imageId, width, height, options = {}) {
deprecation('5.3.0', 'TilingSprite.fromImage is deprecated, use TilingSprite.from');
// Fallback support for crossorigin, scaleMode parameters
if (options && typeof options !== 'object') {
options = {
// eslint-disable-next-line prefer-rest-params
scaleMode: arguments[4],
resourceOptions: {
// eslint-disable-next-line prefer-rest-params
crossorigin: arguments[3],
},
};
}
options.width = width;
options.height = height;
return PIXI.TilingSprite.from(imageId, options);
};
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 function has moved to PIXI.resources.SVGResource.getSize');
return PIXI.resources.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 class 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 class 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 class 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 class 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 class 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 class 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 class 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 class 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 class 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 class 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 instance 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 class 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 class 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 function has moved to PIXI.BitmapFontLoader.use');
return PIXI.BitmapFontLoader.use;
},
},
/**
* @function PIXI.loaders.parseBitmapFontData
* @deprecated since 5.0.0
*/
parseBitmapFontData: {
get() {
deprecation(v5, 'PIXI.loaders.parseBitmapFontData function has removed');
},
},
/**
* @function PIXI.loaders.spritesheetParser
* @see PIXI.SpritesheetLoader.use
* @deprecated since 5.0.0
*/
spritesheetParser: {
get() {
deprecation(v5, 'PIXI.loaders.spritesheetParser function 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 property 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 function is deprecated, use PIXI.loaders.Loader.registerPlugin');
return PIXI.loaders.Loader.registerPlugin({ use: middleware() });
};
// convenience for converting event name to signal name
const eventToSignal = (event) => `on${event.charAt(0).toUpperCase()}${event.slice(1)}`;
Object.assign(PIXI.Loader.prototype, {
/**
* Use the corresponding signal, e.g., event `start`` is signal `onStart`.
* @method PIXI.Loader#on
* @deprecated since 5.0.0
*/
on(event) {
const signal = eventToSignal(event);
deprecation(v5, `PIXI.Loader#on is completely deprecated, use PIXI.Loader#${signal}.add`);
},
/**
* Use the corresponding signal, e.g., event `start`` is signal `onStart`.
* @method PIXI.Loader#once
* @deprecated since 5.0.0
*/
once(event) {
const signal = eventToSignal(event);
deprecation(v5, `PIXI.Loader#once is completely deprecated, use PIXI.Loader#${signal}.once`);
},
/**
* Use the corresponding signal, e.g., event `start`` is signal `onStart`.
* @method PIXI.Loader#off
* @deprecated since 5.0.0
*/
off(event) {
const signal = eventToSignal(event);
deprecation(v5, `PIXI.Loader#off is completely deprecated, use PIXI.Loader#${signal}.detach`);
},
});
/**
* @class PIXI.extract.WebGLExtract
* @deprecated since 5.0.0
* @see PIXI.Extract
*/
Object.defineProperty(PIXI.extract, 'WebGLExtract', {
get() {
deprecation(v5, 'PIXI.extract.WebGLExtract method has moved to PIXI.Extract');
return PIXI.Extract;
},
});
/**
* @class PIXI.prepare.WebGLPrepare
* @deprecated since 5.0.0
* @see PIXI.Prepare
*/
Object.defineProperty(PIXI.prepare, 'WebGLPrepare', {
get() {
deprecation(v5, 'PIXI.prepare.WebGLPrepare class has moved to PIXI.Prepare');
return PIXI.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 method 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 method 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 method 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 method 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 property has been removed');
return 0;
},
set() {
deprecation(v5, 'PIXI.settings.TRANSFORM_MODE property has been removed');
},
},
});
const { BaseTexture: BaseTextureAny } = PIXI;
/**
* @method loadSource
* @memberof PIXI.BaseTexture#
* @deprecated since 5.0.0
*/
BaseTextureAny.prototype.loadSource = function loadSource(image) {
deprecation(v5, 'PIXI.BaseTexture.loadSource method has been deprecated');
const resource = PIXI.resources.autoDetectResource(image);
resource.internal = true;
this.setResource(resource);
this.update();
};
let baseTextureIdDeprecation = false;
Object.defineProperties(BaseTextureAny.prototype, {
/**
* @name PIXI.BaseTexture#hasLoaded
* @type {boolean}
* @deprecated since 5.0.0
* @readonly
* @see PIXI.BaseTexture#valid
*/
hasLoaded: {
get() {
deprecation(v5, 'PIXI.BaseTexture.hasLoaded property has been removed, use PIXI.BaseTexture.valid');
return this.valid;
},
},
/**
* @name PIXI.BaseTexture#imageUrl
* @type {string}
* @deprecated since 5.0.0
* @see PIXI.resources.ImageResource#url
*/
imageUrl: {
get() {
var _a;
deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use PIXI.BaseTexture.resource.url');
return (_a = this.resource) === null || _a === void 0 ? void 0 : _a.url;
},
set(imageUrl) {
deprecation(v5, 'PIXI.BaseTexture.imageUrl property has been removed, use PIXI.BaseTexture.resource.url');
if (this.resource) {
this.resource.url = imageUrl;
}
},
},
/**
* @name PIXI.BaseTexture#source
* @type {HTMLImageElement|HTMLCanvasElement|HTMLVideoElement|SVGElement}
* @deprecated since 5.0.0
* @readonly
* @see PIXI.resources.BaseImageResource#source
*/
source: {
get() {
deprecation(v5, 'PIXI.BaseTexture.source property has been moved, use `PIXI.BaseTexture.resource.source`');
return this.resource.source;
},
set(source) {
deprecation(v5, 'PIXI.BaseTexture.source property has been moved, use `PIXI.BaseTexture.resource.source` '
+ 'if you want to set HTMLCanvasElement. Otherwise, create new BaseTexture.');
if (this.resource) {
this.resource.source = source;
}
},
},
/**
* @name PIXI.BaseTexture#premultiplyAlpha
* @type {boolean}
* @deprecated since 5.2.0
* @readonly
* @see PIXI.BaseTexture#alphaMode
*/
premultiplyAlpha: {
get() {
deprecation('5.2.0', 'PIXI.BaseTexture.premultiplyAlpha property has been changed to `alphaMode`'
+ ', see `PIXI.ALPHA_MODES`');
return this.alphaMode !== 0;
},
set(value) {
deprecation('5.2.0', 'PIXI.BaseTexture.premultiplyAlpha property has been changed to `alphaMode`'
+ ', see `PIXI.ALPHA_MODES`');
this.alphaMode = Number(value);
},
},
/**
* Batch local field, stores current texture location
*
* @name PIXI.BaseTexture#_id
* @deprecated since 5.2.0
* @type {number}
* @see PIXI.BaseTexture#_batchLocation
*/
_id: {
get() {
if (!baseTextureIdDeprecation) {
// #popelyshev: That property was a hot place, I don't want to call deprecation method on it if possible
deprecation('5.2.0', 'PIXI.BaseTexture._id batch local field has been changed to `_batchLocation`');
baseTextureIdDeprecation = true;
}
return this._batchLocation;
},
set(value) {
this._batchLocation = value;
},
},
});
/**
* @method fromImage
* @static
* @memberof PIXI.BaseTexture
* @deprecated since 5.0.0
* @see PIXI.BaseTexture.from
*/
BaseTextureAny.fromImage = function fromImage(canvas, crossorigin, scaleMode, scale) {
deprecation(v5, 'PIXI.BaseTexture.fromImage method has been replaced with PIXI.BaseTexture.from');
const resourceOptions = { scale, crossorigin };
return BaseTextureAny.from(canvas, { scaleMode, resourceOptions });
};
/**
* @method fromCanvas
* @static
* @memberof PIXI.BaseTexture
* @deprecated since 5.0.0
* @see PIXI.BaseTexture.from
*/
BaseTextureAny.fromCanvas = function fromCanvas(canvas, scaleMode) {
deprecation(v5, 'PIXI.BaseTexture.fromCanvas method has been replaced with PIXI.BaseTexture.from');
return BaseTextureAny.from(canvas, { scaleMode });
};
/**
* @method fromSVG
* @static
* @memberof PIXI.BaseTexture
* @deprecated since 5.0.0
* @see PIXI.BaseTexture.from
*/
BaseTextureAny.fromSVG = function fromSVG(canvas, crossorigin, scaleMode, scale) {
deprecation(v5, 'PIXI.BaseTexture.fromSVG method has been replaced with PIXI.BaseTexture.from');
const resourceOptions = { scale, crossorigin };
return BaseTextureAny.from(canvas, { scaleMode, resourceOptions });
};
Object.defineProperties(PIXI.resources.ImageResource.prototype, {
/**
* @name PIXI.resources.ImageResource#premultiplyAlpha
* @type {boolean}
* @deprecated since 5.2.0
* @readonly
* @see PIXI.resources.ImageResource#alphaMode
*/
premultiplyAlpha: {
get() {
deprecation('5.2.0', 'PIXI.resources.ImageResource.premultiplyAlpha property '
+ 'has been changed to `alphaMode`, see `PIXI.ALPHA_MODES`');
return this.alphaMode !== 0;
},
set(value) {
deprecation('5.2.0', 'PIXI.resources.ImageResource.premultiplyAlpha property '
+ 'has been changed to `alphaMode`, see `PIXI.ALPHA_MODES`');
this.alphaMode = Number(value);
},
},
});
/**
* @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 method 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 method 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 method 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 method has been replaced with PIXI.Matrix.copyTo');
return this.copyTo(p);
};
/**
* @method PIXI.systems.StateSystem#setState
* @deprecated since 5.1.0
* @see PIXI.systems.StateSystem#set
*/
PIXI.systems.StateSystem.prototype.setState = function setState(s) {
deprecation('v5.1.0', 'StateSystem.setState has been renamed to StateSystem.set');
return this.set(s);
};
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, 'PIXI.FilterManager.getRenderTarget method has been replaced with PIXI.systems.FilterSystem#getFilterTexture');
return this.getFilterTexture(null, resolution);
},
/**
* @method PIXI.FilterManager#returnRenderTarget
* @deprecated since 5.0.0
* @see PIXI.systems.FilterSystem#returnFilterTexture
*/
returnRenderTarget(renderTexture) {
deprecation(v5, 'PIXI.FilterManager.returnRenderTarget method has been replaced with '
+ 'PIXI.systems.FilterSystem.returnFilterTexture');
this.returnFilterTexture(renderTexture);
},
/**
* @method PIXI.systems.FilterSystem#calculateScreenSpaceMatrix
* @deprecated since 5.0.0
* @param {PIXI.Matrix} outputMatrix - the matrix to output to.
* @return {PIXI.Matrix} The mapped matrix.
*/
calculateScreenSpaceMatrix(outputMatrix) {
deprecation(v5, 'PIXI.systems.FilterSystem.calculateScreenSpaceMatrix method is removed, '
+ 'use `(vTextureCoord * inputSize.xy) + outputFrame.xy` instead');
const mappedMatrix = outputMatrix.identity();
const { sourceFrame, destinationFrame } = this.activeState;
mappedMatrix.translate(sourceFrame.x / destinationFrame.width, sourceFrame.y / destinationFrame.height);
mappedMatrix.scale(destinationFrame.width, destinationFrame.height);
return mappedMatrix;
},
/**
* @method PIXI.systems.FilterSystem#calculateNormalizedScreenSpaceMatrix
* @deprecated since 5.0.0
* @param {PIXI.Matrix} outputMatrix - The matrix to output to.
* @return {PIXI.Matrix} The mapped matrix.
*/
calculateNormalizedScreenSpaceMatrix(outputMatrix) {
deprecation(v5, 'PIXI.systems.FilterManager.calculateNormalizedScreenSpaceMatrix method is removed, '
+ 'use `((vTextureCoord * inputSize.xy) + outputFrame.xy) / outputFrame.zw` instead.');
const { sourceFrame, destinationFrame } = this.activeState;
const mappedMatrix = outputMatrix.identity();
mappedMatrix.translate(sourceFrame.x / destinationFrame.width, sourceFrame.y / destinationFrame.height);
const translateScaleX = (destinationFrame.width / sourceFrame.width);
const translateScaleY = (destinationFrame.height / sourceFrame.height);
mappedMatrix.scale(translateScaleX, translateScaleY);
return mappedMatrix;
},
});
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 property 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 property 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 class 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 class is deprecated, use PIXI.filters.BlurFilterPass');
super(false, strength, quality, resolution, kernelSize);
}
}
Object.assign(PIXI.filters, {
BlurXFilter,
BlurYFilter,
});
const { Sprite: SpriteAny, Texture: TextureAny, Graphics: GraphicsAny } = PIXI;
// Support for pixi.js-legacy bifurcation
// give users a friendly assist to use legacy
if (!GraphicsAny.prototype.generateCanvasTexture) {
GraphicsAny.prototype.generateCanvasTexture = function generateCanvasTexture() {
deprecation(v5, 'PIXI.Graphics.generateCanvasTexture method is only available in "pixi.js-legacy"');
};
}
/**
* @deprecated since 5.0.0
* @member {PIXI.Graphics} PIXI.Graphics#graphicsData
* @see PIXI.Graphics#geometry
* @readonly
*/
Object.defineProperty(GraphicsAny.prototype, 'graphicsData', {
get() {
deprecation(v5, 'PIXI.Graphics.graphicsData property is deprecated, use PIXI.Graphics.geometry.graphicsData');
return this.geometry.graphicsData;
},
});
// Use these to deprecate all the Sprite from* methods
function spriteFrom(name, source, crossorigin, scaleMode) {
deprecation(v5, `PIXI.Sprite.${name} method is deprecated, use PIXI.Sprite.from`);
return SpriteAny.from(source, {
resourceOptions: {
scale: scaleMode,
crossorigin,
},
});
}
/**
* @deprecated since 5.0.0
* @see PIXI.Sprite.from
* @method PIXI.Sprite.fromImage
* @return {PIXI.Sprite}
*/
SpriteAny.fromImage = spriteFrom.bind(null, 'fromImage');
/**
* @deprecated since 5.0.0
* @method PIXI.Sprite.fromSVG
* @see PIXI.Sprite.from
* @return {PIXI.Sprite}
*/
SpriteAny.fromSVG = spriteFrom.bind(null, 'fromSVG');
/**
* @deprecated since 5.0.0
* @method PIXI.Sprite.fromCanvas
* @see PIXI.Sprite.from
* @return {PIXI.Sprite}
*/
SpriteAny.fromCanvas = spriteFrom.bind(null, 'fromCanvas');
/**
* @deprecated since 5.0.0
* @method PIXI.Sprite.fromVideo
* @see PIXI.Sprite.from
* @return {PIXI.Sprite}
*/
SpriteAny.fromVideo = spriteFrom.bind(null, 'fromVideo');
/**
* @deprecated since 5.0.0
* @method PIXI.Sprite.fromFrame
* @see PIXI.Sprite.from
* @return {PIXI.Sprite}
*/
SpriteAny.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} method is deprecated, use PIXI.Texture.from`);
return TextureAny.from(source, {
resourceOptions: {
scale: scaleMode,
crossorigin,
},
});
}
/**
* @deprecated since 5.0.0
* @method PIXI.Texture.fromImage
* @see PIXI.Texture.from
* @return {PIXI.Texture}
*/
TextureAny.fromImage = textureFrom.bind(null, 'fromImage');
/**
* @deprecated since 5.0.0
* @method PIXI.Texture.fromSVG
* @see PIXI.Texture.from
* @return {PIXI.Texture}
*/
TextureAny.fromSVG = textureFrom.bind(null, 'fromSVG');
/**
* @deprecated since 5.0.0
* @method PIXI.Texture.fromCanvas
* @see PIXI.Texture.from
* @return {PIXI.Texture}
*/
TextureAny.fromCanvas = textureFrom.bind(null, 'fromCanvas');
/**
* @deprecated since 5.0.0
* @method PIXI.Texture.fromVideo
* @see PIXI.Texture.from
* @return {PIXI.Texture}
*/
TextureAny.fromVideo = textureFrom.bind(null, 'fromVideo');
/**
* @deprecated since 5.0.0
* @method PIXI.Texture.fromFrame
* @see PIXI.Texture.from
* @return {PIXI.Texture}
*/
TextureAny.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 property is deprecated, '
+ 'use PIXI.AbstractRenderer.autoDensity');
return this.autoDensity;
},
set(value) {
deprecation(v5, 'PIXI.AbstractRenderer.autoResize property is deprecated, '
+ 'use PIXI.AbstractRenderer.autoDensity');
this.autoDensity = value;
},
});
/**
* @deprecated since 5.0.0
* @member {PIXI.systems.TextureSystem} PIXI.Renderer#textureManager
* @see PIXI.Renderer#texture
*/
Object.defineProperty(PIXI.Renderer.prototype, 'textureManager', {
get() {
deprecation(v5, 'PIXI.Renderer.textureManager property is deprecated, use PIXI.Renderer.texture');
return this.texture;
},
});
/**
* @namespace PIXI.utils.mixins
* @deprecated since 5.0.0
*/
PIXI.utils.mixins = {
/**
* @memberof PIXI.utils.mixins
* @function mixin
* @deprecated since 5.0.0
*/
mixin() {
deprecation(v5, 'PIXI.utils.mixins.mixin function is no longer available');
},
/**
* @memberof PIXI.utils.mixins
* @function delayMixin
* @deprecated since 5.0.0
*/
delayMixin() {
deprecation(v5, 'PIXI.utils.mixins.delayMixin function is no longer available');
},
/**
* @memberof PIXI.utils.mixins
* @function performMixins
* @deprecated since 5.0.0
*/
performMixins() {
deprecation(v5, 'PIXI.utils.mixins.performMixins function is no longer available');
},
};
/**
* @memberof PIXI.BitmapText
* @member {object} font
* @deprecated since 5.3.0
*/
Object.defineProperty(PIXI.BitmapText.prototype, 'font', {
get() {
deprecation('5.3.0', 'PIXI.BitmapText.font property is deprecated, '
+ 'use fontName, fontSize, tint or align properties');
return {
name: this._fontName,
size: this._fontSize,
tint: this._tint,
align: this._align,
};
},
set(value) {
deprecation('5.3.0', 'PIXI.BitmapText.font property is deprecated, '
+ 'use fontName, fontSize, tint or align properties');
if (!value) {
return;
}
const style = { font: value };
this._upgradeStyle(style);
style.fontSize = style.fontSize || PIXI.BitmapFont.available[style.fontName].size;
this._fontName = style.fontName;
this._fontSize = style.fontSize;
this.dirty = true;
},
});
}