@galacean/engine-loader 1.6.8 → 1.6.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-loader",
-  "version": "1.6.8",
+  "version": "1.6.9",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -19,9 +19,9 @@
     "libs/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-core": "1.6.8",
-    "@galacean/engine-math": "1.6.8",
-    "@galacean/engine-rhi-webgl": "1.6.8"
+    "@galacean/engine-core": "1.6.9",
+    "@galacean/engine-math": "1.6.9",
+    "@galacean/engine-rhi-webgl": "1.6.9"
   },
   "scripts": {
     "b:types": "tsc"

package/types/AnimationClipLoader.d.ts

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

package/types/AnimatorControllerLoader.d.ts

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

package/types/AudioLoader.d.ts

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

package/types/BufferLoader.d.ts

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

package/types/EnvLoader.d.ts

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

package/types/FontLoader.d.ts

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

package/types/GLTFContentRestorer.d.ts

@@ -0,0 +1,92 @@
+import { AssetPromise, BlendShape, Buffer, ContentRestorer, ModelMesh, RequestConfig, Texture2D } from "@galacean/engine-core";
+import { Vector2 } from "@galacean/engine-math";
+import { GLTFResource } from "./gltf/GLTFResource";
+import type { AccessorComponentType, IBufferView } from "./gltf/GLTFSchema";
+/**
+ * @internal
+ */
+export declare class GLTFContentRestorer extends ContentRestorer<GLTFResource> {
+    isGLB: boolean;
+    bufferRequests: BufferRequestInfo[];
+    glbBufferSlices: Vector2[];
+    bufferTextures: BufferTextureRestoreInfo[];
+    meshes: ModelMeshRestoreInfo[];
+    restoreContent(): AssetPromise<GLTFResource>;
+    private _getBufferData;
+}
+/**
+ * @internal
+ */
+export declare class BufferRequestInfo {
+    url: string;
+    config: RequestConfig;
+    constructor(url: string, config: RequestConfig);
+}
+/**
+ * @internal
+ */
+export declare class BufferTextureRestoreInfo {
+    texture: Texture2D;
+    bufferView: IBufferView;
+    mimeType: string;
+    constructor(texture: Texture2D, bufferView: IBufferView, mimeType: string);
+}
+/**
+ * @internal
+ */
+export declare class ModelMeshRestoreInfo {
+    mesh: ModelMesh;
+    vertexBuffers: BufferRestoreInfo[];
+    indexBuffer: BufferDataRestoreInfo;
+    blendShapes: BlendShapeRestoreInfo[];
+}
+/**
+ * @internal
+ */
+export declare class BufferRestoreInfo {
+    buffer: Buffer;
+    data: BufferDataRestoreInfo;
+    constructor(buffer: Buffer, data: BufferDataRestoreInfo);
+}
+/**
+ * @internal
+ */
+export declare class BufferDataRestoreInfo {
+    main: RestoreDataAccessor;
+    typeSize?: number;
+    sparseCount?: number;
+    sparseIndices?: RestoreDataAccessor;
+    sparseValues?: RestoreDataAccessor;
+    constructor(main: RestoreDataAccessor, typeSize?: number, sparseCount?: number, sparseIndices?: RestoreDataAccessor, sparseValues?: RestoreDataAccessor);
+}
+/**
+ * @internal
+ */
+export declare class RestoreDataAccessor {
+    bufferIndex: number;
+    TypedArray: Uint8ArrayConstructor | Int8ArrayConstructor | Int16ArrayConstructor | Uint16ArrayConstructor | Uint32ArrayConstructor | Float32ArrayConstructor;
+    byteOffset: number;
+    length: number;
+    constructor(bufferIndex: number, TypedArray: Uint8ArrayConstructor | Int8ArrayConstructor | Int16ArrayConstructor | Uint16ArrayConstructor | Uint32ArrayConstructor | Float32ArrayConstructor, byteOffset: number, length: number);
+}
+/**
+ * @internal
+ */
+export declare class BlendShapeRestoreInfo {
+    blendShape: BlendShape;
+    position: BlendShapeDataRestoreInfo;
+    normal?: BlendShapeDataRestoreInfo;
+    tangent?: BlendShapeDataRestoreInfo;
+    constructor(blendShape: BlendShape, position: BlendShapeDataRestoreInfo, normal?: BlendShapeDataRestoreInfo, tangent?: BlendShapeDataRestoreInfo);
+}
+/**
+ * @internal
+ */
+export declare class BlendShapeDataRestoreInfo {
+    buffer: BufferDataRestoreInfo;
+    byteOffset: number;
+    count: number;
+    normalized: boolean;
+    componentType: AccessorComponentType;
+    constructor(buffer: BufferDataRestoreInfo, byteOffset: number, count: number, normalized: boolean, componentType: AccessorComponentType);
+}

package/types/GLTFLoader.d.ts

@@ -0,0 +1,22 @@
+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>;
+}
+/**
+ * GlTF loader params.
+ */
+export interface GLTFParams {
+    /**
+     * @beta Now only contains vertex information, need to improve.
+     * Keep raw mesh data for glTF parser, default is false.
+     */
+    keepMeshData?: boolean;
+    [key: string]: any;
+}

