Files
cocos4/cocos/core/assets/texture-util.ts
T
Jare Guo 0319477911 fix decorator warning of ValueTypes (#7553)
* fix decorator warning of ValueTypes (sync #6285)

* refresh copyright
2020-10-21 16:31:41 +08:00

149 lines
4.8 KiB
TypeScript

/*
Copyright (c) 2013-2016 Chukong Technologies Inc.
Copyright (c) 2017-2020 Xiamen Yaji Software Co., Ltd.
http://www.cocos.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated engine source code (the "Software"), a limited,
worldwide, royalty-free, non-assignable, revocable and non-exclusive license
to use Cocos Creator solely to develop games on your target platforms. You shall
not use Cocos Creator software for developing other software or tools that's
used for developing games. You are not granted to publish, distribute,
sublicense, and/or sell copies of Cocos Creator.
The software or tools in this License Agreement are licensed, not sold.
Xiamen Yaji Software Co., Ltd. reserves all rights not expressly granted to you.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
/**
* @packageDocumentation
* @module asset
*/
import { assertID, error } from '../platform/debug';
import { loader } from '../load-pipeline/CCLoader';
import { ImageAsset, ImageSource } from './image-asset';
import { DEBUG } from 'internal:constants';
import { IItem } from '../load-pipeline/loading-items';
export type LoadImageCallback<T> = (
this: T | undefined,
error: Error | null | undefined,
asset?: ImageAsset,
) => void;
/**
* @en Load an image asset with the given url.
* @zh 加载指定的图像资源。
* @param url The url of the image
* @param callback Callback for receiving the loaded asset
* @param target The callee of the callback function
* @returns The ImageAsset, it could be in the loading process, the callback will tell whether the loading process succeed or failed.
* @private
*/
export function loadImage<T extends object> (url: string, callback?: LoadImageCallback<T>, target?: T) {
assertID(!!url, 3103);
let imageAsset = loader.getRes<ImageAsset>(url);
if (imageAsset) {
if (imageAsset.loaded) {
if (callback){
callback.call(target, null, imageAsset);
}
return imageAsset;
} else {
imageAsset.once('load', () => {
if (callback) {
callback.call(target, null, imageAsset!);
}
}, target);
return imageAsset;
}
} else {
imageAsset = new ImageAsset();
loader.load({url, imageAsset}, (err, asset) => {
if (err) {
if (callback) {
callback.call(target, err || new Error('Unknown error'));
}
return imageAsset;
}
if (callback) {
callback.call(target, null, asset);
}
});
return imageAsset;
}
}
/**
* @en Cache the [[ImageAsset]] with url as key.
* @zh 缓存指定的图像源,为它指定链接。此后,可以通过该链接直接加载它。
* @param url The url as key
* @param image The image to be cached
* @private
*/
export function cacheImage (url: string, image: ImageSource) {
if (url && image) {
const imageAsset = new ImageAsset(image);
const item = {
id: url,
url, // real download url, maybe changed
error: null,
content: imageAsset,
complete: false,
};
loader.flowOut(item as IItem);
return imageAsset;
}
}
/**
* @en Try to load the actual data of the image asset.
* @zh 尝试加载图像资源的实际数据。
* @param imageAsset The image asset
* @param callback The callback function after loaded
* @private
*/
export function postLoadImage (imageAsset: ImageAsset, callback?: Function) {
if (imageAsset.loaded) {
if (callback) {
callback();
}
return;
}
if (!imageAsset.nativeUrl) {
if (callback) {
callback();
}
return;
}
// load image
loader.load({
url: imageAsset.nativeUrl,
// For image, we should skip loader otherwise it will load a new ImageAsset
skips: imageAsset.isCompressed ? undefined : ['Loader'],
}, (err, image) => {
if (image) {
if (DEBUG && image instanceof ImageAsset) {
return error('internal error: loader handle pipe must be skipped');
}
if (!imageAsset.loaded) {
imageAsset._nativeAsset = image;
}
}
if (callback) {
callback(err);
}
});
}