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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-loader",
-  "version": "1.2.0-alpha.0",
+  "version": "1.2.0-alpha.1",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -15,10 +15,9 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@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"
+    "@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>;
 }
 /**

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
  */
@@ -142,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;
@@ -154,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 | IKHRMaterialsAnisotropy | 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/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,6 +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

@@ -59,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/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 { GLTFLoader } from "./GLTFLoader";
 export { KTX2Loader, KTX2Transcoder } from "./ktx2/KTX2Loader";
 export { KTX2TargetFormat } from "./ktx2/KTX2TargetFormat";
 export * from "./resource-deserialize";

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

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,33 @@
+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/KTX2Loader.d.ts

@@ -8,9 +8,10 @@ export declare class KTX2Loader extends Loader<Texture2D | TextureCube> {
     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;
@@ -50,7 +51,7 @@ export declare enum KTX2Transcoder {
 }
 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;

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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,34 @@
+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

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

package/types/ktx2/constants.d.ts

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,62 @@
+/**
+ * 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.
+ */

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/gltf/parser/GLTFJSONParser.d.ts

@@ -1,7 +0,0 @@
-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;
-}