Skip to content

API 概览 ​

运行时的 API 写在 SDK 的类型声明 types/desktop-engine.d.ts 里,只包含运行时真正注入的 API。完整的 API 参考由它生成,是英文的。desktopengine create 会把同一份声明复制到项目的 types/ 下,编辑器据此补全和检查类型。怎样使用这些 API,见指南。

全局的 DesktopEngine ​

DesktopEngine 是运行时的入口:

成员说明
launchOptions启动参数:显示器、位置、选项取值、语言、权限,见启动参数
apiVersion运行时的 API 版本,见 API 版本
preferredFramesPerSecond内容想要的帧率,见帧率
Window原生窗口,内容的根,见窗口
Canvas画布组件:2D、WebGL 和 WebGL 2
CanvasImage画到画布上的图片
Component、Image、Video窗口里的其他组件,样式见 ComponentStyle
system系统外观、CPU 和内存用量
ScreenManager显示器
fs包内文件和内容自己的文件,见存储和文件

所有类型都在 DesktopEngine 命名空间里。

Web 标准 API ​

运行时还提供这些全局对象,行为与浏览器一致,差别写在各自的说明里:

完整的列表见全部声明。

SDK 以 Apache License 2.0 发布