IsolationRenderer

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

Fileoverview

一个播放歌词的组件

Author

SteveXMH

Extends

BaseRenderer

Constructors

Constructor

new IsolationRenderer(canvas): IsolationRenderer;

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

Parameters

Parameter	Type
`canvas`	`HTMLCanvasElement`

Returns

IsolationRenderer

Overrides

BaseRenderer.constructor

Properties

Property	Modifier	Type	Default value	Description	Inherited from	Defined in
`canvas`	`protected`	`HTMLCanvasElement`	`undefined`	-	`BaseRenderer`.`canvas`	packages/core/src/bg-render/base.ts:75
`currerntRenderScale`	`protected`	`number`	`0.75`	-	`BaseRenderer`.`currerntRenderScale`	packages/core/src/bg-render/base.ts:74
`flowSpeed`	`protected`	`number`	`1`	-	`BaseRenderer`.`flowSpeed`	packages/core/src/bg-render/base.ts:73
`defaultOptions`	`readonly`	`Readonly`<`IsolationRendererOptions`>	`undefined`	新建实例时采用的默认选项。该对象也可作为配置界面的初始值；实例创建后的调整统一走 setOptions。	-	packages/core/src/bg-render/isolation/index.ts:79

Methods

disconnectResizeObserver()

protected disconnectResizeObserver(): void;

Defined in: packages/core/src/bg-render/base.ts:148

停止监听画板尺寸，供构造失败等尚未接管画板所有权的路径清理

Returns

void

Inherited from

BaseRenderer.disconnectResizeObserver

dispose()

dispose(): void;

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

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

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

Returns

void

Overrides

BaseRenderer.dispose

getElement()

getElement(): HTMLElement;

Defined in: packages/core/src/bg-render/base.ts:155

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

Returns

HTMLElement

Inherited from

BaseRenderer.getElement

onResize()

protected onResize(width, height): void;

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

当画板元素大小发生变化时此函数会被调用可以在此处重设和渲染器相关的尺寸设置考虑到初始化的时候元素不一定在文档中或出于某些特殊样式状态，尺寸长宽有可能会为 0，请注意进行特判处理

Parameters

Parameter	Type	Description
`width`	`number`	画板元素实际的物理像素宽度，有可能为 0
`height`	`number`	画板元素实际的物理像素高度，有可能为 0

Returns

void

Overrides

BaseRenderer.onResize

pause()

pause(): void;

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

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

Returns

void

Overrides

BaseRenderer.pause

resume()

resume(): void;

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

恢复播放背景动画

Returns

void

Overrides

BaseRenderer.resume

setAlbum()

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

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

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

Parameters

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