@galacean/engine-core 1.6.8 → 1.6.9

package/types/shader/enums/RenderStateElementKey.d.ts

@@ -0,0 +1,60 @@
+export declare enum RenderStateElementKey {
+    /** Blend state enabled for target 0 key. */
+    BlendStateEnabled0 = 0,
+    /** Blend state color blend operation for target 0 key. */
+    BlendStateColorBlendOperation0 = 1,
+    /** Blend state alpha blend operation for target 0 key. */
+    BlendStateAlphaBlendOperation0 = 2,
+    /** Blend state source color blend factor for target 0 key. */
+    BlendStateSourceColorBlendFactor0 = 3,
+    /** Blend state source alpha blend factor for target 0 key. */
+    BlendStateSourceAlphaBlendFactor0 = 4,
+    /** Blend state destination color blend factor for target 0 key. */
+    BlendStateDestinationColorBlendFactor0 = 5,
+    /** Blend state destination alpha blend factor for target 0 key. */
+    BlendStateDestinationAlphaBlendFactor0 = 6,
+    /** Blend state color write mask for target 0 key. */
+    BlendStateColorWriteMask0 = 7,
+    /** Blend state blend color key. */
+    BlendStateBlendColor = 8,
+    /** Blend state alpha to coverage key. */
+    BlendStateAlphaToCoverage = 9,
+    /** Depth state enabled key. */
+    DepthStateEnabled = 10,
+    /** Depth state write enabled key. */
+    DepthStateWriteEnabled = 11,
+    /** Depth state compare function key. */
+    DepthStateCompareFunction = 12,
+    /** Stencil state enabled key. */
+    StencilStateEnabled = 13,
+    /** Stencil state reference value key. */
+    StencilStateReferenceValue = 14,
+    /** Stencil state read mask key. */
+    StencilStateMask = 15,
+    /** Stencil state write mask key. */
+    StencilStateWriteMask = 16,
+    /** Stencil state compare function front key. */
+    StencilStateCompareFunctionFront = 17,
+    /** Stencil state compare function back key. */
+    StencilStateCompareFunctionBack = 18,
+    /** Stencil state pass operation front key. */
+    StencilStatePassOperationFront = 19,
+    /** Stencil state pass operation back key. */
+    StencilStatePassOperationBack = 20,
+    /** Stencil state fail operation front key. */
+    StencilStateFailOperationFront = 21,
+    /** Stencil state fail operation back key. */
+    StencilStateFailOperationBack = 22,
+    /** Stencil state z fail operation front key. */
+    StencilStateZFailOperationFront = 23,
+    /** Stencil state z fail operation back key. */
+    StencilStateZFailOperationBack = 24,
+    /** Raster state fill mode key. */
+    RasterStateCullMode = 25,
+    /** Raster state cull mode key. */
+    RasterStateDepthBias = 26,
+    /** Raster state depth bias key. */
+    RasterStateSlopeScaledDepthBias = 27,
+    /** Render queue type key. */
+    RenderQueueType = 28
+}

package/types/shader/enums/ShaderDataGroup.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Shader data grouping.
+ */
+export declare enum ShaderDataGroup {
+    /** Scene group. */
+    Scene = 0,
+    /** Camera group. */
+    Camera = 1,
+    /** Renderer group. */
+    Renderer = 2,
+    /** Material group. */
+    Material = 3,
+    /** Render element group. */
+    RenderElement = 4
+}

package/types/shader/enums/ShaderLanguage.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Shader language belongs to.
+ */
+export declare enum ShaderLanguage {
+    /** GLSL ES 100. */
+    GLSLES100 = 0,
+    /** GLSL ES 300. */
+    GLSLES300 = 1
+}

package/types/shader/enums/ShaderPropertyType.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Shader Property type.
+ */
+export declare enum ShaderPropertyType {
+    /** Float type. */
+    Float = 0,
+    /** Int type. */
+    Int = 1,
+    /** Vector2 type. */
+    Vector2 = 2,
+    /** Vector3 type. */
+    Vector3 = 3,
+    /** Vector4 type. */
+    Vector4 = 4,
+    /** Matrix type. */
+    Matrix = 5,
+    /** Color type. */
+    Color = 6,
+    /** Texture type. */
+    Texture = 7,
+    /** Float array type. */
+    FloatArray = 8,
+    /** Int array type. */
+    IntArray = 9,
+    /** Texture array type. */
+    TextureArray = 10
+}

package/types/shader/enums/StencilOperation.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Stencil operation mode.
+ * @remarks sets the front and/or back-facing stencil test actions.
+ */
+export declare enum StencilOperation {
+    /** Keeps the current value. */
+    Keep = 0,
+    /** Sets the stencil buffer value to 0. */
+    Zero = 1,
+    /** Sets the stencil buffer value to the reference value. */
+    Replace = 2,
+    /** Increments the current stencil buffer value. Clamps to the maximum representable unsigned value. */
+    IncrementSaturate = 3,
+    /** Decrements the current stencil buffer value. Clamps to 0. */
+    DecrementSaturate = 4,
+    /** Inverts the current stencil buffer value bitwise. */
+    Invert = 5,
+    /** Increments the current stencil buffer value. Wraps stencil buffer value to zero when incrementing the maximum representable unsigned value. */
+    IncrementWrap = 6,
+    /** Decrements the current stencil buffer value. Wraps stencil buffer value to the maximum representable unsigned value when decrementing a stencil buffer value of 0. */
+    DecrementWrap = 7
+}

