xr-frame / Exports / TextureLoader
# Class: TextureLoader
纹理资源Texture的加载器。
内置资源可以通过registerTexture注册,拥有内置资源brdf-lut
、white
、transparent
、black
、red
、green
、blue
、yellow
、babyblue
、babygreen
、babyred
。
# Hierarchy
AssetLoader
<Kanata.Texture
,ITextureLoaderOptions
>↳
TextureLoader
# Table of contents
# Constructors
# Properties
# Accessors
# Methods
# Constructors
# constructor
• new TextureLoader(_scene
, type
)
# Parameters
Name | Type |
---|---|
_scene | Scene |
type | string |
# Inherited from
# Properties
# schema
• Readonly
schema: ILoaderOptionsSchema
和Component.schema类似,指定解析Options的实际schema
,对应于ILoadOptions
。
# Overrides
# Accessors
# scene
• get
scene(): Scene
当前资源所属场景的实例。
# Returns
# Methods
# cancel
▸ cancel(params
): void
取消加载特定资源。一般不需要自己编写逻辑,而是使用entity.canceled
在加载终点丢弃。
注意entity.canceled
是在这里赋值的,所以一般继承请务必先执行super.cancel()
!
# Parameters
Name | Type |
---|---|
params | IAssetLoadData <ITextureLoaderOptions > |
# Returns
void
# Inherited from
# getBuiltin
▸ getBuiltin(): { assetId
: string
= 'brdf-lut'; options
: {} = {}; src
: string
= 'https://mmbizwxaminiprogram-1258344707.cos.ap-guangzhou.myqcloud.com/xr-frame/brdflut.png' }[]
返回默认资源列表。 所有默认资源都是惰性加载的。
# Returns
{ assetId
: string
= 'brdf-lut'; options
: {} = {}; src
: string
= 'https://mmbizwxaminiprogram-1258344707.cos.ap-guangzhou.myqcloud.com/xr-frame/brdflut.png' }[]
# Overrides
# load
▸ load(params
, callbacks
): void
加载一个资源,并根据情况执行callbacks
中的回调。
理论上必须要实现!
# Parameters
Name | Type |
---|---|
params | ITextureLoadData |
callbacks | Object |
callbacks.onError | (error : Error ) => void |
callbacks.onLoaded | (value : default ) => void |
callbacks.onLoading | (progress : number ) => void |
# Returns
void
# Overrides
# release
▸ release(params
, value
): void
释放资源时将会调用,用于自定义释放逻辑。
# Parameters
Name | Type |
---|---|
params | ITextureLoadData |
value | default |
# Returns
void