xr-frame / Exports / AssetRenderTexture
# Class: AssetRenderTexture
渲染纹理创建组件,用于在xml
中创建RenderTexture资源,一般被代理到XRAssetRenderTexture元素。
# Hierarchy
Component
<IAssetRenderTextureData
>↳
AssetRenderTexture
# Table of contents
# Constructors
# Events
# Properties
# Accessors
# Methods
# Constructors
# constructor
• new AssetRenderTexture()
# Inherited from
# Events
# onAdd
▸ onAdd(parent
, data
): void
所挂载的element
被挂载到场景时触发的回调。
# Parameters
Name | Type |
---|---|
parent | Element |
data | IAssetRenderTextureData |
# Returns
void
# Inherited from
# onRelease
▸ onRelease(data
): void
从被挂载的element
上被移除,或是element
被销毁时,触发的回调。
一般用于释放持有的资源。
# Parameters
Name | Type |
---|---|
data | IAssetRenderTextureData |
# Returns
void
# Inherited from
# onRemove
▸ onRemove(parent
, data
): void
移除AssetRenderTexture。
# Parameters
Name | Type |
---|---|
parent | Element |
data | IAssetRenderTextureData |
# Returns
void
# Inherited from
# onTick
▸ onTick(deltaTime
, data
): void
渲染每帧触发的回调。
# Parameters
Name | Type | Description |
---|---|---|
deltaTime | number | 单位为毫秒(ms)。 |
data | IAssetRenderTextureData | - |
# Returns
void
# Inherited from
# onUpdate
▸ onUpdate(data
, preData
): void
数据更新时触发的回调。
# Parameters
Name | Type |
---|---|
data | IAssetRenderTextureData |
preData | IAssetRenderTextureData |
# Returns
void
# Inherited from
# Properties
# isAssetRenderTexture
• Readonly
isAssetRenderTexture: boolean
= true
# priority
• Readonly
priority: number
自定义组件的更新优先级。
# Inherited from
# schema
• Readonly
schema: IComponentSchema
# Overrides
# EVENTS
▪ Static
EVENTS: string
[] = []
# Inherited from
# Accessors
# el
• get
el(): Element
挂载的元素。
# Returns
# scene
• get
scene(): Scene
当前场景。
# Returns
# version
• get
version(): number
当前版本,每次有数据更新都会增加,可以用作和其他组件合作的依据。
# Returns
number
# Methods
# getData
▸ getData<T
>(key
): IAssetRenderTextureData
[T
]
获取一个当前值。
# Type parameters
Name | Type |
---|---|
T | extends keyof IAssetRenderTextureData |
# Parameters
Name | Type |
---|---|
key | T |
# Returns
# Inherited from
# setData
▸ setData(data
): void
不通过xml
而是直接设置data
,注意值的类型需要和schema
中一致。
# Parameters
Name | Type |
---|---|
data | Partial <IAssetRenderTextureData > |
# Returns
void
# Inherited from
# setDataOne
▸ setDataOne<T
>(key
, value
): void
设置一个数据。
# Type parameters
Name | Type |
---|---|
T | extends keyof IAssetRenderTextureData |
# Parameters
Name | Type |
---|---|
key | T |
value | IAssetRenderTextureData [T ] |
# Returns
void