@galacean/engine-loader 1.1.0-beta.9 → 1.2.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-loader",
-  "version": "1.1.0-beta.9",
+  "version": "1.2.0-alpha.1",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,10 +15,9 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-draco": "1.1.0-beta.9",
-    "@galacean/engine-rhi-webgl": "1.1.0-beta.9",
-    "@galacean/engine-core": "1.1.0-beta.9",
-    "@galacean/engine-math": "1.1.0-beta.9"
+    "@galacean/engine-core": "1.2.0-alpha.1",
+    "@galacean/engine-math": "1.2.0-alpha.1",
+    "@galacean/engine-rhi-webgl": "1.2.0-alpha.1"
   },
   "scripts": {
     "b:types": "tsc"

package/types/GLTFLoader.d.ts

@@ -1,6 +1,12 @@
-import { AssetPromise, Loader, LoadItem, ResourceManager } from "@galacean/engine-core";
+import { AssetPromise, Engine, EngineConfiguration, Loader, LoadItem, ResourceManager } from "@galacean/engine-core";
 import { GLTFResource } from "./gltf/GLTFResource";
 export declare class GLTFLoader extends Loader<GLTFResource> {
+    /**
+     * Release glTF loader memory(includes meshopt workers).
+     * @remarks If use loader after releasing, we should release again.
+     */
+    static release(): void;
+    initialize(_: Engine, configuration: EngineConfiguration): Promise<void>;
     load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<GLTFResource>;
 }
 /**
@@ -12,4 +18,5 @@ export interface GLTFParams {
      * Keep raw mesh data for glTF parser, default is false.
      */
     keepMeshData?: boolean;
+    [key: string]: any;
 }

package/types/Texture2DLoader.d.ts

@@ -1,4 +1,4 @@
-import { TextureFormat } from "@galacean/engine-core";
+import { TextureFilterMode, TextureFormat, TextureWrapMode } from "@galacean/engine-core";
 /**
  * Texture2D loader params interface.
  */
@@ -7,4 +7,12 @@ export interface Texture2DParams {
     format: TextureFormat;
     /** Whether to use multi-level texture, default is true. */
     mipmap: boolean;
+    /** Wrapping mode for texture coordinate S. */
+    wrapModeU: TextureWrapMode;
+    /** Wrapping mode for texture coordinate T. */
+    wrapModeV: TextureWrapMode;
+    /** Filter mode for texture. */
+    filterMode: TextureFilterMode;
+    /** Anisotropic level for texture. */
+    anisoLevel: number;
 }

package/types/gltf/GLTFResource.d.ts