package/types/shader/index.d.ts

@@ -0,0 +1,19 @@
+export { BlendFactor } from "./enums/BlendFactor";
+export { BlendOperation } from "./enums/BlendOperation";
+export { ColorWriteMask } from "./enums/ColorWriteMask";
+export { CompareFunction } from "./enums/CompareFunction";
+export { CullMode } from "./enums/CullMode";
+export { RenderQueueType } from "./enums/RenderQueueType";
+export { RenderStateElementKey } from "./enums/RenderStateElementKey";
+export { ShaderDataGroup } from "./enums/ShaderDataGroup";
+export { ShaderLanguage } from "./enums/ShaderLanguage";
+export { ShaderPropertyType } from "./enums/ShaderPropertyType";
+export { StencilOperation } from "./enums/StencilOperation";
+export { Shader } from "./Shader";
+export { ShaderData } from "./ShaderData";
+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/BlendState.d.ts

@@ -0,0 +1,16 @@
+import { Color } from "@galacean/engine-math";
+import { RenderTargetBlendState } from "./RenderTargetBlendState";
+/**
+ * Blend state.
+ */
+export declare class BlendState {
+    private static _getGLBlendFactor;
+    private static _getGLBlendOperation;
+    /** The blend state of the render target. */
+    readonly targetBlendState: RenderTargetBlendState;
+    /** Constant blend color. */
+    readonly blendColor: Color;
+    /** Whether to use (Alpha-to-Coverage) technology. */
+    alphaToCoverage: boolean;
+    private _platformApply;
+}

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

@@ -0,0 +1,14 @@
+import { CompareFunction } from "../enums/CompareFunction";
+/**
+ * Depth state.
+ */
+export declare class DepthState {
+    private static _getGLCompareFunction;
+    /** Whether to enable the depth test. */
+    enabled: boolean;
+    /** Depth comparison function. */
+    compareFunction: CompareFunction;
+    /** Whether the depth value can be written.*/
+    writeEnabled: boolean;
+    private _platformApply;
+}

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

@@ -0,0 +1,13 @@
+import { CullMode } from "../enums/CullMode";
+/**
+ * Raster state.
+ */
+export declare class 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;
+    private _platformApply;
+}

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

@@ -0,0 +1,21 @@
+import { RenderQueueType } from "../enums/RenderQueueType";
+import { BlendState } from "./BlendState";
+import { DepthState } from "./DepthState";
+import { RasterState } from "./RasterState";
+import { StencilState } from "./StencilState";
+/**
+ * Render state.
+ */
+export declare class RenderState {
+    /** Blend state. */
+    readonly blendState: BlendState;
+    /** Depth state. */
+    readonly depthState: DepthState;
+    /** Stencil state. */
+    readonly stencilState: StencilState;
+    /** Raster state. */
+    readonly rasterState: RasterState;
+    /** Render queue type. */
+    renderQueueType: RenderQueueType;
+    private _applyStatesByShaderData;
+}

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

