@galacean/engine-loader 1.1.0-beta.8 → 1.2.0-alpha.0

package/package.json

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

package/types/GLTFLoader.d.ts

@@ -12,4 +12,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/extensions/GLTFExtensionSchema.d.ts

@@ -105,6 +105,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>;
 }
@@ -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 | IKHRDracoMeshCompression | 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/index.d.ts

@@ -14,5 +14,6 @@ import "./KHR_texture_transform";
 import "./KHR_materials_ior";
 import "./GALACEAN_materials_remap";
 import "./GALACEAN_animation_event";
+import "./KHR_materials_anisotropy";
 export { GLTFExtensionParser, GLTFExtensionMode } from "./GLTFExtensionParser";
 export * from "./GLTFExtensionSchema";

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

@@ -0,0 +1,7 @@
+import { IGLTF } from "../GLTFSchema";
+import { GLTFParser } from "./GLTFParser";
+import { GLTFParserContext } from "./GLTFParserContext";
+export declare class GLTFJSONParser extends GLTFParser {
+    parse(context: GLTFParserContext): Promise<IGLTF>;
+    private _isGLB;
+}

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;
 }
 /**

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/index.d.ts

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

package/types/ktx2/KTX2Loader.d.ts

@@ -5,6 +5,7 @@ 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.
@@ -24,30 +25,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. */
         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/ktx2/transcoder/AbstractTranscoder.d.ts