@@ -4,28 +4,62 @@ import { AnimationClip, Camera, Engine, Entity, Light, Material, ModelMesh, Refe
  */
 export declare class GLTFResource extends ReferResource {
     /** glTF file url. */
-    url: string;
+    readonly url: string;
     /** Texture2D after TextureParser. */
-    textures?: Texture2D[];
+    readonly textures?: Texture2D[];
     /** Material after MaterialParser. */
-    materials?: Material[];
+    readonly materials?: Material[];
     /** ModelMesh after MeshParser. */
-    meshes?: ModelMesh[][];
+    readonly meshes?: ModelMesh[][];
     /** Skin after SkinParser. */
-    skins?: Skin[];
+    readonly skins?: Skin[];
     /** AnimationClip after AnimationParser. */
-    animations?: AnimationClip[];
-    /** Entity after EntityParser. */
+    readonly animations?: AnimationClip[];
+    /** @internal */
+    _defaultSceneRoot: Entity;
+    /** @internal */
+    _sceneRoots: Entity[];
+    /** @internal */
+    _extensionsData: Record<string, any>;
+    /**
+     * Extensions data.
+     */
+    get extensionsData(): Record<string, any>;
+    /**
+     * @internal
+     */
+    constructor(engine: Engine, url: string);
+    /**
+     * Instantiate scene root entity.
+     * @param sceneIndex - Scene index
+     * @returns Root entity
+     */
+    instantiateSceneRoot(sceneIndex?: number): Entity;
+    protected _onDestroy(): void;
+    private _disassociationSuperResource;
+    /**
+     * @deprecated
+     * Entity after EntityParser.
+     */
     entities: Entity[];
-    /** Camera after SceneParser. */
+    /**
+     * @deprecated
+     * Camera after SceneParser.
+     */
     cameras?: Camera[];
-    /** Export lights in extension KHR_lights_punctual. */
+    /**
+     * @deprecated
+     * Export lights in extension KHR_lights_punctual.
+     */
     lights?: Light[];
-    /** RootEntities after SceneParser. */
-    sceneRoots: Entity[];
-    /** RootEntity after SceneParser. */
-    defaultSceneRoot: Entity;
-    /** Extensions data. */
-    extensionsData: Record<string, any>;
-    constructor(engine: Engine, url: string);
+    /**
+     * @deprecated Please use `instantiateSceneRoot` instead.
+     * RootEntities after SceneParser.
+     */
+    get sceneRoots(): Entity[];
+    /**
+     * @deprecated Please use `instantiateSceneRoot` instead.
+     * RootEntity after SceneParser.
+     */
+    get defaultSceneRoot(): Entity;
 }

package/types/gltf/GLTFSchema.d.ts

@@ -419,7 +419,7 @@ export interface IBufferView extends IChildRootProperty {
      */
     byteOffset?: number;
     /**
-     * The lenth of the bufferView in bytes
+     * The length of the bufferView in bytes
      */
     byteLength: number;
     /**

package/types/gltf/GLTFUtils.d.ts

@@ -30,7 +30,7 @@ export declare class GLTFUtils {
     /**
      * Get accessor data.
      */
-    static processingSparseData(bufferViews: IBufferView[], accessor: IAccessor, buffers: ArrayBuffer[], bufferInfo: BufferInfo): void;
+    static processingSparseData(context: GLTFParserContext, accessor: IAccessor, bufferInfo: BufferInfo): Promise<void>;
     static getIndexFormat(type: AccessorComponentType): IndexFormat;
     static getElementFormat(type: AccessorComponentType, size: number, normalized?: boolean): VertexElementFormat;
     /**

package/types/gltf/extensions/EXT_meshopt_compression.d.ts

@@ -0,0 +1,13 @@
+declare module "@galacean/engine-core" {
+    interface EngineConfiguration {
+        /** glTF loader options. */
+        glTF?: {
+            /** Meshopt options. If set this option and workCount is great than 0, workers will be created. */
+            meshOpt?: {
+                /** Worker count for transcoder, default is 4. */
+                workerCount: number;
+            };
+        };
+    }
+}
+export {};

package/types/gltf/extensions/GLTFExtensionParser.d.ts

