MeshGradientRenderer
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:719
实现了这个接口的东西需要在使用完毕后
手动调用 dispose
函数来销毁清除占用资源
以免产生泄露
Extends
Constructors
Constructor
new MeshGradientRenderer(canvas): MeshGradientRenderer
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:887
Parameters
Parameter | Type |
---|---|
canvas | HTMLCanvasElement |
Returns
MeshGradientRenderer
Overrides
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
canvas | protected | HTMLCanvasElement | undefined | BaseRenderer .canvas | packages/core/src/bg-render/base.ts:71 |
currerntRenderScale | protected | number | 0.75 | BaseRenderer .currerntRenderScale | packages/core/src/bg-render/base.ts:70 |
flowSpeed | protected | number | 4 | BaseRenderer .flowSpeed | packages/core/src/bg-render/base.ts:69 |
Methods
dispose()
dispose(): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:1058
销毁实现了该接口的对象实例,释放占用的资源
一般情况下,调用本函数后就不可以再调用对象的任何函数了
Returns
void
Overrides
getControlPoint()
getControlPoint(x, y): undefined | ControlPoint
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:752
Parameters
Parameter | Type |
---|---|
x | number |
y | number |
Returns
undefined
| ControlPoint
getElement()
getElement(): HTMLElement
Defined in: packages/core/src/bg-render/base.ts:149
获取这个类所对应的 HTML 元素实例
Returns
HTMLElement
Inherited from
onResize()
protected onResize(width, height): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:920
当画板元素大小发生变化时此函数会被调用 可以在此处重设和渲染器相关的尺寸设置 考虑到初始化的时候元素不一定在文档中或出于某些特殊样式状态,尺寸长宽有可能会为 0,请注意进行特判处理
Parameters
Parameter | Type | Description |
---|---|---|
width | number | 画板元素实际的物理像素宽度,有可能为 0 |
height | number | 画板元素实际的物理像素高度,有可能为 0 |
Returns
void
Overrides
pause()
pause(): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:934
暂停背景动画,画面即便是更新了图片也不会发生变化
Returns
void
Overrides
resetSubdivition()
resetSubdivition(subDivisions): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:765
Parameters
Parameter | Type |
---|---|
subDivisions | number |
Returns
void
resizeControlPoints()
resizeControlPoints(width, height): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:759
Parameters
Parameter | Type |
---|---|
width | number |
height | number |
Returns
void
resume()
resume(): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:941
恢复播放背景动画
Returns
void
Overrides
setAlbum()
setAlbum(albumSource?, isVideo?): Promise<void>
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:945
设置背景专辑资源,纹理加载并设置完成后会返回
Parameters
Parameter | Type | Description |
---|---|---|
albumSource ? | string | HTMLImageElement | HTMLVideoElement | 专辑的资源链接,可以是图片或视频链接,抑或是任意 img/video 元素,如果提供字符串链接且为视频则需要指定第二个参数 |
isVideo ? | boolean | - |
Returns
Promise
<void
>
Overrides
setFlowSpeed()
setFlowSpeed(speed): void
Defined in: packages/core/src/bg-render/base.ts:114
修改背景的流动速度,数字越大越快,默认为 4
Parameters
Parameter | Type | Description |
---|---|---|
speed | number | 背景的流动速度,默认为 4 |
Returns
void
Inherited from
setFPS()
setFPS(fps): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:931
修改背景动画帧率,默认是 30 FPS
如果设置成 0 则会停止动画
Parameters
Parameter | Type | Description |
---|---|---|
fps | number | 目标帧率,默认 30 FPS |
Returns
void
Overrides
setHasLyric()
setHasLyric(_hasLyric): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:1054
设置背景是否根据“是否有歌词”这个特征调整自身效果,例如有歌词时会变得更加活跃
部分渲染器会根据这个特征调整自身效果
如果不确定是否需要赋值或无法知晓是否包含歌词,请传入 true 或不做任何处理(默认值为 true)
Parameters
Parameter | Type |
---|---|
_hasLyric | boolean |
Returns
void
Overrides
setLowFreqVolume()
setLowFreqVolume(volume): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:1051
设置低频的音量大小,范围在 80hz-120hz 之间为宜,取值范围在 [0.0-1.0] 之间
部分渲染器会根据音量大小调整背景效果(例如根据鼓点跳动)
如果无法获取到类似的数据,请传入 1.0 作为默认值,或不做任何处理(默认值即 1.0)
Parameters
Parameter | Type | Description |
---|---|---|
volume | number | 低频的音量大小,范围在 50hz-120hz 之间为宜,取值范围在 [0.0-1.0] 之间 |
Returns
void
Overrides
setManualControl()
setManualControl(enable): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:742
Parameters
Parameter | Type |
---|---|
enable | boolean |
Returns
void
setRenderScale()
setRenderScale(scale): void
Defined in: packages/core/src/bg-render/base.ts:88
修改背景的渲染比例,默认是 0.5
一般情况下这个程度既没有明显瑕疵也不会特别吃性能
Parameters
Parameter | Type | Description |
---|---|---|
scale | number | 背景的渲染比例 |
Returns
void
Inherited from
setStaticMode()
setStaticMode(enable): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:926
是否启用静态模式,即图片在更换后就会保持静止状态并禁用更新,以节省性能
Parameters
Parameter | Type | Description |
---|---|---|
enable | boolean | 是否启用静态模式 |
Returns
void
Overrides
setWireFrame()
setWireFrame(enable): void
Defined in: packages/core/src/bg-render/mesh-renderer/index.ts:746
Parameters
Parameter | Type |
---|---|
enable | boolean |
Returns
void