@@ -20,7 +20,7 @@ export interface InitMessage extends BaseMessage {
 export interface BinomialTranscodeMessage extends BaseMessage {
     type: "transcode";
     format: number;
-    buffer: ArrayBuffer;
+    buffer: Uint8Array;
 }
 export type IBinomialMessage = InitMessage | BinomialTranscodeMessage;
 export type TranscodeResult = {

package/types/ktx2/transcoder/BinomialLLCTranscoder.d.ts

@@ -4,5 +4,5 @@ import { AbstractTranscoder, TranscodeResult } from "./AbstractTranscoder";
 export declare class BinomialLLCTranscoder extends AbstractTranscoder {
     constructor(workerLimitCount: number);
     _initTranscodeWorkerPool(): Promise<any>;
-    transcode(buffer: ArrayBuffer, format: KTX2TargetFormat): Promise<TranscodeResult>;
+    transcode(buffer: Uint8Array, format: KTX2TargetFormat): Promise<TranscodeResult>;
 }

package/types/ktx2/transcoder/BinomialLLCWorkerCode.d.ts

@@ -3,4 +3,4 @@ import { TranscodeResult } from "./AbstractTranscoder";
 export declare function TranscodeWorkerCode(): void;
 export declare const _init: () => (wasmBinary?: ArrayBuffer) => any;
 export declare const init: (wasmBinary?: ArrayBuffer) => any;
-export declare function transcode(buffer: ArrayBuffer, targetFormat: any, KTX2File: any): TranscodeResult;
+export declare function transcode(buffer: Uint8Array, targetFormat: any, KTX2File: any): TranscodeResult;

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/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;

package/types/ktx2/BinomialLLCTranscoder/BinomialLLCTranscoder.d.ts

@@ -1,13 +0,0 @@
-import { KTX2TargetFormat } from "../KTX2TargetFormat";
-import { TranscodeResult } from "../TranscodeResult";
-/** @internal */
-export declare class BinomialLLCTranscoder {
-    readonly workerLimit: number;
-    static MessageId: number;
-    private _transcodeWorkerPool;
-    private _initPromise;
-    constructor(workerLimit: number);
-    init(): Promise<any>;
-    transcode(buffer: ArrayBuffer, format: KTX2TargetFormat): Promise<TranscodeResult>;
-    destroy(): void;
-}

package/types/ktx2/BinomialLLCTranscoder/TranscodeWorkerCode.d.ts

@@ -1,33 +0,0 @@
-type MessageType = "init" | "transcode";
-export interface IBaseMessage {
-    type: MessageType;
-}
-export interface IInitMessage extends IBaseMessage {
-    type: "init";
-    transcoderWasm: ArrayBuffer;
-}
-export interface ITranscodeMessage extends IBaseMessage {
-    type: "transcode";
-    format: number;
-    buffer: ArrayBuffer;
-}
-export type IMessage = IInitMessage | ITranscodeMessage;
-export type TranscodeResult = {
-    width: number;
-    height: number;
-    hasAlpha: boolean;
-    format: number;
-    faces: Array<{
-        data: Uint8Array;
-        width: number;
-        height: number;
-    }>[];
-    faceCount: number;
-};
-export type TranscodeResponse = {
-    id: number;
-    type: "transcoded";
-} & TranscodeResult;
-/** @internal */
-export declare function TranscodeWorkerCode(): void;
-export {};

package/types/ktx2/KhronosTranscoder/KhronosTranscoder.d.ts

@@ -1,17 +0,0 @@
-import { KTX2Container } from "../KTX2Container";
-import { KTX2TargetFormat } from "../KTX2TargetFormat";
-import { TranscodeResult } from "./TranscoderWorkerCode";
-/** @internal */
-export declare class KhronosTranscoder {
-    readonly workerLimit: number;
-    readonly type: KTX2TargetFormat;
-    static transcoderMap: {
-        0: string;
-    };
-    private _transcodeWorkerPool;
-    private _initPromise;
-    constructor(workerLimit: number, type: KTX2TargetFormat);
-    init(): Promise<any>;
-    transcode(ktx2Container: KTX2Container): Promise<TranscodeResult>;
-    destroy(): void;
-}

package/types/ktx2/KhronosTranscoder/TranscoderWorkerCode.d.ts

@@ -1,34 +0,0 @@
-export interface EncodedData {
-    buffer: Uint8Array;
-    levelWidth: number;
-    levelHeight: number;
-    uncompressedByteLength: number;
-}
-type MessageType = "init" | "transcode";
-export interface IBaseMessage {
-    type: MessageType;
-}
-export interface IInitMessage extends IBaseMessage {
-    type: "init";
-    transcoderWasm: ArrayBuffer;
-}
-export interface ITranscodeMessage extends IBaseMessage {
-    type: "transcode";
-    format: number;
-    needZstd: boolean;
-    data: EncodedData[][];
-}
-export type IMessage = IInitMessage | ITranscodeMessage;
-export type TranscodeResult = {
-    data: Array<{
-        data: Uint8Array;
-        width: number;
-        height: number;
-    }>;
-};
-export type TranscodeResponse = {
-    id: number;
-    type: "transcoded";
-} & TranscodeResult;
-export declare function TranscodeWorkerCode(): void;
-export {};

package/types/ktx2/TranscodeResult.d.ts

@@ -1,10 +0,0 @@
-export interface TranscodeResult {
-    width: number;
-    height: number;
-    hasAlpha: boolean;
-    mipmaps: Array<{
-        data: Uint8Array;
-        width: number;
-        height: number;
-    }>;
-}

package/types/ktx2/constants.d.ts

@@ -1,7 +0,0 @@
-export declare enum SupercompressionScheme {
-    None = 0,
-    BasisLZ = 1,
-    Zstd = 2,
-    ZLib = 3
-}
-export declare const KHR_DF_SAMPLE_DATATYPE_SIGNED = 64;

package/types/ktx2/zstddec.d.ts

@@ -1,62 +0,0 @@
-/**
- * From https://github.com/donmccurdy/zstddec by Don McCurdy
- */
-interface DecoderExports {
-    memory: Uint8Array;
-    ZSTD_findDecompressedSize: (compressedPtr: number, compressedSize: number) => number;
-    ZSTD_decompress: (uncompressedPtr: number, uncompressedSize: number, compressedPtr: number, compressedSize: number) => number;
-    malloc: (ptr: number) => number;
-    free: (ptr: number) => void;
-}
-/**
- * ZSTD (Zstandard) decoder.
- */
-export declare class ZSTDDecoder {
-    static heap: Uint8Array;
-    static IMPORT_OBJECT: {
-        env: {
-            emscripten_notify_memory_growth: () => void;
-        };
-    };
-    static instance: {
-        exports: DecoderExports;
-    };
-    static WasmModuleURL: string;
-    _initPromise: Promise<any>;
-    init(): Promise<void>;
-    _init(result: WebAssembly.WebAssemblyInstantiatedSource): void;
-    decode(array: Uint8Array, uncompressedSize?: number): Uint8Array;
-}
-export {};
-/**
- * BSD License
- *
- * For Zstandard software
- *
- * Copyright (c) 2016-present, Yann Collet, Facebook, Inc. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modification,
- * are permitted provided that the following conditions are met:
- *
- *  * Redistributions of source code must retain the above copyright notice, this
- *    list of conditions and the following disclaimer.
- *
- *  * Redistributions in binary form must reproduce the above copyright notice,
- *    this list of conditions and the following disclaimer in the documentation
- *    and/or other materials provided with the distribution.
- *
- *  * Neither the name Facebook nor the names of its contributors may be used to
- *    endorse or promote products derived from this software without specific
- *    prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
- * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
- * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
- * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
- * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
- * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */