@galacean/engine-core 1.1.0-alpha.0 → 1.1.0-alpha.2

package/types/texture/enums/TextureFormat.d.ts

@@ -2,68 +2,74 @@
  * Texture format enumeration.
  */
 export declare enum TextureFormat {
-    /** RGB format,8 bits per channel. */
+    /** RGB format, 8 bits per channel. */
     R8G8B8 = 0,
-    /** RGBA format,8 bits per channel. */
+    /** RGBA format, 8 bits per channel. */
     R8G8B8A8 = 1,
-    /** RGBA format,4 bits per channel. */
+    /** RGBA format, 4 bits per channel. */
     R4G4B4A4 = 2,
-    /** RGBA format,5 bits in R channel,5 bits in G channel,5 bits in B channel, 1 bit in A channel. */
+    /** RGBA format, 5 bits in R channel, 5 bits in G channel, 5 bits in B channel, 1 bit in A channel. */
     R5G5B5A1 = 3,
-    /** RGB format,5 bits in R channel,6 bits in G channel,5 bits in B channel. */
+    /** RGB format, 5 bits in R channel, 6 bits in G channel, 5 bits in B channel. */
     R5G6B5 = 4,
-    /** Transparent format,8 bits. */
+    /** Transparent format, 8 bits. */
     Alpha8 = 5,
     /** Luminance/alpha in RGB channel, alpha in A channel. */
     LuminanceAlpha = 6,
-    /** RGBA format,16 bits per channel. */
+    /** RGBA format, 16 bits per channel. */
     R16G16B16A16 = 7,
-    /** RGBA format,32 bits per channel. */
+    /** RGBA format, 32 bits per channel. */
     R32G32B32A32 = 8,
-    /** RGB compressed format。*/
-    DXT1 = 9,
-    /** RGBA compressed format。*/
-    DXT5 = 10,
-    /** RGB compressed format,4 bits per pixel。*/
-    ETC1_RGB = 11,
-    /** RGB compressed format,4 bits per pixel。*/
-    ETC2_RGB = 12,
-    /** RGBA compressed format,5 bits per pixel,4 bit in RGB, 1 bit in A. */
-    ETC2_RGBA5 = 13,
-    /** RGB compressed format,8 bits per pixel. */
-    ETC2_RGBA8 = 14,
-    /** RGB compressed format,2 bits per pixel. */
-    PVRTC_RGB2 = 15,
-    /** RGBA compressed format,2 bits per pixel. */
-    PVRTC_RGBA2 = 16,
-    /** RGB compressed format,4 bits per pixel. */
-    PVRTC_RGB4 = 17,
-    /** RGBA compressed format,4 bits per pixel. */
-    PVRTC_RGBA4 = 18,
-    /** RGB(A) compressed format,128 bits per 4x4 pixel block. */
-    ASTC_4x4 = 19,
-    /** RGB(A) compressed format,128 bits per 5x5 pixel block. */
-    ASTC_5x5 = 20,
-    /** RGB(A) compressed format,128 bits per 6x6 pixel block. */
-    ASTC_6x6 = 21,
-    /** RGB(A) compressed format,128 bits per 8x8 pixel block. */
-    ASTC_8x8 = 22,
-    /** RGB(A) compressed format,128 bits per 10x10 pixel block. */
-    ASTC_10x10 = 23,
-    /** RGB(A) compressed format,128 bits per 12x12 pixel block. */
-    ASTC_12x12 = 24,
-    /** Automatic depth format,engine will automatically select the supported precision. */
-    Depth = 25,
-    /** Automatic depth setncil format, engine will automatically select the supported precision. */
-    DepthStencil = 26,
+    /** RGB compressed format, 4 bits per pixel. */
+    BC1 = 9,
+    /** RGBA compressed format, 8 bits per pixel. */
+    BC3 = 10,
+    /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
+    BC7 = 11,
+    /** RGB compressed format, 4 bits per pixel. */
+    ETC1_RGB = 12,
+    /** RGB compressed format, 4 bits per pixel. */
+    ETC2_RGB = 13,
+    /** RGBA compressed format, 5 bits per pixel, 4 bit in RGB, 1 bit in A. */
+    ETC2_RGBA5 = 14,
+    /** RGB compressed format, 8 bits per pixel. */
+    ETC2_RGBA8 = 15,
+    /** RGB compressed format, 2 bits per pixel. */
+    PVRTC_RGB2 = 16,
+    /** RGBA compressed format, 2 bits per pixel. */
+    PVRTC_RGBA2 = 17,
+    /** RGB compressed format, 4 bits per pixel. */
+    PVRTC_RGB4 = 18,
+    /** RGBA compressed format, 4 bits per pixel. */
+    PVRTC_RGBA4 = 19,
+    /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
+    ASTC_4x4 = 20,
+    /** RGB(A) compressed format, 128 bits per 5x5 pixel block. */
+    ASTC_5x5 = 21,
+    /** RGB(A) compressed format, 128 bits per 6x6 pixel block. */
+    ASTC_6x6 = 22,
+    /** RGB(A) compressed format, 128 bits per 8x8 pixel block. */
+    ASTC_8x8 = 23,
+    /** RGB(A) compressed format, 128 bits per 10x10 pixel block. */
+    ASTC_10x10 = 24,
+    /** RGB(A) compressed format, 128 bits per 12x12 pixel block. */
+    ASTC_12x12 = 25,
+    /** Automatic depth format, engine will automatically select the supported precision. */
+    Depth = 26,
+    /** Automatic depth stencil format, engine will automatically select the supported precision. */
+    DepthStencil = 27,
     /** 16-bit depth format. */
-    Depth16 = 27,
+    Depth16 = 28,
     /** 24-bit depth format. */
-    Depth24 = 28,
+    Depth24 = 29,
     /** 32-bit depth format. */
-    Depth32 = 29,
+    Depth32 = 30,
     /** 16-bit depth + 8-bit stencil format. */
-    Depth24Stencil8 = 30,
+    Depth24Stencil8 = 31,
     /** 32-bit depth + 8-bit stencil format. */
-    Depth32Stencil8 = 31
+    Depth32Stencil8 = 32,
+    /** @deprecated Use `TextureFormat.BC1` instead. */
+    DXT1 = 33,
+    /** @deprecated Use `TextureFormat.BC3` instead. */
+    DXT5 = 34
 }

