Orillusion

Appearance

本页内容

Engine3D ​

Engine3D 是引擎核心唯一的全局实例，主要有以下几个常用方法：

  1. 调用 Engine3D.init() 来初始化引擎
  2. 调用 Engine3D.startRender() 开启渲染循环
  3. Engine3D.res 加载网络贴图或模型资源，详见 资源加载
  4. Engine3D.inputSystem 统一管理用户的输入事件，详见 交互
  5. Engine3D.setting 统一配置渲染相关功能，详见 配置

初始化 ​

通过 Engine3D.init() 方法来初始化引擎，默认参数可以为空。

引擎内部的初始化需要请求 GPU 设备，初始化请求 GPU 设备是异步过程，因此需要用异步的方式调用，我们推荐使用 async/await 字段进行调用。

ts
Engine3D.init().then(()=>{
    // ...
})
// or
async function run(){
    await Engine3D.init();
    // ...
}
run()

渲染循环回调 ​

在初始化时，通过传入参数，可以获取渲染主循环的回调，并在回调中执行自定义逻辑。

ts
await Engine3D.init({
    beforeRender: ()=>{
        // 每一帧渲染前回调
    },
    renderLoop: ()=>{
        // 每一帧回调
    },
    lateRender: ()=>{
        // 每一帧渲染后回调
    }
});

配置 Canvas ​

除了配置渲染回调，在初始化时还可以指定渲染的 canvas ，如果没有指定，则默认创建一个新的覆盖整个窗口的 canvas。

ts
await Engine3D.init({
    canvasConfig:{
        canvas: document.getElementById("webGpuCanvas"),
        alpha: false,
        zIndex: 1
    }
});

启动渲染任务 ​

在引擎初始化完成之后，需要启动渲染任务来开始渲染。渲染任务至少需要一个场景 Scene3D 和一个渲染器 ForwardRenderJob 才能启动，基本用法如下：

ts
await Engine3D.init();
// 创建场景
this.scene = new Scene3D();
// 创建一个前向渲染器
let renderJob = new ForwardRenderJob(this.scene);
// 开始渲染任务
Engine3D.startRender(renderJob);

// 暂停渲染循环
Engine3D.renderJob.pause();
// 恢复渲染循环
Engine3D.renderJob.resume();

详细用法请参考 Engine3D API