@galacean/engine-core 1.2.0-alpha.0 → 1.2.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "1.2.0-alpha.0",
+  "version": "1.2.0-alpha.1",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,10 +15,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "1.2.0-alpha.0"
+    "@galacean/engine-math": "1.2.0-alpha.1"
   },
   "devDependencies": {
-    "@galacean/engine-design": "1.2.0-alpha.0"
+    "@galacean/engine-design": "1.2.0-alpha.1"
   },
   "scripts": {
     "b:types": "tsc"

package/types/2d/atlas/types.d.ts

@@ -64,4 +64,6 @@ export interface AtlasSprite {
         w: number;
     };
     pixelsPerUnit: number;
+    width: number;
+    height: number;
 }

package/types/2d/text/TextRenderer.d.ts

@@ -108,4 +108,5 @@ export declare class TextRenderer extends Renderer {
     private _resetSubFont;
     private _updatePosition;
     private _updateLocalData;
+    private _isTextNoVisible;
 }

package/types/SystemInfo.d.ts

@@ -7,6 +7,8 @@ export declare class SystemInfo {
     static platform: Platform;
     /** The operating system is running on. */
     static operatingSystem: string;
+    /** Whether the system support SIMD. */
+    private static _simdSupported;
     /**
      * The pixel ratio of the device.
      */

package/types/mesh/PrimitiveMesh.d.ts

@@ -6,6 +6,10 @@ import { ModelMesh } from "./ModelMesh";
  */
 export declare class PrimitiveMesh {
     private static _tempVec30;
+    private static readonly _sphereSeedPositions;
+    private static readonly _sphereSeedCells;
+    private static _sphereEdgeIdx;
+    private static _spherePoleIdx;
     /**
      * Create a sphere mesh.
      * @param engine - Engine
@@ -15,6 +19,16 @@ export declare class PrimitiveMesh {
      * @returns Sphere model mesh
      */
     static createSphere(engine: Engine, radius?: number, segments?: number, noLongerAccessible?: boolean): ModelMesh;
+    /**
+     * Create a sphere mesh by implementing Catmull-Clark Surface Subdivision Algorithm.
+     * Max step is limited to 6.
+     * @param engine - Engine
+     * @param radius - Sphere radius
+     * @param step - Number of subdiv steps
+     * @param noLongerAccessible - No longer access the vertices of the mesh after creation
+     * @returns Sphere model mesh
+     */
+    static createSubdivisionSurfaceSphere(engine: Engine, radius?: number, step?: number, noLongerAccessible?: boolean): ModelMesh;
     /**
      * Create a cuboid mesh.
      * @param engine - Engine
@@ -82,6 +96,14 @@ export declare class PrimitiveMesh {
      * @returns Capsule model mesh
      */
     static createCapsule(engine: Engine, radius?: number, height?: number, radialSegments?: number, heightSegments?: number, noLongerAccessible?: boolean): ModelMesh;
+    /**
+     * Duplicate vertices at the poles and adjust their UV coordinates.
+     */
+    private static _generateAndReplacePoleUV;
+    /**
+     * Get edge point index for subdivision surface sphere.
+     */
+    private static _calculateEdgeIndex;
     static _setCylinderData(cylinderMesh: ModelMesh, radiusTop: number, radiusBottom: number, height: number, radialSegments: number, heightSegments: number, noLongerAccessible: boolean, isRestoreMode: boolean, restoreVertexBuffer?: Buffer): void;
     static _setCapsuleData(capsuleMesh: ModelMesh, radius: number, height: number, radialSegments: number, heightSegments: number, noLongerAccessible: boolean, isRestoreMode: boolean, restoreVertexBuffer?: Buffer): void;
     private static _initialize;

package/types/xr/XRPose.d.ts

@@ -0,0 +1,15 @@
+import { IXRPose } from "@galacean/engine-design";
+import { Matrix, Quaternion, Vector3 } from "@galacean/engine-math";
+/**
+ * Data for describing pose in the XR space.
+ */
+export declare class XRPose implements IXRPose {
+    /** The position of the pose in XR space. */
+    position: Vector3;
+    /** The rotation of the pose in XR space. */
+    rotation: Quaternion;
+    /** The matrix of the pose in XR space. */
+    matrix: Matrix;
+    /** The inverse matrix of the pose in XR space. */
+    inverseMatrix: Matrix;
+}

package/types/xr/feature/XRFeature.d.ts

@@ -0,0 +1,16 @@
+import { IXRPlatformFeature } from "@galacean/engine-design";
+import { XRManager } from "../XRManager";
+import { XRFeatureType } from "./XRFeatureType";
+/**
+ * The base class of XR feature manager.
+ */
+export declare abstract class XRFeature<T extends IXRPlatformFeature = IXRPlatformFeature> {
+    protected _xrManager: XRManager;
+    protected _type: XRFeatureType;
+    protected _enabled: boolean;
+    /**
+     * Returns whether the feature is enabled.
+     */
+    get enabled(): boolean;
+    set enabled(value: boolean);
+}

package/types/xr/feature/XRFeatureManager.d.ts

@@ -0,0 +1,65 @@
+import { IXRFeatureDescriptor, IXRFeatureManager, IXRFeature, IXRSession, IXRFrame } from "@galacean/engine-design";
+import { Engine } from "../../Engine";
+/**
+ * The base class of XR feature manager.
+ */
+export declare abstract class XRFeatureManager<TDescriptor extends IXRFeatureDescriptor = IXRFeatureDescriptor, TFeature extends IXRFeature = IXRFeature> implements IXRFeatureManager {
+    protected _engine: Engine;
+    _platformFeature: TFeature;
+    protected _descriptor: TDescriptor;
+    protected _enabled: boolean;
+    /**
+     * Return the descriptor of the feature.
+     */
+    get descriptor(): TDescriptor;
+    set descriptor(value: TDescriptor);
+    /**
+     * Returns whether the feature is enabled.
+     */
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    /**
+     * Returns whether the feature is supported.
+     * @param descriptor - The descriptor of the feature
+     * @returns The promise of the feature
+     */
+    isSupported(descriptor?: IXRFeatureDescriptor): Promise<void>;
+    /**
+     * Initialize the feature.
+     * @returns The promise of the feature
+     */
+    initialize(): Promise<void>;
+    /**
+     * Called when be enabled.
+     */
+    onEnable(): void;
+    /**
+     * Called when be disabled.
+     */
+    onDisable(): void;
+    /**
+     * Called when xr frame is updated.
+     */
+    onUpdate(session: IXRSession, frame: IXRFrame): void;
+    /**
+     * Called when the session is initialized.
+     */
+    onSessionInit(): void;
+    /**
+     * Called when session starts.
+     */
+    onSessionStart(): void;
+    /**
+     * Called when the session is stopped.
+     */
+    onSessionStop(): void;
+    /**
+     * Called when the session is destroyed.
+     */
+    onSessionDestroy(): void;
+    /**
+     * Called when the xr module is destroyed.
+     */
+    onDestroy(): void;
+    constructor(_engine: Engine);
+}

package/types/xr/feature/XRFeatureType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Enum for XR feature type.
+ */
+export declare enum XRFeatureType {
+    /** Anchor tracking */
+    AnchorTracking = 0,
+    /** Image tracking */
+    ImageTracking = 1,
+    /** Plane tracking */
+    PlaneTracking = 2,
+    /** Hit test */
+    HitTest = 3
+}

package/types/xr/feature/camera/XRCameraManager.d.ts

@@ -0,0 +1,26 @@
+import { Camera } from "../../../Camera";
+import { XRTrackedInputDevice } from "../../input/XRTrackedInputDevice";
+/**
+ * The manager of XR camera.
+ */
+export declare class XRCameraManager {
+    private _xrManager;
+    /**
+     * The fixed foveation of the camera.
+     */
+    get fixedFoveation(): number;
+    set fixedFoveation(value: number);
+    /**
+     * Attach the camera to the specified input type(Camera, LeftCamera or RightCamera).
+     * The camera entity need to be moved to the XROrigin entity.
+     * @param type - The input type
+     * @param camera - The camera to be attached
+     */
+    attachCamera(type: XRTrackedInputDevice.Camera | XRTrackedInputDevice.LeftCamera | XRTrackedInputDevice.RightCamera, camera: Camera): void;
+    /**
+     * Detach the camera from the specified input type.
+     * @param type - The input type
+     * @returns The camera that was detached
+     */
+    detachCamera(type: XRTrackedInputDevice.Camera | XRTrackedInputDevice.LeftCamera | XRTrackedInputDevice.RightCamera): Camera;
+}

package/types/xr/feature/hitTest/TrackableType.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Enum for the types of hit test that can be performed.
+ * Note: currently only supports plane.
+ */
+export declare enum TrackableType {
+    /** Tracked plane. */
+    Plane = 1,
+    /** All tracked objects. */
+    All = 1
+}

package/types/xr/feature/hitTest/XRHitResult.d.ts

@@ -0,0 +1,19 @@
+import { IXRTracked } from "@galacean/engine-design";
+import { Vector3 } from "@galacean/engine-math";
+import { TrackableType } from "./TrackableType";
+/**
+ * XR hit result.
+ * It is the detection result returned by using XR HitTest feature.
+ */
+export declare class XRHitResult {
+    /** The position of the hit point. */
+    point: Vector3;
+    /** The normal of the hit point. */
+    normal: Vector3;
+    /** The distance from the origin of the ray to the hit point. */
+    distance: number;
+    /** The hit tracked object, such as IXRTrackedPlane. */
+    trackedObject: IXRTracked;
+    /** The type of tracked object detected, such as TrackableType.Plane */
+    trackableType: TrackableType;
+}

package/types/xr/feature/hitTest/XRHitTest.d.ts

@@ -0,0 +1,39 @@
+import { Ray } from "@galacean/engine-math";
+import { XRManager } from "../../XRManager";
+import { XRFeature } from "../XRFeature";
+import { TrackableType } from "./TrackableType";
+import { XRHitResult } from "./XRHitResult";
+/**
+ * The manager of XR hit test.
+ */
+export declare class XRHitTest extends XRFeature {
+    private _tempRay;
+    private _tempVec2;
+    private _tempVec30;
+    private _tempVec31;
+    private _tempVec32;
+    private _tempVec33;
+    private _tempVec34;
+    private _tempVec35;
+    /**
+     * @param xrManager - The xr manager
+     */
+    constructor(xrManager: XRManager);
+    /**
+     * Hit test.
+     * @param ray - The ray to test
+     * @param type - The type of hit test
+     * @returns The hit result
+     */
+    hitTest(ray: Ray, type: TrackableType): XRHitResult[];
+    /**
+     * Screen hit test.
+     * @param x - The x coordinate of the screen point (normalized)
+     * @param y - The y coordinate of the screen point (normalized)
+     * @param type - The type of hit test
+     * @returns The hit result
+     */
+    screenHitTest(x: number, y: number, type: TrackableType): XRHitResult[];
+    private _hitTestPlane;
+    private _checkPointerWithinPlane;
+}

package/types/xr/feature/hitTest/XRHitTestManager.d.ts

@@ -0,0 +1,38 @@
+import { IXRFeatureDescriptor, IXRHitResult } from "@galacean/engine-design";
+import { XRHitTestType } from "./XRHitTestType";
+import { Ray } from "@galacean/engine-math";
+import { XRFeatureManager } from "../XRFeatureManager";
+export declare class XRHitTestManager extends XRFeatureManager {
+    private _tempRay;
+    private _tempVec2;
+    private _tempVec30;
+    private _tempVec31;
+    private _tempVec32;
+    private _tempVec33;
+    private _tempVec34;
+    private _tempVec35;
+    /**
+     * Returns whether the feature is supported.
+     * @param descriptor - The descriptor of the feature
+     * @returns The promise of the feature
+     */
+    isSupported(descriptor?: IXRFeatureDescriptor): Promise<void>;
+    /**
+     * Hit test.
+     * @param ray - The ray to test
+     * @param type - The type of hit test
+     * @returns The hit result
+     */
+    hitTest(ray: Ray, type: XRHitTestType): IXRHitResult[];
+    /**
+     * Screen hit test.
+     * @param x - The x coordinate of the screen point (normalized)
+     * @param y - The y coordinate of the screen point (normalized)
+     * @param type - The type of hit test
+     * @returns The hit result
+     */
+    screenHitTest(x: number, y: number, type: XRHitTestType): IXRHitResult[];
+    private _hitTest;
+    private _hitTestPlane;
+    private _checkPointerWithinPlane;
+}

package/types/xr/feature/hitTest/XRHitTestType.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Enum for the types of hit test that can be performed.
+ * Note: currently only supports plane.
+ */
+export declare enum XRHitTestType {
+    /** None */
+    None = 0,
+    /** Tracked plane. */
+    Plane = 1,
+    /** Tracked mesh. */
+    Mesh = 2,
+    /** Tracked anchor. */
+    Anchor = 4,
+    /** All tracked objects. */
+    All = 7
+}

package/types/xr/feature/movementTracking/XRMovementTracking.d.ts

@@ -0,0 +1,18 @@
+import { XRManager } from "../../XRManager";
+import { XRFeature } from "../XRFeature";
+import { XRMovementTrackingMode } from "./XRMovementTrackingMode";
+/**
+ * The manager of XR movement tracking.
+ */
+export declare class XRMovementTracking extends XRFeature {
+    private _trackingMode;
+    /**
+     * Get the tracking mode.
+     */
+    get trackingMode(): XRMovementTrackingMode;
+    /**
+     * @param xrManager - The xr manager
+     * @param trackingMode - The tracking mode
+     */
+    constructor(xrManager: XRManager, trackingMode?: XRMovementTrackingMode);
+}

package/types/xr/feature/movementTracking/XRMovementTrackingManager.d.ts

@@ -0,0 +1,10 @@
+import { IXRMovementTracking, IXRMovementTrackingDescriptor } from "@galacean/engine-design";
+import { XRMovementTrackingMode } from "./XRMovementTrackingMode";
+import { XRFeatureManager } from "../XRFeatureManager";
+export declare class XRMovementTrackingManager extends XRFeatureManager<IXRMovementTrackingDescriptor, IXRMovementTracking> {
+    /**
+     * Get the tracking mode.
+     */
+    get trackingMode(): XRMovementTrackingMode;
+    set trackingMode(value: XRMovementTrackingMode);
+}

package/types/xr/feature/movementTracking/XRMovementTrackingMode.d.ts

@@ -0,0 +1,5 @@
+export declare enum XRMovementTrackingMode {
+    None = 0,
+    Dof3 = 1,
+    Dof6 = 2
+}

package/types/xr/feature/trackable/XRRequestTrackingState.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Enum for the state of a request to track a trackable.
+ */
+export declare enum XRRequestTrackingState {
+    None = 0,
+    Submitted = 1,
+    Resolved = 2,
+    Rejected = 3,
+    Destroyed = 4,
+    WaitingDestroy = 5
+}

package/types/xr/feature/trackable/XRTrackableFeature.d.ts

@@ -0,0 +1,38 @@
+import { IXRTrackablePlatformFeature } from "@galacean/engine-design";
+import { XRTrackingState } from "../../input/XRTrackingState";
+import { XRFeature } from "../XRFeature";
+import { XRRequestTracking } from "./XRRequestTracking";
+import { XRTracked } from "./XRTracked";
+/**
+ * The base class of XR trackable manager.
+ */
+export declare abstract class XRTrackableFeature<T extends XRTracked, K extends XRRequestTracking<T>> extends XRFeature<IXRTrackablePlatformFeature<T, K>> {
+    protected _requestTrackings: K[];
+    protected _tracked: T[];
+    protected _added: T[];
+    protected _updated: T[];
+    protected _removed: T[];
+    protected _statusSnapshot: Record<number, XRTrackingState>;
+    private _listeners;
+    /**
+     * Returns the tracked objects.
+     */
+    get tracked(): readonly T[];
+    /**
+     * Add a listening function for tracked object changes.
+     * @param listener - The listening function
+     */
+    addChangedListener(listener: (added: readonly T[], updated: readonly T[], removed: readonly T[]) => void): void;
+    /**
+     * Remove a listening function of tracked object changes.
+     * @param listener - The listening function
+     */
+    removeChangedListener(listener: (added: readonly T[], updated: readonly T[], removed: readonly T[]) => void): void;
+    _onUpdate(): void;
+    _onSessionStop(): void;
+    _onSessionExit(): void;
+    _onDestroy(): void;
+    protected _addRequestTracking(requestTracking: K): void;
+    protected _removeRequestTracking(requestTracking: K): void;
+    protected _removeAllRequestTrackings(): void;
+}

package/types/xr/feature/trackable/XRTrackableManager.d.ts

@@ -0,0 +1,41 @@
+import { IXRFeatureDescriptor, IXRFrame, IXRRequestTracking, IXRSession, IXRTrackableFeature, IXRTracked } from "@galacean/engine-design";
+import { XRTrackedUpdateFlag } from "../../input/XRTrackedUpdateFlag";
+import { XRFeatureManager } from "../XRFeatureManager";
+import { XRTrackingState } from "../../input/XRTrackingState";
+/**
+ * The base class of XR trackable manager.
+ */
+export declare abstract class XRTrackableManager<TDescriptor extends IXRFeatureDescriptor, TXRTracked extends IXRTracked, TXRRequestTracking extends IXRRequestTracking<TXRTracked>, TTrackableFeature extends IXRTrackableFeature<TXRTracked, TXRRequestTracking>> extends XRFeatureManager<TDescriptor, TTrackableFeature> {
+    protected _requestTrackings: TXRRequestTracking[];
+    protected _trackedObjects: TXRTracked[];
+    protected _added: TXRTracked[];
+    protected _updated: TXRTracked[];
+    protected _removed: TXRTracked[];
+    protected _statusSnapshot: Record<number, XRTrackingState>;
+    private _trackedUpdateFlag;
+    /**
+     * Return Request tracking requirements.
+     */
+    get requestTrackings(): readonly TXRRequestTracking[];
+    /**
+     * Returns the tracked objects.
+     */
+    get trackedObjects(): readonly TXRTracked[];
+    addRequestTracking(requestTracking: TXRRequestTracking): void;
+    removeRequestTracking(remove: TXRRequestTracking): void;
+    removeAllRequestTrackings(): void;
+    /**
+     * Add a listening function to track changes.
+     * @param listener - The listening function
+     */
+    addListener(listener: (type: XRTrackedUpdateFlag, param: readonly TXRTracked[]) => any): void;
+    /**
+     * Remove a listening function to track changes.
+     * @param listener - The listening function
+     */
+    removeListener(listener: (type: XRTrackedUpdateFlag, param: readonly TXRTracked[]) => any): void;
+    onUpdate(session: IXRSession, frame: IXRFrame): void;
+    onSessionStop(): void;
+    onSessionDestroy(): void;
+    onDestroy(): void;
+}

package/types/xr/feature/trackable/XRTracked.d.ts

@@ -0,0 +1 @@
+export {};

package/types/xr/feature/trackable/anchor/XRAnchor.d.ts

@@ -0,0 +1,6 @@
+import { XRTracked } from "../XRTracked";
+/**
+ * The anchor in XR space.
+ */
+export declare class XRAnchor extends XRTracked {
+}

package/types/xr/feature/trackable/anchor/XRAnchorTracking.d.ts

@@ -0,0 +1,37 @@
+import { Quaternion, Vector3 } from "@galacean/engine-math";
+import { XRManager } from "../../../XRManager";
+import { XRTrackableFeature } from "../XRTrackableFeature";
+import { XRAnchor } from "./XRAnchor";
+import { XRRequestAnchor } from "./XRRequestAnchor";
+/**
+ * The manager of XR anchor tracking.
+ */
+export declare class XRAnchorTracking extends XRTrackableFeature<XRAnchor, XRRequestAnchor> {
+    private _anchors;
+    /**
+     * The anchors to tracking.
+     */
+    get trackingAnchors(): readonly XRAnchor[];
+    /**
+     * The tracked anchors.
+     */
+    get trackedAnchors(): readonly XRAnchor[];
+    /**
+     * @param xrManager - The xr manager
+     */
+    constructor(xrManager: XRManager);
+    /**
+     * Add a anchor in XR space.
+     * @param anchor - The anchor to be added
+     */
+    addAnchor(position: Vector3, rotation: Quaternion): XRAnchor;
+    /**
+     * Remove a anchor in XR space.
+     * @param anchor - The anchor to be removed
+     */
+    removeAnchor(anchor: XRAnchor): void;
+    /**
+     * Remove all tracking anchors.
+     */
+    clearAnchors(): void;
+}

package/types/xr/feature/trackable/anchor/XRAnchorTrackingManager.d.ts

@@ -0,0 +1,20 @@
+import { IXRPose, IXRTracked, IXRAnchorTracking, IXRRequestAnchorTracking, IXRAnchorTrackingDescriptor } from "@galacean/engine-design";
+import { XRTrackableManager } from "../XRTrackableManager";
+export declare class XRAnchorTrackingManager extends XRTrackableManager<IXRAnchorTrackingDescriptor, IXRTracked, IXRRequestAnchorTracking, IXRAnchorTracking> {
+    /**
+     * Add a tracking anchor.
+     * @param pose - The pose of anchor to be added
+     */
+    addAnchor(pose: IXRPose): IXRRequestAnchorTracking;
+    /**
+     * Remove a tracking anchor.
+     * @param anchor - The anchor to be removed
+     */
+    removeAnchor(anchor: IXRRequestAnchorTracking): void;
+    /**
+     * Remove all tracking anchors.
+     */
+    removeAllAnchors(): void;
+    initialize(): Promise<void>;
+    private _createRequestTracking;
+}

package/types/xr/feature/trackable/anchor/XRRequestAnchor.d.ts

@@ -0,0 +1,15 @@
+import { Quaternion, Vector3 } from "@galacean/engine-math";
+import { XRRequestTracking } from "../XRRequestTracking";
+import { XRAnchor } from "./XRAnchor";
+/**
+ * The request anchor in XR space.
+ */
+export declare class XRRequestAnchor extends XRRequestTracking<XRAnchor> {
+    position: Vector3;
+    rotation: Quaternion;
+    /**
+     * @param position - Requests the position of the anchor to be added
+     * @param rotation - Requests the rotation of the anchor to be added
+     */
+    constructor(position: Vector3, rotation: Quaternion);
+}

package/types/xr/feature/trackable/image/XRImageTracking.d.ts

@@ -0,0 +1,24 @@
+import { XRManager } from "../../../XRManager";
+import { XRTrackableFeature } from "../XRTrackableFeature";
+import { XRReferenceImage } from "./XRReferenceImage";
+import { XRRequestImage } from "./XRRequestImage";
+import { XRTrackedImage } from "./XRTrackedImage";
+/**
+ * The manager of XR image tracking.
+ */
+export declare class XRImageTracking extends XRTrackableFeature<XRTrackedImage, XRRequestImage> {
+    private _images;
+    /**
+     * The image to tracking.
+     */
+    get images(): readonly XRReferenceImage[];
+    /**
+     * The tracked images.
+     */
+    get trackedImages(): readonly XRTrackedImage[];
+    /**
+     * @param xrManager - The xr manager
+     * @param images - The images to be tracked
+     */
+    constructor(xrManager: XRManager, images: XRReferenceImage[]);
+}

package/types/xr/feature/trackable/image/XRImageTrackingManager.d.ts

@@ -0,0 +1,31 @@
+import { IXRImageTracking, IXRRequestImageTracking, IXRTrackedImage, IXRImageTrackingDescriptor } from "@galacean/engine-design";
+import { XRTrackableManager } from "../XRTrackableManager";
+import { XRReferenceImage } from "./XRReferenceImage";
+export declare class XRImageTrackingManager extends XRTrackableManager<IXRImageTrackingDescriptor, IXRTrackedImage, IXRRequestImageTracking, IXRImageTracking> {
+    /**
+     * Add a tracking image
+     * @param image - xr reference image
+     */
+    addImage(image: XRReferenceImage): void;
+    /**
+     * Add tracking images
+     * @param images - xr reference images
+     */
+    addImage(images: XRReferenceImage[]): void;
+    /**
+     * Remove a tracking image
+     * @param image - xr reference image
+     */
+    removeImage(image: XRReferenceImage): void;
+    /**
+     * Remove tracking images
+     * @param images - xr reference images
+     */
+    removeImage(images: XRReferenceImage[]): void;
+    /**
+     * Remove all tracking images
+     */
+    removeAllImages(): void;
+    initialize(): Promise<void>;
+    private _createRequestTracking;
+}

package/types/xr/feature/trackable/image/XRReferenceImage.d.ts

@@ -0,0 +1,11 @@
+import { IXRReferenceImage } from "@galacean/engine-design";
+/**
+ *  A reference image is an image to look for in the physical environment.
+ */
+export declare class XRReferenceImage implements IXRReferenceImage {
+    name: string;
+    src: string | HTMLImageElement | SVGImageElement | HTMLVideoElement | HTMLCanvasElement | Blob | ImageData | ImageBitmap | OffscreenCanvas;
+    physicalWidth: number;
+    physicalHeight: number;
+    constructor(name: string, src: string | HTMLImageElement | SVGImageElement | HTMLVideoElement | HTMLCanvasElement | Blob | ImageData | ImageBitmap | OffscreenCanvas, physicalWidth?: number, physicalHeight?: number);
+}

package/types/xr/feature/trackable/image/XRRequestImage.d.ts

@@ -0,0 +1,13 @@
+import { XRRequestTracking } from "../XRRequestTracking";
+import { XRReferenceImage } from "./XRReferenceImage";
+import { XRTrackedImage } from "./XRTrackedImage";
+/**
+ * The request image in XR space.
+ */
+export declare class XRRequestImage extends XRRequestTracking<XRTrackedImage> {
+    image: XRReferenceImage;
+    /**
+     * @param image - The image to be tracked
+     */
+    constructor(image: XRReferenceImage);
+}