Skip to content

接口: RenderOptions

定义于: packages/draw/src/draw.ts:72

各出图方法共用的渲染选项(末位参数;均可省略)。

字段默认说明
scale2相对 1920×1080 的像素倍率(2 → 3840×2160)
fontsassets 默认字体自定义 satori 字体表
footerLeft不绘制画布左下页脚
footerRight不绘制画布右下页脚;左右都不传则无页脚
assetFallback"error"AssetFallback:封面/头像失败时抛错或占位图

示例

ts
await draw.poster(profile, bests, {
  scale: 1,
  footerLeft: "my-bot",
  footerRight: "mai-kit",
  assetFallback: "placeholder",
});
await draw.best15({ name: profile.name, rating: profile.rating }, bests, {
  scale: 1,
  footerLeft: "my-bot",
});

属性

属性类型默认值描述定义于
assetFallback?AssetFallback"error"从 database / 本地路径加载封面、头像失败时的策略(AssetFallback)。 - "error"(默认):抛 DrawError - "placeholder":用内置占位图继续渲染packages/draw/src/draw.ts:98
fonts?FontOptions[]undefined自定义 satori 字体表;不传则使用 @mai-kit/assets 默认字体(Noto Sans SC + Comfortaa)。packages/draw/src/draw.ts:81
footerLeft?stringundefined页脚左侧文案(画布左下)。 与 footerRight 都不传时不绘制页脚栏。packages/draw/src/draw.ts:86
footerRight?stringundefined页脚右侧文案(画布右下)。 与 footerLeft 都不传时不绘制页脚栏。packages/draw/src/draw.ts:91
scale?number2 → 3840×2160输出像素相对逻辑画布(1920×1080)的缩放倍数。packages/draw/src/draw.ts:77