galacean · GuoLei1990 · Dec 12, 2023 · Aug 11, 2023 · Aug 21, 2023 · Aug 21, 2023
diff --git a/package.json b/package.json
@@ -52,7 +52,8 @@
     "rollup-plugin-serve": "^1.1.0",
     "rollup-plugin-swc3": "^0.10.1",
     "ts-node": "^10",
-    "typescript": "^5.1.6"
+    "typescript": "^5.1.6",
+    "@types/webxr": "latest"
   },
   "husky": {
     "hooks": {

diff --git a/packages/core/src/Camera.ts b/packages/core/src/Camera.ts
@@ -19,6 +19,7 @@ import { ShaderTagKey } from "./shader/ShaderTagKey";
 import { ShaderDataGroup } from "./shader/enums/ShaderDataGroup";
 import { RenderTarget } from "./texture/RenderTarget";
 import { TextureCubeFace } from "./texture/enums/TextureCubeFace";
+import { CameraType } from "./enums/CameraType";
 
 class MathTemp {
   static tempVec4 = new Vector4();
@@ -62,6 +63,8 @@ export class Camera extends Component {
    */
   depthTextureMode: DepthTextureMode = DepthTextureMode.None;
 
+  /** @internal */
+  _cameraType: CameraType = CameraType.Normal;
   /** @internal */
   _globalShaderMacro: ShaderMacroCollection = new ShaderMacroCollection();
   /** @internal */
@@ -524,7 +527,11 @@ export class Camera extends Component {
       mipLevel = 0;
       Logger.error("mipLevel only take effect in WebGL2.0");
     }
-    this._renderPipeline.render(context, cubeFace, mipLevel);
+    let clearMask: CameraClearFlags;
+    if (this._cameraType !== CameraType.Normal) {
+      clearMask = this.engine.xrManager._getCameraClearFlagsMask(this._cameraType);
+    }
+    this._renderPipeline.render(context, cubeFace, mipLevel, clearMask);
     this._engine._renderCount++;
   }
 

diff --git a/packages/core/src/Engine.ts b/packages/core/src/Engine.ts
@@ -1,4 +1,4 @@
-import { IPhysics, IPhysicsManager, IShaderLab } from "@galacean/engine-design";
+import { IHardwareRenderer, IPhysics, IPhysicsManager, IShaderLab, IXRDevice } from "@galacean/engine-design";
 import { Color } from "@galacean/engine-math/src/Color";
 import { SpriteMaskInteraction } from "./2d";
 import { Font } from "./2d/text/Font";
@@ -26,7 +26,6 @@ import { Material } from "./material/Material";
 import { ParticleBufferUtils } from "./particle/ParticleBufferUtils";
 import { PhysicsScene } from "./physics/PhysicsScene";
 import { ColliderShape } from "./physics/shape/ColliderShape";
-import { IHardwareRenderer } from "./renderingHardwareInterface";
 import { CompareFunction } from "./shader";
 import { Shader } from "./shader/Shader";
 import { ShaderMacro } from "./shader/ShaderMacro";
@@ -41,6 +40,7 @@ import { CullMode } from "./shader/enums/CullMode";
 import { RenderQueueType } from "./shader/enums/RenderQueueType";
 import { RenderState } from "./shader/state/RenderState";
 import { Texture2D, Texture2DArray, TextureCube, TextureCubeFace, TextureFormat } from "./texture";
+import { XRManager } from "./xr/XRManager";
 
 ShaderPool.init();
 
@@ -57,6 +57,8 @@ export class Engine extends EventDispatcher {
 
   /** Input manager of Engine. */
   readonly inputManager: InputManager;
+  /** XR manager of Engine. */
+  readonly xrManager: XRManager;
 
   /** @internal */
   _particleBufferUtils: ParticleBufferUtils;
@@ -143,7 +145,8 @@ export class Engine extends EventDispatcher {
 
   private _animate = () => {
     if (this._vSyncCount) {
-      this._requestId = requestAnimationFrame(this._animate);
+      const raf = this.xrManager?._getRequestAnimationFrame() || requestAnimationFrame;
+      this._requestId = raf(this._animate);
       if (this._vSyncCounter++ % this._vSyncCount === 0) {
         this.update();
         this._vSyncCounter = 1;
@@ -255,6 +258,12 @@ export class Engine extends EventDispatcher {
 
     this.inputManager = new InputManager(this);
 
+    const { xrDevice } = configuration;
+    if (xrDevice) {
+      this.xrManager = new XRManager();
+      this.xrManager._initialize(this, xrDevice);
+    }
+
     this._initMagentaTextures(hardwareRenderer);
 
     if (!hardwareRenderer.canIUse(GLCapabilityType.depthTexture)) {
@@ -297,7 +306,8 @@ export class Engine extends EventDispatcher {
    */
   pause(): void {
     this._isPaused = true;
-    cancelAnimationFrame(this._requestId);
+    const caf = this.xrManager?._getCancelAnimationFrame() || cancelAnimationFrame;
+    caf(this._requestId);
     clearTimeout(this._timeoutId);
   }
 
@@ -308,7 +318,12 @@ export class Engine extends EventDispatcher {
     if (!this._isPaused) return;
     this._isPaused = false;
     this.time._reset();
-    this._requestId = requestAnimationFrame(this._animate);
+    if (this._vSyncCount) {
+      const raf = this.xrManager?._getRequestAnimationFrame() || requestAnimationFrame;
+      this._requestId = raf(this._animate);
+    } else {
+      this._timeoutId = window.setTimeout(this._animate, this._targetFrameInterval);
+    }
   }
 
   /**
@@ -327,6 +342,7 @@ export class Engine extends EventDispatcher {
     this._spriteMaskRenderDataPool.resetPool();
     this._textRenderDataPool.resetPool();
 
+    this.xrManager?._update();
     const { inputManager, _physicsInitialized: physicsInitialized } = this;
     inputManager._update();
 
@@ -430,6 +446,7 @@ export class Engine extends EventDispatcher {
     this._fontMap = null;
 
     this.inputManager._destroy();
+    this.xrManager?._destroy();
     this.dispatch("shutdown", this);
 
     // Cancel animation
@@ -729,6 +746,8 @@ export class Engine extends EventDispatcher {
 export interface EngineConfiguration {
   /** Physics. */
   physics?: IPhysics;
+  /** XR Device. */
+  xrDevice?: IXRDevice;
   /** Color space. */
   colorSpace?: ColorSpace;
   /** Shader lab */

diff --git a/packages/core/src/RenderPipeline/BasicRenderPipeline.ts b/packages/core/src/RenderPipeline/BasicRenderPipeline.ts
@@ -134,8 +134,9 @@ export class BasicRenderPipeline {
    * @param context - Render context
    * @param cubeFace - Render surface of cube texture
    * @param mipLevel - Set mip level the data want to write
+   * @param ignoreClear - Ignore clear flag
    */
-  render(context: RenderContext, cubeFace?: TextureCubeFace, mipLevel?: number) {
+  render(context: RenderContext, cubeFace?: TextureCubeFace, mipLevel?: number, ignoreClear?: CameraClearFlags) {
     const camera = this._camera;
     const scene = camera.scene;
     const cullingResults = this._cullingResults;
@@ -163,7 +164,7 @@ export class BasicRenderPipeline {
     }
 
     for (let i = 0, len = this._renderPassArr
10000
ay.length; i < len; i++) {
-      this._drawRenderPass(context, this._renderPassArray[i], camera, cubeFace, mipLevel);
+      this._drawRenderPass(context, this._renderPassArray[i], camera, cubeFace, mipLevel, ignoreClear);
     }
   }
 
@@ -172,7 +173,8 @@ export class BasicRenderPipeline {
     pass: RenderPass,
     camera: Camera,
     cubeFace?: TextureCubeFace,
-    mipLevel?: number
+    mipLevel?: number,
+    ignoreClear?: CameraClearFlags
   ) {
     const cullingResults = this._cullingResults;
     const { opaqueQueue, alphaTestQueue, transparentQueue } = cullingResults;
@@ -185,7 +187,7 @@ export class BasicRenderPipeline {
       const renderTarget = camera.renderTarget || pass.renderTarget;
       rhi.activeRenderTarget(renderTarget, camera.viewport, mipLevel);
       renderTarget?._setRenderTargetInfo(cubeFace, mipLevel);
-      const clearFlags = pass.clearFlags ?? camera.clearFlags;
+      const clearFlags = (pass.clearFlags ?? camera.clearFlags) & ~(ignoreClear ?? CameraClearFlags.None);
       const color = pass.clearColor ?? background.solidColor;
       if (clearFlags !== CameraClearFlags.None) {
         rhi.clearRenderTarget(camera.engine, clearFlags, color);
@@ -196,7 +198,7 @@ export class BasicRenderPipeline {
       } else {
         opaqueQueue.render(camera, pass.mask, PipelineStage.Forward);
         alphaTestQueue.render(camera, pass.mask, PipelineStage.Forward);
-        if (camera.clearFlags & CameraClearFlags.Color) {
+        if (clearFlags & CameraClearFlags.Color) {
           if (background.mode === BackgroundMode.Sky) {
             background.sky._render(context);
           } else if (background.mode === BackgroundMode.Texture && background.texture) {

diff --git a/packages/core/src/enums/CameraType.ts b/packages/core/src/enums/CameraType.ts
@@ -0,0 +1,9 @@
+/**
+ * @internal
+ */
+export enum CameraType {
+  Normal = 0x0,
+  XRCenterCamera = 0x1,
+  XRLeftCamera = 0x2,
+  XRRightCamera = 0x4
+}
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -34,8 +34,10 @@ export { BackgroundMode } from "./enums/BackgroundMode";
 export { DepthTextureMode } from "./enums/DepthTextureMode";
 export { FogMode } from "./enums/FogMode";
 export { CameraClearFlags } from "./enums/CameraClearFlags";
+export { CameraType } from "./enums/CameraType";
 export { ColorSpace } from "./enums/ColorSpace";
 export { BackgroundTextureFillMode } from "./enums/BackgroundTextureFillMode";
+export { XRManager } from "./xr/XRManager";
 export * from "./input/index";
 export * from "./lighting/index";
 export * from "./shadow/index";

diff --git a/packages/core/src/renderingHardwareInterface/index.ts b/packages/core/src/renderingHardwareInterface/index.ts
@@ -1,4 +1,3 @@
-export type { IHardwareRenderer } from "./IHardwareRenderer";
 export type { IPlatformBuffer } from "./IPlatformBuffer";
 export type { IPlatformRenderTarget } from "./IPlatformRenderTarget";
 export type { IPlatformTexture } from "./IPlatformTexture";

diff --git a/packages/core/src/shader/ShaderProgram.ts b/packages/core/src/shader/ShaderProgram.ts
@@ -1,10 +1,10 @@
+import { IHardwareRenderer } from "@galacean/engine-design";
 import { Vector2, Vector3, Vector4 } from "@galacean/engine-math";
 import { Logger } from "../base/Logger";
 import { Camera } from "../Camera";
 import { Engine } from "../Engine";
 import { Material } from "../material/Material";
 import { Renderer } from "../Renderer";
-import { IHardwareRenderer } from "../renderingHardwareInterface/IHardwareRenderer";
 import { Scene } from "../Scene";
 import { Texture } from "../texture";
 import { ShaderDataGroup } from "./enums/ShaderDataGroup";

diff --git a/packages/core/src/shader/ShaderUniform.ts b/packages/core/src/shader/ShaderUniform.ts
@@ -1,7 +1,7 @@
+import { IHardwareRenderer } from "@galacean/engine-design";
 import { Color, Matrix, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
 import { Engine } from "../Engine";
 import { ColorSpace } from "../enums/ColorSpace";
-import { IHardwareRenderer } from "../renderingHardwareInterface/IHardwareRenderer";
 import { Texture } from "../texture/Texture";
 import { ShaderPropertyValueType } from "./ShaderData";
 

diff --git a/packages/core/src/shader/state/BlendState.ts b/packages/core/src/shader/state/BlendState.ts
@@ -1,7 +1,7 @@
+import { IHardwareRenderer } from "@galacean/engine-design";
 import { Color } from "@galacean/engine-math";
 import { GLCapabilityType } from "../../base/Constant";
 import { deepClone } from "../../clone/CloneManager";
-import { IHardwareRenderer } from "../../renderingHardwareInterface/IHardwareRenderer";
 import { ShaderData } from "../ShaderData";
 import { ShaderProperty } from "../ShaderProperty";
 import { BlendFactor } from "../enums/BlendFactor";

diff --git a/packages/core/src/shader/state/DepthState.ts b/packages/core/src/shader/state/DepthState.ts
@@ -1,4 +1,4 @@
-import { IHardwareRenderer } from "../../renderingHardwareInterface/IHardwareRenderer";
+import { IHardwareRenderer } from "@galacean/engine-design";
 import { ShaderData } from "../ShaderData";
 import { ShaderProperty } from "../ShaderProperty";
 import { CompareFunction } from "../enums/CompareFunction";

diff --git a/packages/core/src/shader/state/RasterState.ts b/packages/core/src/shader/state/RasterState.ts
@@ -1,4 +1,4 @@
-import { IHardwareRenderer } from "../../renderingHardwareInterface/IHardwareRenderer";
+import { IHardwareRenderer } from "@galacean/engine-design";
 import { ShaderData } from "../ShaderData";
 import { ShaderProperty } from "../ShaderProperty";
 import { CullMode } from "../enums/CullMode";

diff --git a/packages/core/src/shader/state/StencilState.ts b/packages/core/src/shader/state/StencilState.ts
@@ -1,4 +1,4 @@
-import { IHardwareRenderer } from "../../renderingHardwareInterface/IHardwareRenderer";
+import { IHardwareRenderer } from "@galacean/engine-design";
 import { ShaderData } from "../ShaderData";
 import { ShaderProperty } from "../ShaderProperty";
 import { CompareFunction } from "../enums/CompareFunction";

diff --git a/packages/core/src/xr/XRManager.ts b/packages/core/src/xr/XRManager.ts
@@ -0,0 +1,44 @@
+import { IXRDevice } from "@galacean/engine-design";
+import { Engine } from "../Engine";
+import { CameraClearFlags } from "../enums/CameraClearFlags";
+import { CameraType } from "../enums/CameraType";
+
+/**
+ * XRManager located in the main package, its implementation logic is XRManagerExtended in the sub-package engine-xr.
+ */
+export class XRManager {
+  /**
+   * @internal
+   */
+  _initialize(engine: Engine, xrDevice: IXRDevice): void {}
+
+  /**
+   * @internal
+   */
+  _update(): void {}
+
+  /**
+   * @internal
+   */
+  _destroy(): void {}
+
+  /**
+   * @internal
+   */
+  _getRequestAnimationFrame(): (callback: FrameRequestCallback) => number {
+    return null;
+  }
+
+  /**
+   * @internal
+   */
+  _getCancelAnimationFrame(): (id: number) => void {
+    return null;
+  }
+  /**
+   * @internal
+   */
+  _getCameraClearFlagsMask(type: CameraType): CameraClearFlags {
+    return CameraClearFlags.None;
+  }
+}
diff --git a/packages/design/src/index.ts b/packages/design/src/index.ts
@@ -2,3 +2,4 @@ export type { IClone } from "./IClone";
 export * from "./physics/index";
 export * from "./renderingHardwareInterface/index";
 export * from "./shader-lab/index";
+export * from "./xr/index";
diff --git a/...ingHardwareInterface/IHardwareRenderer.ts → ...ingHardwareInterface/IHardwareRenderer.ts b/...ingHardwareInterface/IHardwareRenderer.ts → ...ingHardwareInterface/IHardwareRenderer.ts
diff --git a/packages/design/src/renderingHardwareInterface/index.ts b/packages/design/src/renderingHardwareInterface/index.ts
@@ -1 +1,2 @@
+export type { IHardwareRenderer } from "./IHardwareRenderer";
 export type { IPlatformPrimitive } from "./IPlatformPrimitive";
diff --git a/packages/design/src/xr/IXRDevice.ts b/packages/design/src/xr/IXRDevice.ts
@@ -0,0 +1,35 @@
+import { IHardwareRenderer } from "../renderingHardwareInterface";
+import { IXRSession } from "./IXRSession";
+import { IXRPlatformFeature } from "./feature/IXRPlatformFeature";
+
+/**
+ * The interface of XR device.
+ */
+export interface IXRDevice {
+  /**
+   * Check if the specified session mode is supported.
+   * @param mode - The mode of the session.
+   */
+  isSupportedSessionMode(mode: number): Promise<void>;
+
+  /**
+   * Check if the specified feature is supported.
+   * @param mode - The type of the feature.
+   */
+  isSupportedFeature(type: number): boolean;
+
+  /**
+   * Get the platform feature instance of this device
+   * @param engine - The engine.
+   * @param type - The type of the feature.
+   */
+  createPlatformFeature(type: number, ...args: any[]): IXRPlatformFeature;
+
+  /**
+   * Request a session.
+   * @param engine - The engine
+   * @param mode - The mode of the session
+   * @param platformFeatures - The requested platform features
+   */
+  requestSession(rhi: IHardwareRenderer, mode: number, platformFeatures: IXRPlatformFeature[]): Promise<IXRSession>;
+}
diff --git a/packages/design/src/xr/IXRFrame.ts b/packages/design/src/xr/IXRFrame.ts
@@ -0,0 +1,14 @@
+import { IXRInput } from "./input/IXRInput";
+
+/**
+ * The base interface of XR frame.
+ * It can be understood as a snapshot of
+ * the information of each input in this frame.
+ */
+export interface IXRFrame {
+  /**
+   * Update xr input information.
+   * @param inputs - xr input
+   */
+  updateInputs(inputs: IXRInput[]): void;
+}
diff --git a/packages/design/src/xr/IXRInputEvent.ts b/packages/design/src/xr/IXRInputEvent.ts
@@ -0,0 +1,17 @@
+/**
+ * Unified XR input events.
+ */
+export interface IXRInputEvent {
+  /** Interaction type. */
+  targetRayMode: number;
+  /** Specific interactions. */
+  type: number;
+  /** Type of interactive input. */
+  input: number;
+  /** Touch id. (Meaningful when and only when targetRayMode is screen) */
+  id?: number;
+  /** X coordinate on screen. (Meaningful when and only when targetRayMode is screen) */
+  x?: number;
+  /** Y coordinate on screen. (Meaningful when and only when targetRayMode is screen) */
+  y?: number;
+}
Original file line number	Diff line number	Diff line change
		@@ -1 +1,2 @@
		export type { IHardwareRenderer } from "./IHardwareRenderer";
		export type { IPlatformPrimitive } from "./IPlatformPrimitive";