BackgroundRender

Defined in: packages/core/src/bg-render/index.ts:12

实现了这个接口的东西需要在使用完毕后

手动调用 dispose 函数来销毁清除占用资源

以免产生泄露

Type Parameters

Type Parameter
Renderer extends BaseRenderer

Implements

• AbstractBaseRenderer

Constructors

Constructor

new BackgroundRender<Renderer>(renderer, canvas): BackgroundRender<Renderer>

Defined in: packages/core/src/bg-render/index.ts:17

Parameters

Parameter	Type
renderer	Renderer
canvas	HTMLCanvasElement

Returns

BackgroundRender<Renderer>

Methods

dispose()

dispose(): void

Defined in: packages/core/src/bg-render/index.ts:67

销毁实现了该接口的对象实例，释放占用的资源

一般情况下，调用本函数后就不可以再调用对象的任何函数了

Returns

void

Implementation of

AbstractBaseRenderer.dispose

---

getElement()

getElement(): HTMLCanvasElement

Defined in: packages/core/src/bg-render/index.ts:64

获取这个类所对应的 HTML 元素实例

Returns

HTMLCanvasElement

Implementation of

AbstractBaseRenderer.getElement

---

pause()

pause(): void

Defined in: packages/core/src/bg-render/index.ts:46

暂停背景动画，画面即便是更新了图片也不会发生变化

Returns

void

Implementation of

AbstractBaseRenderer.pause

---

resume()

resume(): void

Defined in: packages/core/src/bg-render/index.ts:49

恢复播放背景动画

Returns

void

Implementation of

AbstractBaseRenderer.resume

---

setAlbum()

setAlbum(albumSource, isVideo?): Promise<void>

Defined in: packages/core/src/bg-render/index.ts:58

设置背景专辑资源，纹理加载并设置完成后会返回

Parameters

Parameter	Type	Description
albumSource	string | HTMLImageElement | HTMLVideoElement	专辑的资源链接，可以是图片或视频链接，抑或是任意 img/video 元素，如果提供字符串链接且为视频则需要指定第二个参数
isVideo?	boolean	-

Returns

Promise<void>

Implementation of

AbstractBaseRenderer.setAlbum

---

setFlowSpeed()

setFlowSpeed(speed): void

Defined in: packages/core/src/bg-render/index.ts:37

修改背景的流动速度，数字越大越快，默认为 8

Parameters

Parameter	Type	Description
speed	number	背景的流动速度，默认为 8

Returns

void

Implementation of

AbstractBaseRenderer.setFlowSpeed

---

setFPS()

setFPS(fps): void

Defined in: packages/core/src/bg-render/index.ts:43

修改背景动画帧率，默认是 30 FPS

如果设置成 0 则会停止动画

Parameters

Parameter	Type	Description
fps	number	目标帧率，默认 30 FPS

Returns

void

Implementation of

AbstractBaseRenderer.setFPS

---

setHasLyric()

setHasLyric(hasLyric): void

Defined in: packages/core/src/bg-render/index.ts:55

设置背景是否根据“是否有歌词”这个特征调整自身效果，例如有歌词时会变得更加活跃

部分渲染器会根据这个特征调整自身效果

如果不确定是否需要赋值或无法知晓是否包含歌词，请传入 true 或不做任何处理（默认值为 true）

Parameters

Parameter	Type	Description
hasLyric	boolean	是否有歌词，如不确定是否需要赋值，请传入 true 或不做任何处理（默认值为 true）

Returns

void

Implementation of

AbstractBaseRenderer.setHasLyric

---

setLowFreqVolume()

setLowFreqVolume(volume): void

Defined in: packages/core/src/bg-render/index.ts:52

设置低频的音量大小，范围在 80hz-120hz 之间为宜，取值范围在 [0.0-1.0] 之间

部分渲染器会根据音量大小调整背景效果（例如根据鼓点跳动）

如果无法获取到类似的数据，请传入 1.0 作为默认值，或不做任何处理（默认值即 1.0）

Parameters

Parameter	Type	Description
volume	number	低频的音量大小，范围在 50hz-120hz 之间为宜，取值范围在 [0.0-1.0] 之间

Returns

void

Implementation of

AbstractBaseRenderer.setLowFreqVolume

---

setRenderScale()

setRenderScale(scale): void

Defined in: packages/core/src/bg-render/index.ts:33

修改背景的渲染比例，默认是 0.5

一般情况下这个程度既没有明显瑕疵也不会特别吃性能

Parameters

Parameter	Type	Description
scale	number	背景的渲染比例

Returns

void

Implementation of

AbstractBaseRenderer.setRenderScale

---

setStaticMode()

setStaticMode(enable): void

Defined in: packages/core/src/bg-render/index.ts:40

是否启用静态模式，即图片在更换后就会保持静止状态并禁用更新，以节省性能

Parameters

Parameter	Type	Description
enable	boolean	是否启用静态模式

Returns

void

Implementation of

AbstractBaseRenderer.setStaticMode

---

new()

static new<Renderer>(type): BackgroundRender<Renderer>

Defined in: packages/core/src/bg-render/index.ts:26

Type Parameters

Type Parameter
Renderer extends BaseRenderer

Parameters

Parameter	Type
type	(canvas) => Renderer

Returns

BackgroundRender<Renderer>