package/types/HDRLoader.d.ts

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

package/types/JSONLoader.d.ts

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

package/types/KTXCubeLoader.d.ts

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

package/types/KTXLoader.d.ts

@@ -0,0 +1,4 @@
+import { AssetPromise, Loader, LoadItem, ResourceManager, Texture2D } from "@galacean/engine-core";
+export declare class KTXLoader extends Loader<Texture2D> {
+    load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<Texture2D>;
+}

package/types/MaterialLoader.d.ts

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

package/types/MeshLoader.d.ts

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

package/types/PhysicsMaterialLoader.d.ts

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

package/types/PrefabLoader.d.ts

@@ -0,0 +1,5 @@
+import { AssetPromise, Loader, LoadItem, ResourceManager } from "@galacean/engine-core";
+import { PrefabResource } from "./prefab/PrefabResource";
+export declare class PrefabLoader extends Loader<PrefabResource> {
+    load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<PrefabResource>;
+}

package/types/PrimitiveMeshLoader.d.ts

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

package/types/ProjectLoader.d.ts

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

package/types/SceneLoader.d.ts

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

package/types/ShaderChunkLoader.d.ts

@@ -0,0 +1,9 @@
+import { AssetPromise, LoadItem, Loader, ResourceManager } from "@galacean/engine-core";
+export declare class ShaderChunkLoader extends Loader<void[]> {
+    private static _shaderIncludeRegex;
+    /**
+     * @internal
+     */
+    static _loadChunksInCode(code: string, basePath: string, resourceManager: ResourceManager): Promise<void[]>;
+    load(item: LoadItem, resourceManager: ResourceManager): AssetPromise<void[]>;
+}

package/types/ShaderLoader.d.ts

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

package/types/SourceFontLoader.d.ts

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

package/types/SpriteAtlasLoader.d.ts

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

package/types/SpriteLoader.d.ts

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

package/types/TextLoader.d.ts

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

package/types/Texture2DContentRestorer.d.ts

@@ -0,0 +1,10 @@
+import { AssetPromise, ContentRestorer, RequestConfig, Texture2D } from "@galacean/engine-core";
+/**
+ * @internal
+ */
+export declare class Texture2DContentRestorer extends ContentRestorer<Texture2D> {
+    url: string;
+    requestConfig: RequestConfig;
+    constructor(resource: Texture2D, url: string, requestConfig: RequestConfig);
+    restoreContent(): AssetPromise<Texture2D>;
+}

package/types/Texture2DLoader.d.ts

@@ -0,0 +1,20 @@
+import { TextureFilterMode, TextureFormat, TextureWrapMode } from "@galacean/engine-core";
+/**
+ * Texture2D loader params interface.
+ */
+export interface Texture2DParams {
+    /** Texture format. default  `TextureFormat.R8G8B8A8` */
+    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;
+    /** Whether the texture data is in sRGB color space, otherwise is linear color space. @defaultValue `true` */
+    isSRGBColorSpace: boolean;
+}

package/types/TextureCubeContentRestorer.d.ts

@@ -0,0 +1,10 @@
+import { AssetPromise, ContentRestorer, RequestConfig, TextureCube } from "@galacean/engine-core";
+/**
+ * @internal
+ */
+export declare class TextureCubeContentRestorer extends ContentRestorer<TextureCube> {
+    urls: string[];
+    requestConfig: RequestConfig;
+    constructor(resource: TextureCube, urls: string[], requestConfig: RequestConfig);
+    restoreContent(): AssetPromise<TextureCube>;
+}

package/types/TextureCubeLoader.d.ts

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

package/types/compressed-texture/KhronosTextureContainer.d.ts

@@ -0,0 +1,20 @@
+/**
+ *
+ * ported from https://github.com/BabylonJS/Babylon.js/blob/master/src/Tools/babylon.khronosTextureContainer.ts
+ */
+import { KTXContainer } from "./type";
+/**
+ * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
+ * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
+ */
+export declare const khronosTextureContainerParser: {
+    /**
+     *
+     * @param buffer contents of the KTX container file
+     * @param facesExpected should be either 1 or 6, based whether a cube texture or or
+     * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
+     * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
+     * @param mapEngineFormat get Galacean Engine native TextureFormat?
+     */
+    parse(buffer: ArrayBuffer, facesExpected: number, withMipmaps: boolean, mapEngineFormat?: boolean): KTXContainer;
+};

package/types/compressed-texture/index.d.ts

@@ -0,0 +1,3 @@
+import { CompressedTextureData, CompressedCubeData } from "./type";
+export declare function parseSingleKTX(data: ArrayBuffer): CompressedTextureData;
+export declare function parseCubeKTX(dataArray: ArrayBuffer[]): CompressedCubeData;

package/types/compressed-texture/type.d.ts

@@ -0,0 +1,87 @@
+import { TextureFormat } from "@galacean/engine-core";
+import { GLCompressedTextureInternalFormat } from "@galacean/engine-rhi-webgl";
+export type CompressedTextureData = {
+    internalFormat: GLCompressedTextureInternalFormat;
+    width: number;
+    height: number;
+    mipmaps: Mipmap[];
+    engineFormat: TextureFormat;
+};
+export type CompressedCubeData = {
+    engineFormat: TextureFormat;
+    internalFormat: number;
+    width: number;
+    height: number;
+    mipmapsFaces: Mipmap[][];
+};
+export type Mipmap = {
+    data: ArrayBufferView;
+    width: number;
+    height: number;
+};
+export type KTXContainer = {
+    /**
+     * origin buffer data
+     */
+    buffer: ArrayBuffer;
+    /**
+     * Gets the openGL type
+     */
+    glType: number;
+    /**
+     * Gets the openGL type size
+     */
+    glTypeSize: number;
+    /**
+     * Gets the openGL format
+     */
+    glFormat: number;
+    /**
+     * Gets the openGL internal format
+     */
+    glInternalFormat: number;
+    /**
+     * Gets the base internal format
+     */
+    glBaseInternalFormat: GLCompressedTextureInternalFormat;
+    /**
+     * Gets image width in pixel
+     */
+    pixelWidth: number;
+    /**
+     * Gets image height in pixel
+     */
+    pixelHeight: number;
+    /**
+     * Gets image depth in pixels
+     */
+    pixelDepth: number;
+    /**
+     * Gets the number of array elements
+     */
+    numberOfArrayElements: number;
+    /**
+     * Gets the number of faces
+     */
+    numberOfFaces: number;
+    /**
+     * Gets the number of mipmap levels
+     */
+    numberOfMipmapLevels: number;
+    /**
+     * Gets the bytes of key value data
+     */
+    bytesOfKeyValueData: number;
+    /**
+     * Gets the load type
+     */
+    loadType: number;
+    /**
+     * parsed mipmap data
+     */
+    mipmaps?: Mipmap[];
+    /**
+     * Galacean Engine native TextureFormat
+     */
+    engineFormat?: TextureFormat;
+};

package/types/gltf/GLTFResource.d.ts

@@ -0,0 +1,67 @@
+import { AnimationClip, AnimatorController, Camera, Engine, Entity, Light, Material, ModelMesh, ReferResource, Skin, Texture2D } from "@galacean/engine-core";
+/**
+ * The glTF resource.
+ */
+export declare class GLTFResource extends ReferResource {
+    /** glTF file url. */
+    readonly url: string;
+    /** The array of loaded textures. */
+    readonly textures?: Texture2D[];
+    /** The array of loaded materials. */
+    readonly materials?: Material[];
+    /** The array of loaded Meshes. */
+    readonly meshes?: ModelMesh[][];
+    /** The array of loaded skins. */
+    readonly skins?: Skin[];
+    /** The array of loaded animationClips. */
+    readonly animations?: AnimationClip[];
+    /** The loaded  AnimatorController. */
+    readonly animatorController?: AnimatorController;
+    /** @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[];
+    /**
+     * @deprecated
+     * Camera after SceneParser.
+     */
+    cameras?: Camera[];
+    /**
+     * @deprecated
+     * Export lights in extension KHR_lights_punctual.
+     */
+    lights?: Light[];
+    /**
+     * @deprecated Please use `instantiateSceneRoot` instead.
+     * RootEntities after SceneParser.
+     */
+    get sceneRoots(): Entity[];
+    /**
+     * @deprecated Please use `instantiateSceneRoot` instead.
+     * RootEntity after SceneParser.
+     */
+    get defaultSceneRoot(): Entity;
+}