@galacean/engine-loader 1.0.0 → 1.1.0-alpha.0

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

@@ -0,0 +1,61 @@
+export interface IVector3 {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface IVector2 {
+    x: number;
+    y: number;
+}
+export interface IVector4 {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}
+export interface IColor {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+export interface IPrefabFile {
+    entities: Array<IEntity>;
+}
+export type IMethodParams = Array<IBasicType>;
+export type IClassObject = {
+    class: string;
+    constructParams?: IMethodParams;
+    methods?: {
+        [methodName: string]: Array<IMethodParams>;
+    };
+    props?: {
+        [key: string]: IBasicType | IMethodParams;
+    };
+};
+export type IBasicType = string | number | boolean | null | undefined | IAssetRef | IClassObject | IMethodParams;
+export type IAssetRef = {
+    key?: string;
+    refId: string;
+};
+export interface IBasicEntity {
+    name?: string;
+    id?: string;
+    components?: Array<IComponent>;
+    isActive?: boolean;
+    position?: IVector3;
+    rotation?: IVector3;
+    scale?: IVector3;
+    children?: Array<string>;
+    parent?: string;
+}
+export type IEntity = IBasicEntity | IRefEntity;
+export interface IRefEntity extends IBasicEntity {
+    assetRefId: string;
+    key?: string;
+    isClone?: boolean;
+}
+export type IComponent = {
+    id: string;
+    refId?: string;
+} & IClassObject;

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

@@ -0,0 +1,91 @@
+import { BlendFactor, BlendOperation, ColorWriteMask, CompareFunction, CullMode, RenderQueueType, StencilOperation } from "@galacean/engine-core";
+import type { IAssetRef, IColor, IVector2, IVector3 } from "./BasicSchema";
+export interface IRenderState {
+    /** Blend state. */
+    blendState: {
+        /** The blend state of the render target. */
+        targetBlendState: {
+            /** Whether to enable blend. */
+            enabled: boolean;
+            /** color (RGB) blend operation. */
+            colorBlendOperation: BlendOperation;
+            /** alpha (A) blend operation. */
+            alphaBlendOperation: BlendOperation;
+            /** color blend factor (RGB) for source. */
+            sourceColorBlendFactor: BlendFactor;
+            /** alpha blend factor (A) for source. */
+            sourceAlphaBlendFactor: BlendFactor;
+            /** color blend factor (RGB) for destination. */
+            destinationColorBlendFactor: BlendFactor;
+            /** alpha blend factor (A) for destination. */
+            destinationAlphaBlendFactor: BlendFactor;
+            /** color mask. */
+            colorWriteMask: ColorWriteMask;
+        };
+        blendColor: IColor;
+        /** Whether to use (Alpha-to-Coverage) technology. */
+        alphaToCoverage: boolean;
+    };
+    /** Depth state. */
+    depthState: {
+        /** Whether to enable the depth test. */
+        enabled: boolean;
+        /** Whether the depth value can be written.*/
+        writeEnabled: boolean;
+        /** Depth comparison function. */
+        compareFunction: CompareFunction;
+    };
+    /** Stencil state. */
+    stencilState: {
+        /** Whether to enable stencil test. */
+        enabled: boolean;
+        /** Write the reference value of the stencil buffer. */
+        referenceValue: number;
+        /** Specifying a bit-wise mask that is used to AND the reference value and the stored stencil value when the test is done. */
+        mask: number;
+        /** Specifying a bit mask to enable or disable writing of individual bits in the stencil planes. */
+        writeMask: number;
+        /** The comparison function of the reference value of the front face of the geometry and the current buffer storage value. */
+        compareFunctionFront: CompareFunction;
+        /** The comparison function of the reference value of the back of the geometry and the current buffer storage value. */
+        compareFunctionBack: CompareFunction;
+        /** specifying the function to use for front face when both the stencil test and the depth test pass. */
+        passOperationFront: StencilOperation;
+        /** specifying the function to use for back face when both the stencil test and the depth test pass. */
+        passOperationBack: StencilOperation;
+        /** specifying the function to use for front face when the stencil test fails. */
+        failOperationFront: StencilOperation;
+        /** specifying the function to use for back face when the stencil test fails. */
+        failOperationBack: StencilOperation;
+        /** specifying the function to use for front face when the stencil test passes, but the depth test fails. */
+        zFailOperationFront: StencilOperation;
+        /** specifying the function to use for back face when the stencil test passes, but the depth test fails. */
+        zFailOperationBack: StencilOperation;
+    };
+    /** Raster state. */
+    rasterState: {
+        /** Specifies whether or not front- and/or back-facing polygons can be culled. */
+        cullMode: CullMode;
+        /** The multiplier by which an implementation-specific value is multiplied with to create a constant depth offset. */
+        depthBias: number;
+        /** The scale factor for the variable depth offset for each polygon. */
+        slopeScaledDepthBias: number;
+    };
+    /** Render queue type. */
+    renderQueueType: RenderQueueType;
+}
+export interface IMaterialSchema {
+    name: string;
+    shader: string;
+    shaderData: {
+        [key: string]: {
+            type: "Vector2" | "Vector3" | "Vector4" | "Color" | "Float" | "Texture";
+            value: IVector3 | IVector2 | IColor | number | IAssetRef;
+        };
+    };
+    macros: Array<{
+        name: string;
+        value?: string;
+    }>;
+    renderState: IRenderState;
+}

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

@@ -0,0 +1,41 @@
+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";
+export declare enum SpecularMode {
+    Sky = "Sky",
+    Custom = "Custom"
+}
+export interface IScene extends IPrefabFile {
+    scene: {
+        background: {
+            mode: BackgroundMode;
+            color: IColor;
+            texture?: IReferable;
+            skyMesh?: IReferable;
+            skyMaterial?: IReferable;
+        };
+        ambient: {
+            diffuseMode: DiffuseMode;
+            ambientLight: IReferable;
+            customAmbientLight: IReferable;
+            customSpecularTexture: IReferable;
+            diffuseSolidColor: IColor;
+            diffuseIntensity: number;
+            specularIntensity: number;
+            specularMode: SpecularMode;
+            bakerResolution: number;
+        };
+        shadow?: {
+            castShadows: boolean;
+            shadowResolution: ShadowResolution;
+            shadowDistance: number;
+            shadowCascades: ShadowCascadesMode;
+        };
+    };
+    files: Array<{
+        id: string;
+        type: string;
+        virtualPath: string;
+        path: string;
+    }>;
+}

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

@@ -0,0 +1,3 @@
+export * from "./BasicSchema";
+export * from "./MaterialSchema";
+export * from "./SceneSchema";