BaseRenderer

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

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

以免产生泄露

Extends

AbstractBaseRenderer

Extended by

Constructors

new BaseRenderer()

new BaseRenderer(canvas): BaseRenderer

Parameters

• canvas: HTMLCanvasElement

Methods

dispose()

dispose(): void

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

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

Returns

void

Overrides

AbstractBaseRenderer.dispose

Defined in

packages/core/src/bg-render/base.ts:145

getElement()

getElement(): HTMLElement

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

Returns

HTMLElement

Overrides

AbstractBaseRenderer.getElement

Defined in

packages/core/src/bg-render/base.ts:149

pause()

abstract pause(): void

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

Returns

void

Overrides

AbstractBaseRenderer.pause

Defined in

packages/core/src/bg-render/base.ts:132

resume()

abstract resume(): void

恢复播放背景动画

Returns

void

Overrides

AbstractBaseRenderer.resume

Defined in

packages/core/src/bg-render/base.ts:136

setAlbum()

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

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

Parameters

• albumSource: string | HTMLImageElement | HTMLVideoElement

专辑的资源链接，可以是图片或视频链接，抑或是任意 img/video 元素，如果提供字符串链接且为视频则需要指定第二个参数

• isVideo?: boolean

Returns

Promise<void>

Overrides

AbstractBaseRenderer.setAlbum

Defined in

packages/core/src/bg-render/base.ts:141

setFlowSpeed()

setFlowSpeed(speed): void

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

Parameters

• speed: number

背景的流动速度，默认为 4

Returns

void

Overrides

AbstractBaseRenderer.setFlowSpeed

Defined in

packages/core/src/bg-render/base.ts:114

setFPS()

abstract setFPS(fps): void

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

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

Parameters

• fps: number

目标帧率，默认 30 FPS

Returns

void

Overrides

AbstractBaseRenderer.setFPS

Defined in

packages/core/src/bg-render/base.ts:128

setHasLyric()

abstract setHasLyric(hasLyric): void

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

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

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

Parameters

• hasLyric: boolean

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

Returns

void

Inherited from

AbstractBaseRenderer.setHasLyric

Defined in

packages/core/src/bg-render/base.ts:62

setLowFreqVolume()

abstract setLowFreqVolume(volume): void

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

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

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

Parameters

• volume: number

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

Returns

void

Inherited from

AbstractBaseRenderer.setLowFreqVolume

Defined in

packages/core/src/bg-render/base.ts:52

setRenderScale()

setRenderScale(scale): void

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

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

Parameters

• scale: number

背景的渲染比例

Returns

void

Overrides

AbstractBaseRenderer.setRenderScale

Defined in

packages/core/src/bg-render/base.ts:88

setStaticMode()

abstract setStaticMode(enable): void

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

Parameters

• enable: boolean

是否启用静态模式

Returns

void

Overrides

AbstractBaseRenderer.setStaticMode

Defined in

packages/core/src/bg-render/base.ts:121