MeshGradientRenderer
实现了这个接口的东西需要在使用完毕后
手动调用 dispose 函数来销毁清除占用资源
以免产生泄露
Extends
Constructors
new MeshGradientRenderer()
new MeshGradientRenderer(
canvas):MeshGradientRenderer
Parameters
• canvas: HTMLCanvasElement
Returns
Overrides
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:885
Methods
dispose()
dispose():
void
销毁实现了该接口的对象实例，释放占用的资源
一般情况下，调用本函数后就不可以再调用对象的任何函数了
Returns
void
Overrides
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:1055
getControlPoint()
getControlPoint(
x,y):undefined|ControlPoint
Parameters
• x: number
• y: number
Returns
undefined | ControlPoint
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:750
getElement()
getElement():
HTMLElement
获取这个类所对应的 HTML 元素实例
Returns
HTMLElement
Inherited from
Defined in
packages/core/src/bg-render/base.ts:149
pause()
pause():
void
暂停背景动画，画面即便是更新了图片也不会发生变化
Returns
void
Overrides
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:932
resetSubdivition()
resetSubdivition(
subDivisions):void
Parameters
• subDivisions: number
Returns
void
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:763
resizeControlPoints()
resizeControlPoints(
width,height):void
Parameters
• width: number
• height: number
Returns
void
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:757
resume()
resume():
void
恢复播放背景动画
Returns
void
Overrides
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:939
setAlbum()
setAlbum(
albumSource?,isVideo?):Promise<void>
设置背景专辑资源，纹理加载并设置完成后会返回
Parameters
• albumSource?: string | HTMLImageElement | HTMLVideoElement
专辑的资源链接，可以是图片或视频链接，抑或是任意 img/video 元素，如果提供字符串链接且为视频则需要指定第二个参数
• isVideo?: boolean
Returns
Promise<void>
Overrides
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:943
setFlowSpeed()
setFlowSpeed(
speed):void
修改背景的流动速度，数字越大越快，默认为 4
Parameters
• speed: number
背景的流动速度，默认为 4
Returns
void
Inherited from
Defined in
packages/core/src/bg-render/base.ts:114
setFPS()
setFPS(
fps):void
修改背景动画帧率，默认是 30 FPS
如果设置成 0 则会停止动画
Parameters
• fps: number
目标帧率，默认 30 FPS
Returns
void
Overrides
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:929
setHasLyric()
setHasLyric(
_hasLyric):void
设置背景是否根据“是否有歌词”这个特征调整自身效果，例如有歌词时会变得更加活跃
部分渲染器会根据这个特征调整自身效果
如果不确定是否需要赋值或无法知晓是否包含歌词，请传入 true 或不做任何处理（默认值为 true）
Parameters
• _hasLyric: boolean
Returns
void
Overrides
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:1051
setLowFreqVolume()
setLowFreqVolume(
volume):void
设置低频的音量大小，范围在 80hz-120hz 之间为宜，取值范围在 [0.0-1.0] 之间
部分渲染器会根据音量大小调整背景效果（例如根据鼓点跳动）
如果无法获取到类似的数据，请传入 1.0 作为默认值，或不做任何处理（默认值即 1.0）
Parameters
• volume: number
低频的音量大小，范围在 50hz-120hz 之间为宜，取值范围在 [0.0-1.0] 之间
Returns
void
Overrides
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:1048
setManualControl()
setManualControl(
enable):void
Parameters
• enable: boolean
Returns
void
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:740
setRenderScale()
setRenderScale(
scale):void
修改背景的渲染比例，默认是 0.5
一般情况下这个程度既没有明显瑕疵也不会特别吃性能
Parameters
• scale: number
背景的渲染比例
Returns
void
Inherited from
Defined in
packages/core/src/bg-render/base.ts:88
setStaticMode()
setStaticMode(
enable):void
是否启用静态模式，即图片在更换后就会保持静止状态并禁用更新，以节省性能
Parameters
• enable: boolean
是否启用静态模式
Returns
void
Overrides
Defined in
packages/core/src/bg-render/mesh-renderer/index.ts:924
setWireFrame()
setWireFrame(
enable):void
Parameters
• enable: boolean
Returns
void