- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
- 413
- 414
- 415
- 416
- 417
- 418
- 419
- 420
- 421
- 422
- 423
- 424
- 425
- 426
- 427
- 428
- 429
- 430
- 431
- 432
- 433
- 434
- 435
- 436
- 437
- 438
- 439
- 440
- 441
- 442
- 443
- 444
- 445
- 446
- 447
- 448
- 449
- 450
- 451
- 452
- 453
- 454
- 455
- 456
- 457
- 458
- 459
- 460
- 461
- 462
- 463
- 464
- 465
- 466
- 467
- 468
- 469
- 470
- 471
- 472
- 473
- 474
- 475
- 476
- 477
- 478
- 479
- 480
- 481
- 482
- 483
- 484
- 485
- 486
- 487
- 488
- 489
- 490
- 491
- 492
- 493
- 494
- 495
- 496
- 497
- 498
- 499
- 500
- 501
- 502
- 503
- 504
- 505
- 506
- 507
- 508
- 509
- 510
- 511
- 512
- 513
- 514
- 515
- 516
- 517
- 518
- 519
- 520
- 521
- 522
- 523
- 524
- 525
- 526
- 527
- 528
- 529
- 530
- 531
- 532
- 533
- 534
- 535
- 536
- 537
import { Texture, BaseTexture } from '@pixi/core';
import { Ticker, UPDATE_PRIORITY } from '@pixi/ticker';
import { settings } from '@pixi/settings';
import type { DisplayObject } from '@pixi/display';
import { Container } from '@pixi/display';
import { Text, TextStyle, TextMetrics } from '@pixi/text';
import { CountLimiter } from './CountLimiter';
import type { AbstractRenderer } from '@pixi/core';
import { deprecation } from '@pixi/utils';
interface IArrowFunction
{
(): void;
}
interface IUploadHook
{
(helper: AbstractRenderer | BasePrepare, item: IDisplayObjectExtended): boolean;
}
interface IFindHook
{
(item: any, queue: Array<any>): boolean;
}
export interface IDisplayObjectExtended extends DisplayObject
{
_textures?: Array<Texture>;
_texture?: Texture;
style?: TextStyle | Partial<TextStyle>;
}
/**
* 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: IDisplayObjectExtended, queue: Array<any>): boolean
{
let result = false;
// Objects with multiple textures
if (item && item._textures && item._textures.length)
{
for (let i = 0; i < item._textures.length; i++)
{
if (item._textures[i] instanceof Texture)
{
const 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: Texture, queue: Array<any>): boolean
{
if (item.baseTexture instanceof BaseTexture)
{
const 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: IDisplayObjectExtended, queue: Array<any>): boolean
{
if (item._texture && item._texture instanceof Texture)
{
const 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: AbstractRenderer | BasePrepare, item: IDisplayObjectExtended): boolean
{
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: AbstractRenderer | BasePrepare, item: IDisplayObjectExtended): boolean
{
if (item instanceof TextStyle)
{
const 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: IDisplayObjectExtended, queue: Array<any>): boolean
{
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
const 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: TextStyle, queue: Array<any>): boolean
{
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
*/
export class BasePrepare
{
/**
* The limiter to be used to control how quickly items are prepared.
* @type {PIXI.CountLimiter|PIXI.TimeLimiter}
*/
private limiter: CountLimiter;
/** Reference to the renderer. */
protected renderer: AbstractRenderer;
/**
* The only real difference between CanvasPrepare and Prepare is what they pass
* to upload hooks. That different parameter is stored here.
*/
protected uploadHookHelper: any;
/** Collection of items to uploads at once. */
protected queue: Array<any>;
/**
* Collection of additional hooks for finding assets.
* @type {Array<Function>}
*/
public addHooks: Array<any>;
/**
* Collection of additional hooks for processing assets.
* @type {Array<Function>}
*/
public uploadHooks: Array<any>;
/**
* Callback to call after completed.
* @type {Array<Function>}
*/
public completes: Array<any>;
/**
* If prepare is ticking (running).
* @type {boolean}
*/
public ticking: boolean;
/**
* 'bound' call for prepareItems().
* @type {Function}
*/
private delayedTick: IArrowFunction;
/**
* @param {PIXI.AbstractRenderer} renderer - A reference to the current renderer
*/
constructor(renderer: AbstractRenderer)
{
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 = (): void =>
{
// 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);
}
/**
* Upload all the textures and graphics to the GPU.
* @method PIXI.BasePrepare#upload
* @param {PIXI.DisplayObject|PIXI.Container|PIXI.BaseTexture|PIXI.Texture|PIXI.Graphics|PIXI.Text} [item] -
* Container or display object to search for items to upload or the items to upload themselves,
* or optionally ommitted, if items have been added using {@link PIXI.BasePrepare#add `prepare.add`}.
*/
upload(item?: IDisplayObjectExtended | Container | BaseTexture | Texture): Promise<void>;
/**
* Use the Promise-based API instead.
* @method PIXI.BasePrepare#upload
* @deprecated since version 6.5.0
* @param {PIXI.DisplayObject|PIXI.Container|PIXI.BaseTexture|PIXI.Texture|PIXI.Graphics|PIXI.Text} item -
* Item to upload.
* @param {Function} [done] - Callback when completed.
*/
upload(item?: IDisplayObjectExtended | Container | BaseTexture | Texture, done?: () => void): void;
/**
* Use the Promise-based API instead.
* @method PIXI.BasePrepare#upload
* @deprecated since version 6.5.0
* @param {Function} [done] - Callback when completed.
*/
upload(done?: () => void): void;
/** @ignore */
upload(
item?: IDisplayObjectExtended | Container | BaseTexture | Texture | (() => void),
done?: () => void): Promise<void>
{
if (typeof item === 'function')
{
done = item as () => void;
item = null;
}
// #if _DEBUG
if (done)
{
deprecation('6.5.0', 'BasePrepare.upload callback is deprecated, use the return Promise instead.');
}
// #endif
return new Promise((resolve) =>
{
// If a display object, search for items
// that we could upload
if (item)
{
this.add(item as IDisplayObjectExtended | Container | BaseTexture | Texture);
}
// TODO: remove done callback and just use resolve
const complete = () =>
{
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
*/
tick(): void
{
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
*/
prepareItems(): void
{
this.limiter.beginFrame();
// Upload the graphics
while (this.queue.length && this.limiter.allowedToUpload())
{
const item = this.queue[0];
let uploaded = false;
if (item && !item._destroyed)
{
for (let 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;
const completes = this.completes.slice(0);
this.completes.length = 0;
for (let 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.
*/
registerFindHook(addHook: IFindHook): this
{
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.
*/
registerUploadHook(uploadHook: IUploadHook): this
{
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.
*/
add(item: IDisplayObjectExtended | Container | BaseTexture | Texture): this
{
// Add additional hooks for finding elements on special
// types of objects that
for (let 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 (let i = item.children.length - 1; i >= 0; i--)
{
this.add(item.children[i]);
}
}
return this;
}
/** Destroys the plugin, don't use after this. */
destroy(): void
{
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;
}
}