-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
/
ImageResource.js
292 lines (251 loc) · 7.81 KB
/
ImageResource.js
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
import { BaseImageResource } from './BaseImageResource';
import { settings } from '@pixi/settings';
import { ALPHA_MODES } from '@pixi/constants';
/**
* Resource type for HTMLImageElement.
* @class
* @extends PIXI.resources.BaseImageResource
* @memberof PIXI.resources
*/
export class ImageResource extends BaseImageResource
{
/**
* @param {HTMLImageElement|string} source - image source or URL
* @param {boolean} [options.autoLoad=true] start loading process
* @param {boolean} [options.createBitmap=PIXI.settings.CREATE_IMAGE_BITMAP] whether its required to create
* a bitmap before upload
* @param {boolean} [options.crossorigin=true] - Load image using cross origin
* @param {PIXI.ALPHA_MODES} [options.alphaMode=PIXI.ALPHA_MODES.UNPACK] - Premultiply image alpha in bitmap
*/
constructor(source, options)
{
options = options || {};
if (!(source instanceof HTMLImageElement))
{
const imageElement = new Image();
BaseImageResource.crossOrigin(imageElement, source, options.crossorigin);
imageElement.src = source;
source = imageElement;
}
super(source);
// FireFox 68, and possibly other versions, seems like setting the HTMLImageElement#width and #height
// to non-zero values before its loading completes if images are in a cache.
// Because of this, need to set the `_width` and the `_height` to zero to avoid uploading incomplete images.
// Please refer to the issue #5968 (https://github.com/pixijs/pixi.js/issues/5968).
if (!source.complete && !!this._width && !!this._height)
{
this._width = 0;
this._height = 0;
}
/**
* URL of the image source
* @member {string}
*/
this.url = source.src;
/**
* When process is completed
* @member {Promise<void>}
* @private
*/
this._process = null;
/**
* If the image should be disposed after upload
* @member {boolean}
* @default false
*/
this.preserveBitmap = false;
/**
* If capable, convert the image using createImageBitmap API
* @member {boolean}
* @default PIXI.settings.CREATE_IMAGE_BITMAP
*/
this.createBitmap = (options.createBitmap !== undefined
? options.createBitmap : settings.CREATE_IMAGE_BITMAP) && !!window.createImageBitmap;
/**
* Controls texture alphaMode field
* Copies from options
* Default is `null`, copies option from baseTexture
*
* @member {PIXI.ALPHA_MODES|null}
* @readonly
*/
this.alphaMode = typeof options.alphaMode === 'number' ? options.alphaMode : null;
if (options.premultiplyAlpha !== undefined)
{
// triggers deprecation
this.premultiplyAlpha = options.premultiplyAlpha;
}
/**
* The ImageBitmap element created for HTMLImageElement
* @member {ImageBitmap}
* @default null
*/
this.bitmap = null;
/**
* Promise when loading
* @member {Promise<void>}
* @private
* @default null
*/
this._load = null;
if (options.autoLoad !== false)
{
this.load();
}
}
/**
* returns a promise when image will be loaded and processed
*
* @param {boolean} [createBitmap=true] whether process image into bitmap
* @returns {Promise<void>}
*/
load(createBitmap)
{
if (createBitmap !== undefined)
{
this.createBitmap = createBitmap;
}
if (this._load)
{
return this._load;
}
this._load = new Promise((resolve) =>
{
this.url = this.source.src;
const { source } = this;
const completed = () =>
{
if (this.destroyed)
{
return;
}
source.onload = null;
source.onerror = null;
this.resize(source.width, source.height);
this._load = null;
if (this.createBitmap)
{
resolve(this.process());
}
else
{
resolve(this);
}
};
if (source.complete && source.src)
{
completed();
}
else
{
source.onload = completed;
source.onerror = (event) => this.onError.run(event);
}
});
return this._load;
}
/**
* Called when we need to convert image into BitmapImage.
* Can be called multiple times, real promise is cached inside.
*
* @returns {Promise<void>} cached promise to fill that bitmap
*/
process()
{
if (this._process !== null)
{
return this._process;
}
if (this.bitmap !== null || !window.createImageBitmap)
{
return Promise.resolve(this);
}
this._process = window.createImageBitmap(this.source,
0, 0, this.source.width, this.source.height,
{
premultiplyAlpha: this.premultiplyAlpha === ALPHA_MODES.UNPACK ? 'premultiply' : 'none',
})
.then((bitmap) =>
{
if (this.destroyed)
{
return Promise.reject();
}
this.bitmap = bitmap;
this.update();
this._process = null;
return Promise.resolve(this);
});
return this._process;
}
/**
* Upload the image resource to GPU.
*
* @param {PIXI.Renderer} renderer - Renderer to upload to
* @param {PIXI.BaseTexture} baseTexture - BaseTexture for this resource
* @param {PIXI.GLTexture} glTexture - GLTexture to use
* @returns {boolean} true is success
*/
upload(renderer, baseTexture, glTexture)
{
if (typeof this.alphaMode === 'number')
{
// bitmap stores unpack premultiply flag, we dont have to notify texImage2D about it
baseTexture.alphaMode = this.alphaMode;
}
if (!this.createBitmap)
{
return super.upload(renderer, baseTexture, glTexture);
}
if (!this.bitmap)
{
// yeah, ignore the output
this.process();
if (!this.bitmap)
{
return false;
}
}
super.upload(renderer, baseTexture, glTexture, this.bitmap);
if (!this.preserveBitmap)
{
// checks if there are other renderers that possibly need this bitmap
let flag = true;
for (const key in baseTexture._glTextures)
{
const otherTex = baseTexture._glTextures[key];
if (otherTex !== glTexture && otherTex.dirtyId !== baseTexture.dirtyId)
{
flag = false;
break;
}
}
if (flag)
{
if (this.bitmap.close)
{
this.bitmap.close();
}
this.bitmap = null;
}
}
return true;
}
/**
* Destroys this texture
* @override
*/
dispose()
{
this.source.onload = null;
this.source.onerror = null;
super.dispose();
if (this.bitmap)
{
this.bitmap.close();
this.bitmap = null;
}
this._process = null;
this._load = null;
}
}