@applemusic-like-lyrics/core / Exports / PixiRenderer
实现了这个接口的东西需要在使用完毕后
手动调用 dispose 函数来销毁清除占用资源
以免产生泄露
-
↳
PixiRenderer
- dispose
- getElement
- onResize
- onTick
- pause
- rebuildFilters
- resume
- setAlbumImage
- setFPS
- setFlowSpeed
- setRenderScale
- setStaticMode
• new PixiRenderer(canvas)
| Name | Type |
|---|---|
canvas |
HTMLCanvasElement |
packages/core/src/bg-render/pixi-renderer.ts:86
• Private app: Application<ICanvas>
packages/core/src/bg-render/pixi-renderer.ts:15
• Protected canvas: HTMLCanvasElement
packages/core/src/bg-render/pixi-renderer.ts:86
• Private Optional curContainer: TimedContainer
packages/core/src/bg-render/pixi-renderer.ts:16
• Protected currerntRenderScale: number = 0.75
BaseRenderer.currerntRenderScale
packages/core/src/bg-render/base.ts:48
• Protected flowSpeed: number = 2
packages/core/src/bg-render/base.ts:47
• Private lastContainer: Set<TimedContainer>
packages/core/src/bg-render/pixi-renderer.ts:18
• Private staticMode: boolean = false
packages/core/src/bg-render/pixi-renderer.ts:17
▸ dispose(): void
销毁实现了该接口的对象实例，释放占用的资源
一般情况下，调用本函数后就不可以再调用对象的任何函数了
void
packages/core/src/bg-render/pixi-renderer.ts:233
▸ getElement(): HTMLElement
获取这个类所对应的 HTML 元素实例
HTMLElement
packages/core/src/bg-render/pixi-renderer.ts:239
▸ Protected onResize(width, height): void
当画板元素大小发生变化时此函数会被调用 可以在此处重设和渲染器相关的尺寸设置 考虑到初始化的时候元素不一定在文档中或出于某些特殊样式状态，尺寸长宽有可能会为 0，请注意进行特判处理
| Name | Type | Description |
|---|---|---|
width |
number |
画板元素实际的物理像素宽度，有可能为 0 |
height |
number |
画板元素实际的物理像素高度，有可能为 0 |
void
packages/core/src/bg-render/pixi-renderer.ts:100
▸ Private onTick(delta): void
| Name | Type |
|---|---|
delta |
number |
void
packages/core/src/bg-render/pixi-renderer.ts:19
▸ pause(): void
暂停背景动画，画面即便是更新了图片也不会发生变化
void
packages/core/src/bg-render/pixi-renderer.ts:176
▸ Private rebuildFilters(): void
void
packages/core/src/bg-render/pixi-renderer.ts:110
▸ resume(): void
恢复播放背景动画
void
packages/core/src/bg-render/pixi-renderer.ts:181
▸ setAlbumImage(albumUrl): Promise<void>
设置背景专辑图片，图片材质加载并设置完成后会返回
| Name | Type | Description |
|---|---|---|
albumUrl |
string |
图片的目标链接 |
Promise<void>
packages/core/src/bg-render/pixi-renderer.ts:185
▸ setFPS(fps): void
修改背景动画帧率，默认是 30 FPS
如果设置成 0 则会停止动画
| Name | Type | Description |
|---|---|---|
fps |
number |
目标帧率，默认 30 FPS |
void
packages/core/src/bg-render/pixi-renderer.ts:172
▸ setFlowSpeed(speed): void
修改背景的流动速度，数字越大越快，默认为 2
| Name | Type | Description |
|---|---|---|
speed |
number |
背景的流动速度，默认为 2 |
void
packages/core/src/bg-render/base.ts:82
▸ setRenderScale(scale): void
修改背景的渲染比例，默认是 0.5
一般情况下这个程度既没有明显瑕疵也不会特别吃性能
| Name | Type | Description |
|---|---|---|
scale |
number |
背景的渲染比例 |
void
packages/core/src/bg-render/pixi-renderer.ts:106
▸ setStaticMode(enable?): void
是否启用静态模式，即图片在更换后就会保持静止状态并禁用更新，以节省性能
| Name | Type | Default value | Description |
|---|---|---|---|
enable |
boolean |
false |
是否启用静态模式 |
void