package/types/texture/enums/TextureUsage.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Texture usage.
+ */
+export declare enum TextureUsage {
+    /** The content of the texture is intended to be specified once.  */
+    Static = 0,
+    /** The content of the texture is intended to be updated frequently, with better performance. */
+    Dynamic = 1
+}

package/types/texture/index.d.ts

@@ -3,6 +3,7 @@ export { TextureCubeFace } from "./enums/TextureCubeFace";
 export { TextureDepthCompareFunction } from "./enums/TextureDepthCompareFunction";
 export { TextureFilterMode } from "./enums/TextureFilterMode";
 export { TextureFormat } from "./enums/TextureFormat";
+export { TextureUsage } from "./enums/TextureUsage";
 export { TextureWrapMode } from "./enums/TextureWrapMode";
 export { RenderTarget } from "./RenderTarget";
 export { Texture } from "./Texture";

package/types/xr/XRManager.d.ts

@@ -0,0 +1,31 @@
+import { Engine } from "../Engine";
+import { EnumXRMode } from "./enum/EnumXRMode";
+import { EnumXRFeature } from "./enum/EnumXRFeature";
+import { EnumXRTrackingMode } from "./enum/EnumXRTrackingMode";
+import { XRFeature } from "./feature/XRFeature";
+import { EnumXRSubsystem } from "./enum/EnumXRSubsystem";
+import { XRProvider } from "./provider/XRProvider";
+import { XRSubsystem } from "./subsystem/XRSubsystem";
+type FeatureConstructor = new (engine: Engine) => XRFeature;
+export declare class XRManager {
+    private _engine;
+    private _provider;
+    private _features;
+    private _subsystems;
+    private _isPaused;
+    isSupportedMode(mode: EnumXRMode): Promise<void>;
+    isSupportedTrackingMode(mode: EnumXRTrackingMode): Promise<void>;
+    isSupportedFeature(feature: EnumXRFeature): Promise<void>;
+    getFeature<T extends XRFeature>(feature: EnumXRFeature): T;
+    enableFeature(feature: EnumXRFeature): void;
+    disableFeature(feature: EnumXRFeature): void;
+    getSubsystem<T extends XRSubsystem>(subsystem: EnumXRSubsystem): T;
+    initialize(mode: EnumXRMode, trackingMode: EnumXRTrackingMode, requestFeatures?: EnumXRFeature[]): Promise<void>;
+    start(): Promise<void>;
+    pause(): void;
+    resume(): void;
+    destroy(): void;
+    constructor(engine: Engine, type: new (engine: Engine) => XRProvider);
+}
+export declare function registerFeature(feature: EnumXRFeature, dependentSubsystem?: EnumXRSubsystem[]): (featureConstructor: FeatureConstructor) => void;
+export {};

package/types/xr/component/XRPoseDriver.d.ts

@@ -0,0 +1,10 @@
+import { Script } from "../../Script";
+import { EnumXRInputSource } from "../enum/EnumXRInputSource";
+import { EnumXRTrackingMode } from "../enum/EnumXRTrackingMode";
+export declare class XRPoseDriver extends Script {
+    source: EnumXRInputSource;
+    updateType: EnumXRTrackingMode;
+    private _xrManager;
+    onLateUpdate(): void;
+    onAwake(): void;
+}

