| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542 |
- /*!
- * @pixi/prepare - v6.5.10
- * Compiled Thu, 06 Jul 2023 15:25:11 UTC
- *
- * @pixi/prepare is licensed under the MIT License.
- * http://www.opensource.org/licenses/mit-license
- */
- import { settings } from '@pixi/settings';
- import { Texture, BaseTexture, ExtensionType } from '@pixi/core';
- import { Graphics } from '@pixi/graphics';
- import { Ticker, UPDATE_PRIORITY } from '@pixi/ticker';
- import { Container } from '@pixi/display';
- import { Text, TextStyle, TextMetrics } from '@pixi/text';
- import { deprecation } from '@pixi/utils';
- /**
- * Default number of uploads per frame using prepare plugin.
- * @static
- * @memberof PIXI.settings
- * @name UPLOADS_PER_FRAME
- * @type {number}
- * @default 4
- */
- settings.UPLOADS_PER_FRAME = 4;
- /*! *****************************************************************************
- Copyright (c) Microsoft Corporation.
- Permission to use, copy, modify, and/or distribute this software for any
- purpose with or without fee is hereby granted.
- THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
- REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
- AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
- INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
- OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
- PERFORMANCE OF THIS SOFTWARE.
- ***************************************************************************** */
- /* global Reflect, Promise */
- var extendStatics = function(d, b) {
- extendStatics = Object.setPrototypeOf ||
- ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
- function (d, b) { for (var p in b) { if (b.hasOwnProperty(p)) { d[p] = b[p]; } } };
- return extendStatics(d, b);
- };
- function __extends(d, b) {
- extendStatics(d, b);
- function __() { this.constructor = d; }
- d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
- }
- /**
- * CountLimiter limits the number of items handled by a {@link PIXI.BasePrepare} to a specified
- * number of items per frame.
- * @memberof PIXI
- */
- var CountLimiter = /** @class */ (function () {
- /**
- * @param maxItemsPerFrame - The maximum number of items that can be prepared each frame.
- */
- function CountLimiter(maxItemsPerFrame) {
- this.maxItemsPerFrame = maxItemsPerFrame;
- this.itemsLeft = 0;
- }
- /** Resets any counting properties to start fresh on a new frame. */
- CountLimiter.prototype.beginFrame = function () {
- this.itemsLeft = this.maxItemsPerFrame;
- };
- /**
- * Checks to see if another item can be uploaded. This should only be called once per item.
- * @returns If the item is allowed to be uploaded.
- */
- CountLimiter.prototype.allowedToUpload = function () {
- return this.itemsLeft-- > 0;
- };
- return CountLimiter;
- }());
- /**
- * Built-in hook to find multiple textures from objects like AnimatedSprites.
- * @private
- * @param item - Display object to check
- * @param queue - Collection of items to upload
- * @returns If a PIXI.Texture object was found.
- */
- function findMultipleBaseTextures(item, queue) {
- var result = false;
- // Objects with multiple textures
- if (item && item._textures && item._textures.length) {
- for (var i = 0; i < item._textures.length; i++) {
- if (item._textures[i] instanceof Texture) {
- var baseTexture = item._textures[i].baseTexture;
- if (queue.indexOf(baseTexture) === -1) {
- queue.push(baseTexture);
- result = true;
- }
- }
- }
- }
- return result;
- }
- /**
- * Built-in hook to find BaseTextures from Texture.
- * @private
- * @param item - Display object to check
- * @param queue - Collection of items to upload
- * @returns If a PIXI.Texture object was found.
- */
- function findBaseTexture(item, queue) {
- if (item.baseTexture instanceof BaseTexture) {
- var texture = item.baseTexture;
- if (queue.indexOf(texture) === -1) {
- queue.push(texture);
- }
- return true;
- }
- return false;
- }
- /**
- * Built-in hook to find textures from objects.
- * @private
- * @param item - Display object to check
- * @param queue - Collection of items to upload
- * @returns If a PIXI.Texture object was found.
- */
- function findTexture(item, queue) {
- if (item._texture && item._texture instanceof Texture) {
- var texture = item._texture.baseTexture;
- if (queue.indexOf(texture) === -1) {
- queue.push(texture);
- }
- return true;
- }
- return false;
- }
- /**
- * Built-in hook to draw PIXI.Text to its texture.
- * @private
- * @param _helper - Not used by this upload handler
- * @param item - Item to check
- * @returns If item was uploaded.
- */
- function drawText(_helper, item) {
- if (item instanceof Text) {
- // updating text will return early if it is not dirty
- item.updateText(true);
- return true;
- }
- return false;
- }
- /**
- * Built-in hook to calculate a text style for a PIXI.Text object.
- * @private
- * @param _helper - Not used by this upload handler
- * @param item - Item to check
- * @returns If item was uploaded.
- */
- function calculateTextStyle(_helper, item) {
- if (item instanceof TextStyle) {
- var font = item.toFontString();
- TextMetrics.measureFont(font);
- return true;
- }
- return false;
- }
- /**
- * Built-in hook to find Text objects.
- * @private
- * @param item - Display object to check
- * @param queue - Collection of items to upload
- * @returns if a PIXI.Text object was found.
- */
- function findText(item, queue) {
- if (item instanceof Text) {
- // push the text style to prepare it - this can be really expensive
- if (queue.indexOf(item.style) === -1) {
- queue.push(item.style);
- }
- // also push the text object so that we can render it (to canvas/texture) if needed
- if (queue.indexOf(item) === -1) {
- queue.push(item);
- }
- // also push the Text's texture for upload to GPU
- var texture = item._texture.baseTexture;
- if (queue.indexOf(texture) === -1) {
- queue.push(texture);
- }
- return true;
- }
- return false;
- }
- /**
- * Built-in hook to find TextStyle objects.
- * @private
- * @param item - Display object to check
- * @param queue - Collection of items to upload
- * @returns If a PIXI.TextStyle object was found.
- */
- function findTextStyle(item, queue) {
- if (item instanceof TextStyle) {
- if (queue.indexOf(item) === -1) {
- queue.push(item);
- }
- return true;
- }
- return false;
- }
- /**
- * The prepare manager provides functionality to upload content to the GPU.
- *
- * BasePrepare handles basic queuing functionality and is extended by
- * {@link PIXI.Prepare} and {@link PIXI.CanvasPrepare}
- * to provide preparation capabilities specific to their respective renderers.
- * @example
- * // Create a sprite
- * const sprite = PIXI.Sprite.from('something.png');
- *
- * // Load object into GPU
- * app.renderer.plugins.prepare.upload(sprite, () => {
- *
- * //Texture(s) has been uploaded to GPU
- * app.stage.addChild(sprite);
- *
- * })
- * @abstract
- * @memberof PIXI
- */
- var BasePrepare = /** @class */ (function () {
- /**
- * @param {PIXI.AbstractRenderer} renderer - A reference to the current renderer
- */
- function BasePrepare(renderer) {
- var _this = this;
- this.limiter = new CountLimiter(settings.UPLOADS_PER_FRAME);
- this.renderer = renderer;
- this.uploadHookHelper = null;
- this.queue = [];
- this.addHooks = [];
- this.uploadHooks = [];
- this.completes = [];
- this.ticking = false;
- this.delayedTick = function () {
- // unlikely, but in case we were destroyed between tick() and delayedTick()
- if (!_this.queue) {
- return;
- }
- _this.prepareItems();
- };
- // hooks to find the correct texture
- this.registerFindHook(findText);
- this.registerFindHook(findTextStyle);
- this.registerFindHook(findMultipleBaseTextures);
- this.registerFindHook(findBaseTexture);
- this.registerFindHook(findTexture);
- // upload hooks
- this.registerUploadHook(drawText);
- this.registerUploadHook(calculateTextStyle);
- }
- /** @ignore */
- BasePrepare.prototype.upload = function (item, done) {
- var _this = this;
- if (typeof item === 'function') {
- done = item;
- item = null;
- }
- if (done) {
- deprecation('6.5.0', 'BasePrepare.upload callback is deprecated, use the return Promise instead.');
- }
- return new Promise(function (resolve) {
- // If a display object, search for items
- // that we could upload
- if (item) {
- _this.add(item);
- }
- // TODO: remove done callback and just use resolve
- var complete = function () {
- done === null || done === void 0 ? void 0 : done();
- resolve();
- };
- // Get the items for upload from the display
- if (_this.queue.length) {
- _this.completes.push(complete);
- if (!_this.ticking) {
- _this.ticking = true;
- Ticker.system.addOnce(_this.tick, _this, UPDATE_PRIORITY.UTILITY);
- }
- }
- else {
- complete();
- }
- });
- };
- /**
- * Handle tick update
- * @private
- */
- BasePrepare.prototype.tick = function () {
- setTimeout(this.delayedTick, 0);
- };
- /**
- * Actually prepare items. This is handled outside of the tick because it will take a while
- * and we do NOT want to block the current animation frame from rendering.
- * @private
- */
- BasePrepare.prototype.prepareItems = function () {
- this.limiter.beginFrame();
- // Upload the graphics
- while (this.queue.length && this.limiter.allowedToUpload()) {
- var item = this.queue[0];
- var uploaded = false;
- if (item && !item._destroyed) {
- for (var i = 0, len = this.uploadHooks.length; i < len; i++) {
- if (this.uploadHooks[i](this.uploadHookHelper, item)) {
- this.queue.shift();
- uploaded = true;
- break;
- }
- }
- }
- if (!uploaded) {
- this.queue.shift();
- }
- }
- // We're finished
- if (!this.queue.length) {
- this.ticking = false;
- var completes = this.completes.slice(0);
- this.completes.length = 0;
- for (var i = 0, len = completes.length; i < len; i++) {
- completes[i]();
- }
- }
- else {
- // if we are not finished, on the next rAF do this again
- Ticker.system.addOnce(this.tick, this, UPDATE_PRIORITY.UTILITY);
- }
- };
- /**
- * Adds hooks for finding items.
- * @param {Function} addHook - Function call that takes two parameters: `item:*, queue:Array`
- * function must return `true` if it was able to add item to the queue.
- * @returns Instance of plugin for chaining.
- */
- BasePrepare.prototype.registerFindHook = function (addHook) {
- if (addHook) {
- this.addHooks.push(addHook);
- }
- return this;
- };
- /**
- * Adds hooks for uploading items.
- * @param {Function} uploadHook - Function call that takes two parameters: `prepare:CanvasPrepare, item:*` and
- * function must return `true` if it was able to handle upload of item.
- * @returns Instance of plugin for chaining.
- */
- BasePrepare.prototype.registerUploadHook = function (uploadHook) {
- if (uploadHook) {
- this.uploadHooks.push(uploadHook);
- }
- return this;
- };
- /**
- * Manually add an item to the uploading queue.
- * @param {PIXI.DisplayObject|PIXI.Container|PIXI.BaseTexture|PIXI.Texture|PIXI.Graphics|PIXI.Text|*} item - Object to
- * add to the queue
- * @returns Instance of plugin for chaining.
- */
- BasePrepare.prototype.add = function (item) {
- // Add additional hooks for finding elements on special
- // types of objects that
- for (var i = 0, len = this.addHooks.length; i < len; i++) {
- if (this.addHooks[i](item, this.queue)) {
- break;
- }
- }
- // Get children recursively
- if (item instanceof Container) {
- for (var i = item.children.length - 1; i >= 0; i--) {
- this.add(item.children[i]);
- }
- }
- return this;
- };
- /** Destroys the plugin, don't use after this. */
- BasePrepare.prototype.destroy = function () {
- if (this.ticking) {
- Ticker.system.remove(this.tick, this);
- }
- this.ticking = false;
- this.addHooks = null;
- this.uploadHooks = null;
- this.renderer = null;
- this.completes = null;
- this.queue = null;
- this.limiter = null;
- this.uploadHookHelper = null;
- };
- return BasePrepare;
- }());
- /**
- * Built-in hook to upload PIXI.Texture objects to the GPU.
- * @private
- * @param renderer - instance of the webgl renderer
- * @param item - Item to check
- * @returns If item was uploaded.
- */
- function uploadBaseTextures(renderer, item) {
- if (item instanceof BaseTexture) {
- // if the texture already has a GL texture, then the texture has been prepared or rendered
- // before now. If the texture changed, then the changer should be calling texture.update() which
- // reuploads the texture without need for preparing it again
- if (!item._glTextures[renderer.CONTEXT_UID]) {
- renderer.texture.bind(item);
- }
- return true;
- }
- return false;
- }
- /**
- * Built-in hook to upload PIXI.Graphics to the GPU.
- * @private
- * @param renderer - instance of the webgl renderer
- * @param item - Item to check
- * @returns If item was uploaded.
- */
- function uploadGraphics(renderer, item) {
- if (!(item instanceof Graphics)) {
- return false;
- }
- var geometry = item.geometry;
- // update dirty graphics to get batches
- item.finishPoly();
- geometry.updateBatches();
- var batches = geometry.batches;
- // upload all textures found in styles
- for (var i = 0; i < batches.length; i++) {
- var texture = batches[i].style.texture;
- if (texture) {
- uploadBaseTextures(renderer, texture.baseTexture);
- }
- }
- // if its not batchable - update vao for particular shader
- if (!geometry.batchable) {
- renderer.geometry.bind(geometry, item._resolveDirectShader(renderer));
- }
- return true;
- }
- /**
- * Built-in hook to find graphics.
- * @private
- * @param item - Display object to check
- * @param queue - Collection of items to upload
- * @returns if a PIXI.Graphics object was found.
- */
- function findGraphics(item, queue) {
- if (item instanceof Graphics) {
- queue.push(item);
- return true;
- }
- return false;
- }
- /**
- * The prepare plugin provides renderer-specific plugins for pre-rendering DisplayObjects. These plugins are useful for
- * asynchronously preparing and uploading to the GPU assets, textures, graphics waiting to be displayed.
- *
- * Do not instantiate this plugin directly. It is available from the `renderer.plugins` property.
- * See {@link PIXI.CanvasRenderer#plugins} or {@link PIXI.Renderer#plugins}.
- * @example
- * // Create a new application
- * const app = new PIXI.Application();
- * document.body.appendChild(app.view);
- *
- * // Don't start rendering right away
- * app.stop();
- *
- * // create a display object
- * const rect = new PIXI.Graphics()
- * .beginFill(0x00ff00)
- * .drawRect(40, 40, 200, 200);
- *
- * // Add to the stage
- * app.stage.addChild(rect);
- *
- * // Don't start rendering until the graphic is uploaded to the GPU
- * app.renderer.plugins.prepare.upload(app.stage, () => {
- * app.start();
- * });
- * @memberof PIXI
- */
- var Prepare = /** @class */ (function (_super) {
- __extends(Prepare, _super);
- /**
- * @param {PIXI.Renderer} renderer - A reference to the current renderer
- */
- function Prepare(renderer) {
- var _this = _super.call(this, renderer) || this;
- _this.uploadHookHelper = _this.renderer;
- // Add textures and graphics to upload
- _this.registerFindHook(findGraphics);
- _this.registerUploadHook(uploadBaseTextures);
- _this.registerUploadHook(uploadGraphics);
- return _this;
- }
- /** @ignore */
- Prepare.extension = {
- name: 'prepare',
- type: ExtensionType.RendererPlugin,
- };
- return Prepare;
- }(BasePrepare));
- /**
- * TimeLimiter limits the number of items handled by a {@link PIXI.BasePrepare} to a specified
- * number of milliseconds per frame.
- * @memberof PIXI
- */
- var TimeLimiter = /** @class */ (function () {
- /** @param maxMilliseconds - The maximum milliseconds that can be spent preparing items each frame. */
- function TimeLimiter(maxMilliseconds) {
- this.maxMilliseconds = maxMilliseconds;
- this.frameStart = 0;
- }
- /** Resets any counting properties to start fresh on a new frame. */
- TimeLimiter.prototype.beginFrame = function () {
- this.frameStart = Date.now();
- };
- /**
- * Checks to see if another item can be uploaded. This should only be called once per item.
- * @returns - If the item is allowed to be uploaded.
- */
- TimeLimiter.prototype.allowedToUpload = function () {
- return Date.now() - this.frameStart < this.maxMilliseconds;
- };
- return TimeLimiter;
- }());
- export { BasePrepare, CountLimiter, Prepare, TimeLimiter };
- //# sourceMappingURL=prepare.mjs.map
|