@galacean/engine-loader 1.3.1 → 1.3.2

package/types/loader/src/MeshLoader.d.ts

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

package/types/loader/src/ProjectLoader.d.ts

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

package/types/loader/src/SceneLoader.d.ts

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

package/types/loader/src/SourceFontLoader.d.ts

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

package/types/loader/src/SpriteAtlasLoader.d.ts

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

package/types/loader/src/SpriteLoader.d.ts

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

package/types/loader/src/TextLoader.d.ts

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

package/types/loader/src/Texture2DContentRestorer.d.ts

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

package/types/loader/src/Texture2DLoader.d.ts

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

package/types/loader/src/TextureCubeContentRestorer.d.ts

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

package/types/loader/src/TextureCubeLoader.d.ts

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

package/types/loader/src/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/loader/src/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/loader/src/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/loader/src/gltf/GLTFResource.d.ts

@@ -0,0 +1,65 @@
+import { AnimationClip, Camera, Engine, Entity, Light, Material, ModelMesh, ReferResource, Skin, Texture2D } from "@galacean/engine-core";
+/**
+ * Product after glTF parser, usually, `defaultSceneRoot` is only needed to use.
+ */
+export declare class GLTFResource extends ReferResource {
+    /** glTF file url. */
+    readonly url: string;
+    /** Texture2D after TextureParser. */
+    readonly textures?: Texture2D[];
+    /** Material after MaterialParser. */
+    readonly materials?: Material[];
+    /** ModelMesh after MeshParser. */
+    readonly meshes?: ModelMesh[][];
+    /** Skin after SkinParser. */
+    readonly skins?: Skin[];
+    /** AnimationClip after AnimationParser. */
+    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[];
+    /**
+     * @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;
+}