@galacean/engine-core 2.0.0-alpha.30 → 2.0.0-alpha.31

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "2.0.0-alpha.30",
+  "version": "2.0.0-alpha.31",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -18,10 +18,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "2.0.0-alpha.30"
+    "@galacean/engine-math": "2.0.0-alpha.31"
   },
   "devDependencies": {
-    "@galacean/engine-design": "2.0.0-alpha.30"
+    "@galacean/engine-design": "2.0.0-alpha.31"
   },
   "scripts": {
     "b:types": "tsc"

package/types/Engine.d.ts

@@ -1,4 +1,4 @@
-import { IHardwareRenderer, IInputOptions, IPhysics, IShaderLab, IXRDevice } from "@galacean/engine-design";
+import { IHardwareRenderer, IInputOptions, IPhysics, IShaderCompiler, IXRDevice } from "@galacean/engine-design";
 import { Canvas } from "./Canvas";
 import { EngineSettings } from "./EngineSettings";
 import { Entity } from "./Entity";
@@ -148,8 +148,8 @@ export interface EngineConfiguration {
     physics?: IPhysics;
     /** XR Device. */
     xrDevice?: IXRDevice;
-    /** Shader lab. */
-    shaderLab?: IShaderLab;
+    /** Shader compiler. */
+    shaderCompiler?: IShaderCompiler;
     /** Input options. */
     input?: IInputOptions;
 }

package/types/index.d.ts

@@ -54,7 +54,6 @@ export * from "./material/index";
 export * from "./texture/index";
 export * from "./graphic/index";
 export * from "./2d/index";
-export * from "./shaderlib/index";
 export * from "./animation/index";
 export * from "./mesh/index";
 export * from "./sky/index";
@@ -69,6 +68,7 @@ export * from "./renderingHardwareInterface/index";
 export * from "./physics/index";
 export * from "./Utils";
 export * from "./audio/index";
+export { Polyfill } from "./Polyfill";
 export { ShaderMacroCollection } from "./shader/ShaderMacroCollection";
 export * from "./postProcess";
 export { AntiAliasing } from "./enums/AntiAliasing";

package/types/material/BaseMaterial.d.ts

@@ -18,14 +18,17 @@ export declare class BaseMaterial extends Material {
     protected static _emissiveTextureProp: ShaderProperty;
     protected static _alphaCutoffProp: ShaderProperty;
     private static _alphaCutoffMacro;
+    private static _blendEnabledProp;
+    private static _depthWriteEnabledProp;
+    private static _renderQueueTypeProp;
+    private static _sourceColorBlendFactorProp;
+    private static _destinationColorBlendFactorProp;
+    private static _sourceAlphaBlendFactorProp;
+    private static _destinationAlphaBlendFactorProp;
+    private static _rasterStateCullModeProp;
     private _renderFace;
     protected _isTransparent: boolean;
     private _blendMode;
-    /**
-     * Shader used by the material.
-     */
-    get shader(): Shader;
-    set shader(value: Shader);
     /**
      * Whether transparent of first shader pass render state.
      */
@@ -58,22 +61,19 @@ export declare class BaseMaterial extends Material {
     constructor(engine: Engine, shader: Shader);
     /**
      * Set if is transparent of the shader pass render state.
-     * @param passIndex - Shader pass index
      * @param isTransparent - If is transparent
      */
-    setIsTransparent(passIndex: number, isTransparent: boolean): void;
+    setIsTransparent(isTransparent: boolean): void;
     /**
      * Set the blend mode of shader pass render state.
-     * @param passIndex - Shader pass index
      * @param blendMode - Blend mode
      */
-    setBlendMode(passIndex: number, blendMode: BlendMode): void;
+    setBlendMode(blendMode: BlendMode): void;
     /**
      * Set the render face of shader pass render state.
-     * @param passIndex - Shader pass index
      * @param renderFace - Render face
      */
-    setRenderFace(passIndex: number, renderFace: RenderFace): void;
+    setRenderFace(renderFace: RenderFace): void;
     /**
      * Clone and return the instance.
      */

package/types/material/Material.d.ts

@@ -3,7 +3,6 @@ import { Engine } from "../Engine";
 import { ReferResource } from "../asset/ReferResource";
 import { Shader } from "../shader/Shader";
 import { ShaderData } from "../shader/ShaderData";
-import { RenderState } from "../shader/state/RenderState";
 /**
  * Material.
  */
@@ -20,14 +19,6 @@ export declare class Material extends ReferResource implements IClone {
      */
     get shader(): Shader;
     set shader(value: Shader);
-    /**
-     * First Render state.
-     */
-    get renderState(): RenderState;
-    /**
-     * Render states.
-     */
-    get renderStates(): Readonly<RenderState[]>;
     /**
      * Create a material instance.
      * @param engine - Engine to which the material belongs

package/types/postProcess/PostProcessUberPass.d.ts

@@ -4,7 +4,7 @@ import { RenderTarget, Texture2D } from "../texture";
 import { PostProcessManager } from "./PostProcessManager";
 import { PostProcessPass } from "./PostProcessPass";
 export declare class PostProcessUberPass extends PostProcessPass {
-    static readonly UBER_SHADER_NAME = "UberPost";
+    static readonly UBER_SHADER_NAME = "PostProcess/Uber";
     private _uberMaterial;
     private _bloomMaterial;
     private _mipDownRT;

package/types/postProcess/effects/BloomEffect.d.ts

@@ -10,7 +10,7 @@ export declare enum BloomDownScaleMode {
     Quarter = 1
 }
 export declare class BloomEffect extends PostProcessEffect {
-    static readonly SHADER_NAME = "PostProcessEffect Bloom";
+    static readonly SHADER_NAME = "PostProcess/Bloom";
     /**
      * Controls whether to use bicubic sampling instead of bilinear sampling for the upSampling passes.
      * @remarks This is slightly more expensive but helps getting smoother visuals.

package/types/shader/Shader.d.ts

@@ -16,32 +16,24 @@ export declare class Shader implements IReferable {
      *
      * @remarks
      *
-     * ShaderLab must be enabled first as follows:
+     * The shader compiler must be enabled first as follows:
      * ```ts
-     * // Import shaderLab
-     * import { ShaderLab } from "@galacean/engine-shaderlab";
-     * // Create engine with shaderLab
-     * const engine = await WebGLEngine.create({ canvas: "canvas", shader: new ShaderLab() });
+     * // Import the shader compiler
+     * import { ShaderCompiler } from "@galacean/engine-shader-compiler";
+     * // Create engine with the shader compiler
+     * const engine = await WebGLEngine.create({ canvas: "canvas", shaderCompiler: new ShaderCompiler() });
      * ...
      * ```
      *
      * @param shaderSource - Shader code
      * @param platformTarget - Shader platform target, @defaultValue ShaderLanguage.GLSLES300
-     * @param path - Shader location path
+     * @param path - Shader location path, used to resolve relative `#include` paths in ShaderLab source
      * @returns Shader
      *
      * @throws
-     * Throw string exception if shaderLab has not been enabled properly.
+     * Throw string exception if the shader compiler has not been enabled properly.
      */
     static create(shaderSource: string, platformTarget?: ShaderLanguage, path?: string): Shader;
-    /**
-     * Create a shader.
-     * @param name - Name of the shader
-     * @param vertexSource - Vertex source code
-     * @param fragmentSource - Fragment source code
-     * @returns Shader
-     */
-    static create(name: string, vertexSource: string, fragmentSource: string): Shader;
     /**
      * Create a shader.
      * @param name - Name of the shader

package/types/shader/ShaderFactory.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Shader registry and GLSL utilities. Holds the `#include` lookup table
+ * the runtime preprocessor reads, and the GLSL ES 100 → 300 syntax
+ * converter the WebGL2 path uses.
+ */
+export declare class ShaderFactory {
+    static readonly includeMap: Record<string, string>;
+    static readonly shaderExtension: string;
+    private static readonly _has300OutInFragReg;
+    /**
+     * Register a chunk source so `#include` resolves it.
+     * @param includeName - The path key referenced in `#include "..."`.
+     * @param includeSource - GLSL chunk source text.
+     */
+    static registerInclude(includeName: string, includeSource: string): void;
+    /**
+     * Remove a registered shader chunk.
+     * @param includeName - The path key passed to `registerInclude`.
+     */
+    static unRegisterInclude(includeName: string): void;
+    /**
+     * Convert lower GLSL version to GLSL 300 es.
+     * @param shader - code
+     * @param isFrag - Whether it is a fragment shader.
+     */
+    static convertTo300(shader: string, isFrag?: boolean): string;
+    private static _replaceMRTShader;
+}

package/types/shader/ShaderPass.d.ts

@@ -5,25 +5,8 @@ import { ShaderLanguage } from "./enums/ShaderLanguage";
  * Shader pass containing vertex and fragment source.
  */
 export declare class ShaderPass extends ShaderPart {
-    private _vertexSource?;
-    private _fragmentSource?;
     private static _shaderMacroList;
     private static _macroMap;
-    /**
-     * Create a shader pass.
-     * @param name - Shader pass name
-     * @param vertexSource - Vertex shader source
-     * @param fragmentSource - Fragment shader source
-     * @param tags - Tags
-     */
-    constructor(name: string, vertexSource: string, fragmentSource: string, tags?: Record<string, number | string | boolean>);
-    /**
-     * Create a shader pass.
-     * @param vertexSource - Vertex shader source
-     * @param fragmentSource - Fragment shader source
-     * @param tags - Tags
-     */
-    constructor(vertexSource: string, fragmentSource: string, tags?: Record<string, number | string | boolean>);
     /**
      * Create a shader pass from precompiled instructions.
      * @param name - Shader pass name
@@ -34,6 +17,5 @@ export declare class ShaderPass extends ShaderPart {
      */
     constructor(name: string, vertexShaderInstructions: ShaderInstruction[], fragmentShaderInstructions: ShaderInstruction[], platformTarget: ShaderLanguage, tags?: Record<string, number | string | boolean>);
     private _getCanonicalShaderProgram;
-    private _compilePlatformSource;
-    private _compileShaderLabSource;
+    private _compileShaderSource;
 }

package/types/shader/index.d.ts

@@ -11,9 +11,9 @@ export { ShaderPropertyType } from "./enums/ShaderPropertyType";
 export { StencilOperation } from "./enums/StencilOperation";
 export { Shader } from "./Shader";
 export { ShaderData } from "./ShaderData";
+export { ShaderFactory } from "./ShaderFactory";
 export { ShaderMacro } from "./ShaderMacro";
 export { ShaderPass } from "./ShaderPass";
 export { ShaderProperty } from "./ShaderProperty";
 export { ShaderTagKey } from "./ShaderTagKey";
-export * from "./state";
 export { SubShader } from "./SubShader";

package/types/shader/state/RenderState.d.ts

@@ -17,5 +17,4 @@ export declare class RenderState {
     readonly rasterState: RasterState;
     /** Render queue type. */
     renderQueueType: RenderQueueType;
-    private _applyStatesByShaderData;
 }

package/types/graphic/TransformFeedbackShader.d.ts

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

package/types/shader/ShaderPool.d.ts

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

package/types/shader/state/index.d.ts

@@ -1,6 +0,0 @@
-export { BlendState } from "./BlendState";
-export { DepthState } from "./DepthState";
-export { RasterState } from "./RasterState";
-export { RenderState } from "./RenderState";
-export { RenderTargetBlendState } from "./RenderTargetBlendState";
-export { StencilState } from "./StencilState";

package/types/shaderlib/ShaderFactory.d.ts

@@ -1,20 +0,0 @@
-import { ShaderMacro } from "../shader/ShaderMacro";
-export declare class ShaderFactory {
-    private static readonly _has300OutInFragReg;
-    static parseCustomMacros(macros: ShaderMacro[]): string;
-    static registerInclude(includeName: string, includeSource: string): void;
-    static unRegisterInclude(includeName: string): void;
-    /**
-     * @param regex The default regex is for engine's builtin glsl `#include` syntax,
-     * since `ShaderLab` use the same parsing function but different syntax for `#include` --- `/^[ \t]*#include +"([\w\d.]+)"/gm`
-     */
-    static parseIncludes(src: string, regex?: RegExp): string;
-    /**
-     * Convert lower GLSL version to GLSL 300 es.
-     * @param shader - code
-     * @param isFrag - Whether it is a fragment shader.
-     * */
-    static convertTo300(shader: string, isFrag?: boolean): string;
-    private static _has300Output;
-    private static _replaceMRTShader;
-}

package/types/shaderlib/ShaderLib.d.ts

@@ -1,62 +0,0 @@
-export declare const ShaderLib: {
-    particle_common: string;
-    velocity_over_lifetime_module: string;
-    rotation_over_lifetime_module: string;
-    size_over_lifetime_module: string;
-    color_over_lifetime_module: string;
-    texture_sheet_animation_module: string;
-    force_over_lifetime_module: string;
-    limit_velocity_over_lifetime_module: string;
-    noise_module: string;
-    particle_feedback_simulation: string;
-    sphere_billboard: string;
-    stretched_billboard: string;
-    vertical_billboard: string;
-    horizontal_billboard: string;
-    particle_mesh: string;
-    normal_get: string;
-    pbr_frag_define: string;
-    pbr_helper: string;
-    brdf: string;
-    direct_irradiance_frag_define: string;
-    ibl_frag_define: string;
-    pbr_frag: string;
-    btdf: string;
-    refraction: string;
-    ShadowCoord: string;
-    ShadowFragmentDeclaration: string;
-    shadow_sample_tent: string;
-    ShadowVertexDeclaration: string;
-    ShadowVertex: string;
-    common: string;
-    common_vert: string;
-    transform_declare: string;
-    camera_declare: string;
-    color_share: string;
-    normal_share: string;
-    uv_share: string;
-    worldpos_share: string;
-    FogVertexDeclaration: string;
-    FogFragmentDeclaration: string;
-    PositionClipSpaceDeclaration: string;
-    begin_normal_vert: string;
-    begin_position_vert: string;
-    position_vert: string;
-    color_vert: string;
-    normal_vert: string;
-    skinning_vert: string;
-    blendShape_input: string;
-    blendShape_vert: string;
-    uv_vert: string;
-    worldpos_vert: string;
-    FogVertex: string;
-    light_frag_define: string;
-    mobile_material_frag: string;
-    FogFragment: string;
-    PositionClipSpaceVertex: string;
-    begin_mobile_frag: string;
-    begin_viewdir_frag: string;
-    mobile_blinnphong_frag: string;
-    noise_common: string;
-    noise_simplex_3D_grad: string;
-};

package/types/shaderlib/index.d.ts

@@ -1 +0,0 @@
-export { ShaderFactory } from "./ShaderFactory";

package/types/shaderlib/particle/index.d.ts

@@ -1,18 +0,0 @@
-declare const _default: {
-    particle_common: string;
-    velocity_over_lifetime_module: string;
-    rotation_over_lifetime_module: string;
-    size_over_lifetime_module: string;
-    color_over_lifetime_module: string;
-    texture_sheet_animation_module: string;
-    force_over_lifetime_module: string;
-    limit_velocity_over_lifetime_module: string;
-    noise_module: string;
-    particle_feedback_simulation: string;
-    sphere_billboard: string;
-    stretched_billboard: string;
-    vertical_billboard: string;
-    horizontal_billboard: string;
-    particle_mesh: string;
-};
-export default _default;

package/types/shaderlib/pbr/index.d.ts

@@ -1,11 +0,0 @@
-declare const _default: {
-    pbr_frag_define: string;
-    pbr_helper: string;
-    brdf: string;
-    direct_irradiance_frag_define: string;
-    ibl_frag_define: string;
-    pbr_frag: string;
-    btdf: string;
-    refraction: string;
-};
-export default _default;

package/types/shaderlib/shadow/index.d.ts

@@ -1,8 +0,0 @@
-declare const _default: {
-    ShadowCoord: string;
-    ShadowFragmentDeclaration: string;
-    shadow_sample_tent: string;
-    ShadowVertexDeclaration: string;
-    ShadowVertex: string;
-};
-export default _default;