@@ -0,0 +1,24 @@
+import { BlendOperation } from "../enums/BlendOperation";
+import { BlendFactor } from "../enums/BlendFactor";
+import { ColorWriteMask } from "../enums/ColorWriteMask";
+/**
+ * The blend state of the render target.
+ */
+export declare class RenderTargetBlendState {
+    /** 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;
+}

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

@@ -0,0 +1,34 @@
+import { CompareFunction } from "../enums/CompareFunction";
+import { StencilOperation } from "../enums/StencilOperation";
+/**
+ * Stencil state.
+ */
+export declare class StencilState {
+    private static _getGLCompareFunction;
+    private static _getGLStencilOperation;
+    /** 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;
+    private _platformApply;
+}

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

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

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

@@ -0,0 +1,73 @@
+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;
+    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_cellular_2D: string;
+    noise_cellular_2x2: string;
+    noise_cellular_2x2x2: string;
+    noise_cellular_3D: string;
+    noise_cellular: string;
+    noise_perlin_2D: string;
+    noise_perlin_3D: string;
+    noise_perlin_4D: string;
+    noise_perlin: string;
+    noise_psrd_2D: string;
+    noise_simplex_2D: string;
+    noise_simplex_3D_grad: string;
+    noise_simplex_3D: string;
+    noise_simplex_4D: string;
+    noise_simplex: string;
+};

package/types/shaderlib/index.d.ts

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

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

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

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

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

package/types/shadow/CascadedShadowCasterPass.d.ts

@@ -0,0 +1,45 @@
+import { Camera } from "../Camera";
+import { PipelinePass } from "../RenderPipeline/PipelinePass";
+/**
+ * Cascade shadow caster pass.
+ */
+export declare class CascadedShadowCasterPass extends PipelinePass {
+    private static _lightShadowBiasProperty;
+    private static _lightDirectionProperty;
+    private static _shadowMatricesProperty;
+    private static _shadowMapSize;
+    private static _shadowInfosProperty;
+    private static _shadowMapsProperty;
+    private static _shadowSplitSpheresProperty;
+    private static _maxCascades;
+    private static _cascadesSplitDistance;
+    private static _viewport;
+    private static _clearColor;
+    private static _tempVector;
+    private static _tempMatrix0;
+    private readonly _camera;
+    private readonly _supportDepthTexture;
+    private _shadowMapResolution;
+    private _shadowMapSize;
+    private _shadowTileResolution;
+    private _shadowBias;
+    private _shadowMapFormat;
+    private _shadowCascadeMode;
+    private _shadowSliceData;
+    private _lightUp;
+    private _lightSide;
+    private _splitBoundSpheres;
+    /** The end is project precision problem in shader. */
+    private _shadowMatrices;
+    private _shadowInfos;
+    private _depthTexture;
+    private _renderTarget;
+    private _viewportOffsets;
+    constructor(camera: Camera);
+    private _renderDirectShadowMap;
+    private _updateReceiversShaderData;
+    private _getCascadesSplitDistance;
+    private _getFarWithRadius;
+    private _updateShadowSettings;
+    private _updateSingleShadowCasterShaderData;
+}

package/types/shadow/ShadowSliceData.d.ts

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

package/types/shadow/ShadowUtils.d.ts

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

package/types/shadow/enum/ShadowCascadesMode.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Number of cascades to use for directional light shadows.
+ */
+export declare enum ShadowCascadesMode {
+    /** No cascades */
+    NoCascades = 1,
+    /** Two cascades */
+    TwoCascades = 2,
+    /** Four cascades */
+    FourCascades = 4
+}

package/types/shadow/enum/ShadowResolution.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Default shadow resolution.
+ */
+export declare enum ShadowResolution {
+    /** Low shadow map resolution. */
+    Low = 0,
+    /** Medium shadow map resolution. */
+    Medium = 1,
+    /**  High shadow map resolution. */
+    High = 2,
+    /** Very high shadow map resolution. */
+    VeryHigh = 3
+}

package/types/shadow/enum/ShadowType.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Determines which type of shadows should be used.
+ */
+export declare enum ShadowType {
+    /** Disable Shadows. */
+    None = 0,
+    /** Hard Shadows Only. */
+    Hard = 1,
+    /** Cast "soft" shadows with low range. */
+    SoftLow = 2,
+    /** Cast "soft" shadows with large range. */
+    SoftHigh = 3
+}

package/types/shadow/index.d.ts

@@ -0,0 +1,3 @@
+export { ShadowCascadesMode } from "./enum/ShadowCascadesMode";
+export { ShadowResolution } from "./enum/ShadowResolution";
+export { ShadowType } from "./enum/ShadowType";

package/types/sky/Sky.d.ts

@@ -0,0 +1,22 @@
+import { Mesh } from "../graphic/Mesh";
+import { Material } from "../material";
+/**
+ * Sky.
+ */
+export declare class Sky {
+    private static _epsilon;
+    private static _viewProjMatrix;
+    private static _projectionMatrix;
+    private _material;
+    private _mesh;
+    /**
+     *  Material of the sky.
+     */
+    get material(): Material;
+    set material(value: Material);
+    /**
+     *  Mesh of the sky.
+     */
+    get mesh(): Mesh;
+    set mesh(value: Mesh);
+}

package/types/sky/SkyBoxMaterial.d.ts

@@ -0,0 +1,43 @@
+import { Color } from "@galacean/engine-math";
+import { Engine } from "../Engine";
+import { Material } from "../material/Material";
+import { TextureCube } from "../texture";
+/**
+ * SkyBoxMaterial.
+ */
+export declare class SkyBoxMaterial extends Material {
+    private static _tintColorProp;
+    private static _textureCubeProp;
+    private static _rotationProp;
+    private static _exposureProp;
+    private static _decodeSkyRGBMMacro;
+    private _textureDecodeRGBM;
+    private _tintColor;
+    /**
+     * Whether to decode texture with RGBM format.
+     */
+    get textureDecodeRGBM(): boolean;
+    set textureDecodeRGBM(value: boolean);
+    /**
+     * Texture of the sky box material.
+     */
+    get texture(): TextureCube;
+    set texture(value: TextureCube);
+    /**
+     * The angle to rotate around the y-axis, unit is degree.
+     */
+    get rotation(): number;
+    set rotation(value: number);
+    /**
+     * The exposure value of this material.
+     */
+    get exposure(): number;
+    set exposure(value: number);
+    /**
+     * The Tint color of this material.
+     */
+    get tintColor(): Color;
+    set tintColor(value: Color);
+    constructor(engine: Engine);
+    clone(): SkyBoxMaterial;
+}