package/types/xr/data/XRCamera.d.ts

@@ -0,0 +1,6 @@
+import { Matrix, Vector4 } from "@galacean/engine-math";
+import { XRDevice } from "./XRDevice";
+export declare class XRCamera extends XRDevice {
+    project: Matrix;
+    viewport: Vector4;
+}

package/types/xr/data/XRDevice.d.ts

@@ -0,0 +1,9 @@
+import { Matrix, Quaternion, Vector3 } from "@galacean/engine-math";
+import { EnumXRDevicePhase } from "../enum/EnumXRDevicePhase";
+export declare class XRDevice {
+    matrix: Matrix;
+    position: Vector3;
+    linearVelocity: Vector3;
+    quaternion: Quaternion;
+    phase: EnumXRDevicePhase;
+}

package/types/xr/data/XRHandle.d.ts

@@ -0,0 +1,10 @@
+import { XRDevice } from "./XRDevice";
+import { EnumXRButton } from "../enum/EnumXRButton";
+import { DisorderedArray } from "../../DisorderedArray";
+export declare class XRHandle extends XRDevice {
+    pressedButtons: EnumXRButton;
+    upMap: number[];
+    downMap: number[];
+    upList: DisorderedArray<EnumXRButton>;
+    downList: DisorderedArray<EnumXRButton>;
+}

package/types/xr/enum/EnumXRButton.d.ts

@@ -0,0 +1,5 @@
+export declare enum EnumXRButton {
+    None = 0,
+    Select = 1,
+    Squeeze = 2
+}

package/types/xr/enum/EnumXRDevicePhase.d.ts

@@ -0,0 +1,4 @@
+export declare enum EnumXRDevicePhase {
+    active = 0,
+    leave = 1
+}

package/types/xr/enum/EnumXRFeature.d.ts

@@ -0,0 +1,9 @@
+/**
+ *
+ */
+export declare enum EnumXRFeature {
+    input = 0,
+    camera = 1,
+    imageTracking = 2,
+    objectTracking = 3
+}

package/types/xr/enum/EnumXRInputSource.d.ts

@@ -0,0 +1,8 @@
+export declare enum EnumXRInputSource {
+    Handler = 0,
+    LeftHandle = 1,
+    RightHandle = 2,
+    Eye = 3,
+    LeftEye = 4,
+    RightEye = 5
+}

package/types/xr/enum/EnumXRMode.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Modes for XR
+ */
+export declare enum EnumXRMode {
+    AR = 0,
+    VR = 1
+}

package/types/xr/enum/EnumXRSubsystem.d.ts

@@ -0,0 +1,4 @@
+export declare enum EnumXRSubsystem {
+    input = 0,
+    imageTracking = 1
+}

package/types/xr/enum/EnumXRTrackingMode.d.ts

@@ -0,0 +1,7 @@
+export declare enum EnumXRTrackingMode {
+    None = 0,
+    RotationOnly = 1,
+    PositionOnly = 2,
+    RotationAndPosition = 3,
+    Auto = 4
+}

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

@@ -0,0 +1,21 @@
+import { Camera } from "../../Camera";
+import { EnumXRInputSource } from "../enum/EnumXRInputSource";
+import { XRFeature } from "./XRFeature";
+export declare class XRCameraManager extends XRFeature {
+    private _cameras;
+    private _automaticNear;
+    private _customNear;
+    private _automaticFar;
+    private _customFar;
+    get near(): number;
+    set near(value: number);
+    get far(): number;
+    set far(value: number);
+    attachCamera(source: EnumXRInputSource, camera: Camera): void;
+    detachCamera(source: EnumXRInputSource): void;
+    getCamera(source: EnumXRInputSource): Camera;
+    onUpdate(): void;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
+}

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

@@ -0,0 +1,29 @@
+import { Engine } from "../../Engine";
+export declare abstract class XRFeature {
+    protected _engine: Engine;
+    /**
+     * Enable an instance of a feature.
+     * This method needs to be override.
+     * @returns
+     */
+    onEnable(): void;
+    /**
+     * Disable an instance of a feature.
+     * This method needs to be override.
+     * @returns
+     */
+    onDisable(): void;
+    /**
+     * Update an instance of a feature.
+     * This method needs to be override.
+     * @returns
+     */
+    onUpdate(): void;
+    /**
+     * Destroy an instance of a feature.
+     * This method needs to be override.
+     * @returns
+     */
+    onDestroy(): void;
+    constructor(engine: Engine);
+}

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

