微信小程序

ImageLoader

xr-frame / Exports / ImageLoader

# Class: ImageLoader

图片数据资源IImage的加载器。

图片数据不同于纹理资源Texture,请自行按照场景使用。

# Hierarchy

  • AssetLoader<IImage, IImageLoaderOptions>

    ImageLoader

# Table of contents

# Constructors

  • constructor

# Properties

  • schema

# Accessors

  • scene

# Methods

  • cancel
  • getBuiltin
  • load
  • release

# Constructors

# constructor

new ImageLoader(_scene, type)

# Parameters
Name Type
_scene Scene
type string
# Inherited from

AssetLoader.constructor

# Properties

# schema

Readonly schema: ILoaderOptionsSchema = {}

和Component.schema类似,指定解析Options的实际schema,对应于ILoadOptions

# Overrides

AssetLoader.schema

# Accessors

# scene

get scene(): Scene

当前资源所属场景的实例。

# Returns

Scene

# Methods

# cancel

cancel(params): void

取消加载特定资源。一般不需要自己编写逻辑,而是使用entity.canceled在加载终点丢弃。 注意entity.canceled是在这里赋值的,所以一般继承请务必先执行super.cancel()

# Parameters
Name Type
params IAssetLoadData<IImageLoaderOptions>
# Returns

void

# Inherited from

AssetLoader.cancel

# getBuiltin

getBuiltin(): { assetId: string ; options: IImageLoaderOptions ; src: string }[]

返回默认资源列表。 所有默认资源都是惰性加载的。

# Returns

{ assetId: string ; options: IImageLoaderOptions ; src: string }[]

# Inherited from

AssetLoader.getBuiltin

# load

load(params, callbacks): void

加载一个资源,并根据情况执行callbacks中的回调。 理论上必须要实现!

# Parameters
Name Type
params IImageLoadData
callbacks Object
callbacks.onError (error: Error) => void
callbacks.onLoaded (value: IImage) => void
callbacks.onLoading (progress: number) => void
# Returns

void

# Overrides

AssetLoader.load

# release

release(params, value): void

释放资源时将会调用,用于自定义释放逻辑。

# Parameters
Name Type
params IImageLoadData
value IImage
# Returns

void

# Overrides

AssetLoader.release