@@ -19,7 +19,7 @@ export declare abstract class GLTFExtensionParser {
      * @param extensionOwnerSchema - The extension owner schema
      * @returns The resource or promise
      */
-    createAndParse(context: GLTFParserContext, extensionSchema: GLTFExtensionSchema, extensionOwnerSchema: GLTFExtensionOwnerSchema, ...extra: any[]): EngineObject | Promise<EngineObject>;
+    createAndParse(context: GLTFParserContext, extensionSchema: GLTFExtensionSchema, extensionOwnerSchema: GLTFExtensionOwnerSchema, ...extra: any[]): EngineObject | Promise<EngineObject | Uint8Array>;
     /**
      * Additive parse to the resource.
      * @param context - The parser context

package/types/gltf/extensions/GLTFExtensionSchema.d.ts

@@ -18,15 +18,6 @@ export interface IKHRLightsPunctual_Light {
 export interface IKHRLightsPunctual {
     lights: IKHRLightsPunctual_Light[];
 }
-/**
- * Interfaces from the KHR_draco_mesh_compression extension
- */
-export interface IKHRDracoMeshCompression {
-    bufferView: number;
-    attributes: {
-        [name: string]: number;
-    };
-}
 /**
  * Interfaces from the KHR_materials_clearcoat extension
  */
@@ -105,6 +96,14 @@ export interface IKHRMaterialVariants_Variant {
     extensions?: any;
     extras?: any;
 }
+/**
+ * Interfaces from the KHR_materials_clearcoat extension
+ */
+export interface IKHRMaterialsAnisotropy {
+    anisotropyStrength: number;
+    anisotropyRotation: number;
+    anisotropyTexture: ITextureInfo;
+}
 export interface IKHRMaterialVariants_Variants {
     variants: Array<IKHRMaterialVariants_Variant>;
 }
@@ -134,6 +133,15 @@ export interface IKHRXmp {
 export interface IKHRXmp_Node {
     packet: number;
 }
+export interface IEXTMeshoptCompressionSchema {
+    buffer: number;
+    byteOffset?: number;
+    byteLength: number;
+    byteStride: number;
+    mode: "ATTRIBUTES" | "TRIANGLES" | "INDICES";
+    count: number;
+    filter?: "NONE" | "OCTAHEDRAL" | "QUATERNION" | "EXPONENTIAL";
+}
 export interface IGalaceanMaterialRemap {
     refId: string;
     key?: string;
@@ -146,4 +154,4 @@ export interface IGalaceanAnimation {
         parameter: any;
     }[];
 }
-export type GLTFExtensionSchema = IKHRLightsPunctual_Light | IKHRDracoMeshCompression | IKHRMaterialsClearcoat | IKHRMaterialsIor | IKHRMaterialsUnlit | IKHRMaterialsPbrSpecularGlossiness | IKHRMaterialsSheen | IKHRMaterialsSpecular | IKHRMaterialsTransmission | IKHRMaterialsTranslucency | IKHRMaterialVariants_Mapping | IKHRMaterialVariants_Variants | IKHRTextureBasisU | IKHRTextureTransform | IKHRXmp | IKHRXmp_Node | IGalaceanAnimation | Object;
+export type GLTFExtensionSchema = IKHRLightsPunctual_Light | IKHRMaterialsClearcoat | IKHRMaterialsIor | IKHRMaterialsUnlit | IKHRMaterialsPbrSpecularGlossiness | IKHRMaterialsSheen | IKHRMaterialsSpecular | IKHRMaterialsTransmission | IKHRMaterialsTranslucency | IKHRMaterialVariants_Mapping | IKHRMaterialVariants_Variants | IKHRMaterialsAnisotropy | IKHRTextureBasisU | IKHRTextureTransform | IKHRXmp | IKHRXmp_Node | IGalaceanAnimation | Object;

package/types/gltf/extensions/KHR_materials_anisotropy.d.ts

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

package/types/gltf/extensions/MeshoptDecoder.d.ts

@@ -0,0 +1,8 @@
+declare const MeshoptDecoder: {
+    workerCount: number;
+    ready: Promise<void>;
+    useWorkers: () => void;
+    decodeGltfBuffer: (count: any, stride: any, source: any, mode: any, filter: any) => Promise<Uint8Array>;
+    release(): void;
+};
+export { MeshoptDecoder };

package/types/gltf/extensions/index.d.ts

@@ -1,4 +1,3 @@
-import "./KHR_draco_mesh_compression";
 import "./KHR_lights_punctual";
 import "./KHR_materials_clearcoat";
 import "./KHR_materials_ior";
@@ -14,5 +13,7 @@ import "./KHR_texture_transform";
 import "./KHR_materials_ior";
 import "./GALACEAN_materials_remap";
 import "./GALACEAN_animation_event";
+import "./EXT_meshopt_compression";
+import "./KHR_materials_anisotropy";
 export { GLTFExtensionParser, GLTFExtensionMode } from "./GLTFExtensionParser";
 export * from "./GLTFExtensionSchema";

package/types/gltf/index.d.ts

@@ -2,4 +2,5 @@ export { GLTFResource } from "./GLTFResource";
 export { GLTFUtils } from "./GLTFUtils";
 export * from "./parser";
 export * from "./extensions/index";
-export type { IMaterial, IMeshPrimitive, ITextureInfo, INode, GLTFExtensionOwnerSchema } from "./GLTFSchema";
+export { AccessorType } from "./GLTFSchema";
+export type { IMaterial, IMeshPrimitive, ITextureInfo, INode, GLTFExtensionOwnerSchema, IGLTF, IMesh } from "./GLTFSchema";

package/types/gltf/parser/GLTFBufferViewParser.d.ts

@@ -0,0 +1,5 @@
+import { GLTFParserContext } from "./GLTFParserContext";
+import { GLTFParser } from "./GLTFParser";
+export declare class GLTFBufferViewParser extends GLTFParser {
+    parse(context: GLTFParserContext, index: number): Promise<Uint8Array>;
+}

package/types/gltf/parser/GLTFParser.d.ts

@@ -17,7 +17,7 @@ export declare abstract class GLTFParser {
      */
     static executeExtensionsCreateAndParse(extensions: {
         [key: string]: any;
-    }, context: GLTFParserContext, ownerSchema: GLTFExtensionOwnerSchema, ...extra: any[]): EngineObject | void | Promise<EngineObject | void>;
+    }, context: GLTFParserContext, ownerSchema: GLTFExtensionOwnerSchema, ...extra: any[]): EngineObject | void | Promise<EngineObject | Uint8Array | void>;
     /**
      * Execute all parses of extension to parse resource.
      * @param extensions - Related extensions field

package/types/gltf/parser/GLTFParserContext.d.ts

@@ -1,5 +1,6 @@
 import { Buffer, Entity, ResourceManager, TypedArray } from "@galacean/engine-core";
 import { BufferDataRestoreInfo, GLTFContentRestorer } from "../../GLTFContentRestorer";
+import { GLTFParams } from "../../GLTFLoader";
 import { GLTFResource } from "../GLTFResource";
 import type { IGLTF } from "../GLTFSchema";
 import { GLTFParser } from "./GLTFParser";
@@ -9,7 +10,7 @@ import { GLTFParser } from "./GLTFParser";
 export declare class GLTFParserContext {
     glTFResource: GLTFResource;
     resourceManager: ResourceManager;
-    keepMeshData: boolean;
+    params: GLTFParams;
     private static readonly _parsers;
     static addParser(parserType: GLTFParserType, parser: GLTFParser): void;
     glTF: IGLTF;
@@ -17,7 +18,12 @@ export declare class GLTFParserContext {
     contentRestorer: GLTFContentRestorer;
     buffers?: ArrayBuffer[];
     private _resourceCache;
-    constructor(glTFResource: GLTFResource, resourceManager: ResourceManager, keepMeshData: boolean);
+    private _progress;
+    /** @internal */
+    _setTaskCompleteProgress: (loaded: number, total: number) => void;
+    /** @internal */
+    _setTaskDetailProgress: (url: string, loaded: number, total: number) => void;
+    constructor(glTFResource: GLTFResource, resourceManager: ResourceManager, params: GLTFParams);
     get<T>(type: GLTFParserType.Entity, index: number): Entity;
     get<T>(type: GLTFParserType.Entity): Entity[];
     get<T>(type: GLTFParserType.Schema): Promise<T>;
@@ -25,6 +31,15 @@ export declare class GLTFParserContext {
     get<T>(type: GLTFParserType, index: number): Promise<T>;
     get<T>(type: GLTFParserType): Promise<T[]>;
     parse(): Promise<GLTFResource>;
+    /**
+     * @internal
+     */
+    _onTaskDetail: (url: string, loaded: number, total: number) => void;
+    /**
+     * @internal
+     */
+    _addTaskCompletePromise(taskPromise: Promise<any>): void;
+    private _createAnimator;
     private _handleSubAsset;
 }
 /**
@@ -44,11 +59,12 @@ export declare enum GLTFParserType {
     Validator = 1,
     Scene = 2,
     Buffer = 3,
-    Texture = 4,
-    Material = 5,
-    Mesh = 6,
-    Entity = 7,
-    Skin = 8,
-    Animation = 9
+    BufferView = 4,
+    Texture = 5,
+    Material = 6,
+    Mesh = 7,
+    Entity = 8,
+    Skin = 9,
+    Animation = 10
 }
 export declare function registerGLTFParser(pipeline: GLTFParserType): (Parser: new () => GLTFParser) => void;

package/types/gltf/parser/GLTFSceneParser.d.ts

@@ -6,7 +6,6 @@ export declare class GLTFSceneParser extends GLTFParser {
     private _parseEntityComponent;
     private _createCamera;
     private _createRenderer;
-    private _createAnimator;
     private _computeLocalBounds;
     private _computeApproximateBindMatrix;
 }

package/types/gltf/parser/index.d.ts

@@ -9,4 +9,5 @@ export { GLTFSceneParser } from "./GLTFSceneParser";
 export { GLTFSkinParser } from "./GLTFSkinParser";
 export { GLTFTextureParser } from "./GLTFTextureParser";
 export { GLTFValidator } from "./GLTFValidator";
-export { GLTFParserContext, GLTFParserType, registerGLTFParser } from "./GLTFParserContext";
+export { GLTFParserContext, GLTFParserType, registerGLTFParser, BufferInfo } from "./GLTFParserContext";
+export { GLTFBufferViewParser } from "./GLTFBufferViewParser";

package/types/index.d.ts

@@ -22,6 +22,7 @@ export * from "./SceneLoader";
 export type { Texture2DParams } from "./Texture2DLoader";
 export { parseSingleKTX } from "./compressed-texture";
 export * from "./gltf";
-export { KTX2Loader } from "./ktx2/KTX2Loader";
+export { GLTFLoader } from "./GLTFLoader";
+export { KTX2Loader, KTX2Transcoder } from "./ktx2/KTX2Loader";
 export { KTX2TargetFormat } from "./ktx2/KTX2TargetFormat";
 export * from "./resource-deserialize";

package/types/ktx2/KTX2Loader.d.ts

@@ -5,11 +5,13 @@ export declare class KTX2Loader extends Loader<Texture2D | TextureCube> {
     private static _isBinomialInit;
     private static _binomialLLCTranscoder;
     private static _khronosTranscoder;
+    private static _priorityFormats;
     private static _supportedMap;
     /**
-     * Destroy ktx2 transcoder worker.
+     * Release ktx2 transcoder worker.
+     * @remarks If use loader after releasing, we should release again.
      */
-    static destroy(): void;
+    static release(): void;
     /** @internal */
     static _parseBuffer(buffer: Uint8Array, engine: Engine, params?: KTX2Params): Promise<{
         engine: Engine;
@@ -24,30 +26,40 @@ export declare class KTX2Loader extends Loader<Texture2D | TextureCube> {
     private static _getBinomialLLCTranscoder;
     private static _getKhronosTranscoder;
     private static _getEngineTextureFormat;
-    initialize(engine: Engine, configuration: EngineConfiguration): Promise<void>;
+    initialize(_: Engine, configuration: EngineConfiguration): Promise<void>;
     /**
      * @internal
      */
     load(item: LoadItem & {
         params?: KTX2Params;
     }, resourceManager: ResourceManager): AssetPromise<Texture2D | TextureCube>;
-    private _isKhronosSupported;
 }
 /**
  * KTX2 loader params interface.
  */
 export interface KTX2Params {
-    /** Priority transcoding format queue, default is ASTC/ETC/DXT/PVRTC/RGBA8. */
+    /** Priority transcoding format queue which is preferred options, default is BC7/ASTC/BC3_BC1/ETC/PVRTC/R8G8B8A8. */
+    /** @deprecated */
     priorityFormats: KTX2TargetFormat[];
 }
+/** Used for initialize KTX2 transcoder. */
+export declare enum KTX2Transcoder {
+    /** BinomialLLC transcoder. */
+    BinomialLLC = 0,
+    /** Khronos transcoder. */
+    Khronos = 1
+}
 declare module "@galacean/engine-core" {
     interface EngineConfiguration {
-        /** KTX2 loader options. */
+        /** KTX2 loader options. If set this option and workCount is great than 0, workers will be created. */
         ktx2Loader?: {
             /** Worker count for transcoder, default is 4. */
             workerCount?: number;
-            /** Pre-initialization according to the priority transcoding format queue, default is ASTC/ETC/DXT/PVRTC/RGBA8. */
-            priorityFormats?: KTX2TargetFormat[] | KTX2TargetFormat[][];
+            /** Global transcoding format queue which will be used if not specified in per-instance param, default is BC7/ASTC/BC3_BC1/ETC/PVRTC/R8G8B8A8. */
+            /** @deprecated */
+            priorityFormats?: KTX2TargetFormat[];
+            /** Used for initialize KTX2 transcoder, default is BinomialLLC. */
+            transcoder?: KTX2Transcoder;
         };
     }
 }

package/types/resource-deserialize/resources/parser/ReflectionParser.d.ts

@@ -10,7 +10,7 @@ export declare class ReflectionParser {
     parseClassObject(item: IClassObject): Promise<any>;
     parsePropsAndMethods(instance: any, item: Omit<IClassObject, "class">): Promise<any>;
     parseMethod(instance: any, methodName: string, methodParams: Array<IBasicType>): Promise<any>;
-    parseBasicType(value: IBasicType): Promise<any>;
+    parseBasicType(value: IBasicType, originValue?: any): Promise<any>;
     private _getEntityByConfig;
     private static _isClass;
     private static _isAssetRef;

package/types/resource-deserialize/resources/schema/BasicSchema.d.ts

@@ -1,3 +1,4 @@
+import { Layer } from "@galacean/engine-core";
 export interface IVector3 {
     x: number;
     y: number;
@@ -33,6 +34,7 @@ export interface IBasicEntity {
     scale?: IVector3;
     children?: Array<string>;
     parent?: string;
+    layer?: Layer;
 }
 export type IEntity = IBasicEntity | IRefEntity;
 export interface IRefEntity extends IBasicEntity {

package/types/resource-deserialize/resources/schema/MaterialSchema.d.ts

@@ -79,7 +79,7 @@ export interface IMaterialSchema {
     shader: string;
     shaderData: {
         [key: string]: {
-            type: "Vector2" | "Vector3" | "Vector4" | "Color" | "Float" | "Texture";
+            type: "Vector2" | "Vector3" | "Vector4" | "Color" | "Float" | "Texture" | "Boolean" | "Integer";
             value: IVector3 | IVector2 | IColor | number | IAssetRef;
         };
     };

package/types/resource-deserialize/resources/schema/SceneSchema.d.ts

@@ -1,6 +1,6 @@
 import { BackgroundMode, DiffuseMode, ShadowCascadesMode, ShadowResolution } from "@galacean/engine-core";
 import type { IReferable } from "@galacean/engine-core/types/asset/IReferable";
-import type { IColor, IPrefabFile } from "./BasicSchema";
+import type { IColor, IPrefabFile, IVector3 } from "./BasicSchema";
 export declare enum SpecularMode {
     Sky = "Sky",
     Custom = "Custom"
@@ -30,6 +30,8 @@ export interface IScene extends IPrefabFile {
             shadowResolution: ShadowResolution;
             shadowDistance: number;
             shadowCascades: ShadowCascadesMode;
+            shadowTwoCascadeSplits: number;
+            shadowFourCascadeSplits: IVector3;
         };
     };
     files: Array<{

package/types/resource-deserialize/utils/BufferReader.d.ts

@@ -2,7 +2,7 @@ export declare class BufferReader {
     data: Uint8Array;
     private _dataView;
     private _littleEndian;
-    private _offset;
+    private _position;
     private _baseOffset;
     constructor(data: Uint8Array, byteOffset?: number, byteLength?: number, littleEndian?: boolean);
     get position(): number;