@@ -0,0 +1,10 @@
+import { Entity } from "../../Entity";
+import { XRFeature } from "./XRFeature";
+export declare class XRImageTrackManager extends XRFeature {
+    addImage(): void;
+    removeImage(): void;
+    getTrackedObject(): Entity;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
+}

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

@@ -0,0 +1,16 @@
+import { Engine } from "../../Engine";
+import { XRDevice } from "../data/XRDevice";
+import { EnumXRButton } from "../enum/EnumXRButton";
+import { EnumXRInputSource } from "../enum/EnumXRInputSource";
+import { XRFeature } from "./XRFeature";
+export declare class XRInputManager extends XRFeature {
+    private _subSystem;
+    getDevice<T extends XRDevice>(source: EnumXRInputSource): T;
+    isButtonDown(handedness: EnumXRInputSource, button: EnumXRButton): boolean;
+    isButtonUp(handedness: EnumXRInputSource, button: EnumXRButton): boolean;
+    isButtonHeldDown(handedness: EnumXRInputSource, button: EnumXRButton): boolean;
+    onEnable(): void;
+    onDisable(): void;
+    onDestroy(): void;
+    constructor(engine: Engine);
+}

package/types/xr/index.d.ts

@@ -0,0 +1,18 @@
+export { XRManager, registerFeature } from "./XRManager";
+export { EnumXRMode } from "./enum/EnumXRMode";
+export { EnumXRButton } from "./enum/EnumXRButton";
+export { EnumXRFeature } from "./enum/EnumXRFeature";
+export { EnumXRSubsystem } from "./enum/EnumXRSubsystem";
+export { EnumXRDevicePhase } from "./enum/EnumXRDevicePhase";
+export { EnumXRInputSource } from "./enum/EnumXRInputSource";
+export { EnumXRTrackingMode } from "./enum/EnumXRTrackingMode";
+export { XRInputManager } from "./feature/XRInputManager";
+export { XRCameraManager } from "./feature/XRCameraManager";
+export { XRImageTrackManager } from "./feature/XRImageTrackManager";
+export { XRSubsystem } from "./subsystem/XRSubsystem";
+export { XRInputSubsystem } from "./subsystem/XRInputSubsystem";
+export { XRProvider } from "./provider/XRProvider";
+export { XRPoseDriver } from "./component/XRPoseDriver";
+export { XRDevice } from "./data/XRDevice";
+export { XRCamera } from "./data/XRCamera";
+export { XRHandle } from "./data/XRHandle";

package/types/xr/provider/XRProvider.d.ts

@@ -0,0 +1,19 @@
+import { EnumXRMode } from "../enum/EnumXRMode";
+import { EnumXRTrackingMode } from "../enum/EnumXRTrackingMode";
+import { XRSubsystem } from "../subsystem/XRSubsystem";
+import { Engine } from "../../Engine";
+import { EnumXRSubsystem } from "../enum/EnumXRSubsystem";
+export declare class XRProvider {
+    name: string;
+    protected _engine: Engine;
+    isSupportedMode(mode: EnumXRMode): Promise<void>;
+    isSupportedTrackingMode(mode: EnumXRTrackingMode): Promise<void>;
+    isSupportedSubsystem(feature: number): Promise<void>;
+    createSubsystem<T extends XRSubsystem>(feature: number): Promise<T>;
+    initialize(mode: EnumXRMode, trackingMode: EnumXRTrackingMode, subsystems: EnumXRSubsystem[]): Promise<XRSubsystem[]>;
+    start(): Promise<void>;
+    onUpdate(): void;
+    onLateUpdate(): void;
+    onDestroy(): void;
+    constructor(engine: Engine);
+}

package/types/xr/subsystem/XRInputSubsystem.d.ts

@@ -0,0 +1,5 @@
+import { XRDevice } from "../data/XRDevice";
+import { XRSubsystem } from "./XRSubsystem";
+export declare abstract class XRInputSubsystem extends XRSubsystem {
+    devices: XRDevice[];
+}

package/types/xr/subsystem/XRSubsystem.d.ts

@@ -0,0 +1,30 @@
+import { Engine } from "../../Engine";
+export declare abstract class XRSubsystem {
+    running: boolean;
+    _engine: Engine;
+    /**
+     * Starts an instance of a system.
+     * This method needs to be override.
+     * @returns
+     */
+    start(): Promise<void>;
+    /**
+     * Stops an instance of a system.
+     * This method needs to be override.
+     * @returns
+     */
+    stop(): Promise<void>;
+    /**
+     * Destroys this instance of a system.
+     * This method needs to be override.
+     * @returns
+     */
+    destroy(): Promise<void>;
+    /**
+     * Update this instance of a system.
+     * This method needs to be override.
+     * @returns
+     */
+    update(): void;
+    constructor(engine: Engine);
+}