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

package/types/shader/ShaderPart.d.ts

@@ -0,0 +1,41 @@
+import { ShaderTagKey } from "./ShaderTagKey";
+/**
+ * Base class for shader structure.
+ */
+export declare abstract class ShaderPart {
+    private _tagsMap;
+    /**
+     * Set tag by key name.
+     * @param keyName - Key name of the tag
+     * @param value - Tag value
+     */
+    setTag<T extends number | string | boolean>(keyName: string, value: T): void;
+    /**
+     * Set tag.
+     * @param key - Key of the tag
+     * @param value - Tag value
+     */
+    setTag<T extends number | string | boolean>(key: ShaderTagKey, value: T): void;
+    /**
+     * Delete a tag by key name.
+     * @param KeyName - Key name of the tag
+     */
+    deleteTag(KeyName: string): void;
+    /**
+     * Delete a tag by key.
+     * @param key - Key of the tag
+     */
+    deleteTag(key: ShaderTagKey): void;
+    /**
+     * Get tag by key name.
+     * @param keyName - Key name of the tag
+     * @returns Tag value
+     */
+    getTagValue<T extends number | string | boolean>(keyName: string): T;
+    /**
+     * Get tag value by key.
+     * @param key - Key of the tag
+     * @returns Tag value
+     */
+    getTagValue<T extends number | string | boolean>(key: ShaderTagKey): T;
+}

package/types/shader/ShaderPass.d.ts

@@ -1,9 +1,16 @@
+import { ShaderPart } from "./ShaderPart";
 /**
  * Shader pass containing vertex and fragment source.
  */
-export declare class ShaderPass {
+export declare class ShaderPass extends ShaderPart {
     private static _shaderPassCounter;
     private _vertexSource;
     private _fragmentSource;
-    constructor(vertexSource: string, fragmentSource: string);
+    /**
+     * 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>);
 }

package/types/shader/ShaderProperty.d.ts

@@ -4,6 +4,13 @@ import { ShaderPropertyType } from "./enums/ShaderPropertyType";
  */
 export declare class ShaderProperty {
     private static _propertyNameCounter;
+    private static _propertyNameMap;
+    /**
+     * Get shader property by name.
+     * @param name - Name of the shader property
+     * @returns Shader property
+     */
+    static getByName(name: string): ShaderProperty;
     /** Shader property name. */
     readonly name: string;
     /**

package/types/shader/ShaderTagKey.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Shader tag key.
+ */
+export declare class ShaderTagKey {
+    private static _nameCounter;
+    private static _nameMap;
+    /**
+     * Get shader property by name.
+     * @param name - Name of the shader property
+     * @returns Shader property
+     */
+    static getByName(name: string): ShaderTagKey;
+    /** Shader tag property name. */
+    readonly name: string;
+    private constructor();
+}

package/types/shader/SubShader.d.ts

@@ -0,0 +1,19 @@
+import { ShaderPart } from "./ShaderPart";
+import { ShaderPass } from "./ShaderPass";
+/**
+ * Sub shader.
+ */
+export declare class SubShader extends ShaderPart {
+    readonly name: string;
+    private _passes;
+    /**
+     * Sub shader passes.
+     */
+    get passes(): ReadonlyArray<ShaderPass>;
+    /**
+     * Create a sub shader.
+     * @param name - Name of the sub shader
+     * @param passes - Sub shader passes
+     */
+    constructor(name: string, passes: ShaderPass[], tags?: Record<string, number | string | boolean>);
+}

package/types/shader/index.d.ts

@@ -1,12 +1,16 @@
-export { RenderQueueType } from "./enums/RenderQueueType";
 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 { 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 { SubShader } from "./SubShader";
+export * from "./state";

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/shadow/CascadedShadowCasterPass.d.ts

@@ -12,12 +12,12 @@ export declare class CascadedShadowCasterPass {
     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 _engine;
-    private readonly _shadowCasterShader;
     private readonly _supportDepthTexture;
     private _shadowMapResolution;
     private _shadowMapSize;

package/types/sky/SkyBoxMaterial.d.ts

@@ -1,25 +1,43 @@
+import { Color } from "@galacean/engine-math";
 import { Engine } from "../Engine";
 import { Material } from "../material/Material";
 import { TextureCube } from "../texture";
 /**
- * SkyboxMaterial
+ * SkyBoxMaterial.
  */
 export declare class SkyBoxMaterial extends Material {
-    private _decodeParam;
+    private static _tintColorProp;
+    private static _textureCubeProp;
+    private static _rotationProp;
+    private static _exposureProp;
+    private static _decodeSkyRGBMMacro;
+    private _textureDecodeRGBM;
+    private _tintColor;
     /**
-     * Whether to decode from texture with RGBM format.
+     * Whether to decode texture with RGBM format.
      */
     get textureDecodeRGBM(): boolean;
     set textureDecodeRGBM(value: boolean);
     /**
-     * RGBM decode factor, default 5.0.
+     * Texture of the sky box material.
      */
-    get RGBMDecodeFactor(): number;
-    set RGBMDecodeFactor(value: number);
+    get texture(): TextureCube;
+    set texture(value: TextureCube);
     /**
-     * Texture cube map of the sky box material.
+     * The angle to rotate around the y-axis, unit is degree.
      */
-    get textureCubeMap(): TextureCube;
-    set textureCubeMap(v: TextureCube);
+    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;
 }

package/types/sky/SkyProceduralMaterial.d.ts

@@ -0,0 +1,72 @@
+import { Color } from "@galacean/engine-math";
+import { Engine } from "../Engine";
+import { Material } from "../material/Material";
+/**
+ * Sun mode.
+ */
+export declare enum SunMode {
+    /** None */
+    None = 0,
+    /** Simple sun. */
+    Simple = 1,
+    /** High quality sun. */
+    HighQuality = 2
+}
+/**
+ * Sky procedural material.
+ */
+export declare class SkyProceduralMaterial extends Material {
+    private static _sunSizeProp;
+    private static _sunSizeConvergenceProp;
+    private static _atmosphereThicknessProp;
+    private static _skyTintProp;
+    private static _groundTintProp;
+    private static _exposureProp;
+    private static _sunHighQualityMacro;
+    private static _sunSimpleMacro;
+    private _sunDisk;
+    /**
+     * Sun mode.
+     */
+    get sunMode(): SunMode;
+    set sunMode(value: SunMode);
+    /**
+     * Sun size, range is 0 to 1.
+     */
+    get sunSize(): number;
+    set sunSize(value: number);
+    /**
+     * Sun size convergence, range is 0 to 20.
+     */
+    get sunSizeConvergence(): number;
+    set sunSizeConvergence(value: number);
+    /**
+     * Atmosphere thickness, range is 0 to 5.
+     */
+    get atmosphereThickness(): number;
+    set atmosphereThickness(value: number);
+    /**
+     * Sky tint.
+     */
+    get skyTint(): Color;
+    set skyTint(value: Color);
+    /**
+     * Ground tint.
+     */
+    get groundTint(): Color;
+    set groundTint(value: Color);
+    /**
+     * Exposure, range is 0 to 8.
+     */
+    get exposure(): number;
+    set exposure(value: number);
+    /**
+     * Constructor a SkyBoxProceduralMaterial instance.
+     * @param engine - Engine to which the material belongs
+     */
+    constructor(engine: Engine);
+    /**
+     * @inheritDoc
+     */
+    clone(): SkyProceduralMaterial;
+}

package/types/sky/index.d.ts

@@ -1,2 +1,3 @@
 export { Sky } from "./Sky";
 export { SkyBoxMaterial } from "./SkyBoxMaterial";
+export { SkyProceduralMaterial, SunMode } from "./SkyProceduralMaterial";

package/types/texture/RenderTarget.d.ts

@@ -1,11 +1,11 @@
-import { EngineObject } from "../base";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { Engine } from "../Engine";
 import { RenderBufferDepthFormat } from "./enums/RenderBufferDepthFormat";
 import { Texture } from "./Texture";
 /**
  * The render target used for off-screen rendering.
  */
-export declare class RenderTarget extends EngineObject {
+export declare class RenderTarget extends GraphicsResource {
     private _autoGenerateMipmaps;
     private _width;
     private _height;
@@ -88,8 +88,4 @@ export declare class RenderTarget extends EngineObject {
      * Generate the mipmap of each attachment texture of the renderTarget according to the configuration.
      */
     generateMipmaps(): void;
-    /**
-     * Destroy render target.
-     */
-    destroy(): void;
 }

package/types/texture/Texture.d.ts

@@ -1,4 +1,4 @@
-import { RefObject } from "../asset/RefObject";
+import { GraphicsResource } from "../asset/GraphicsResource";
 import { TextureDepthCompareFunction } from "./enums/TextureDepthCompareFunction";
 import { TextureFilterMode } from "./enums/TextureFilterMode";
 import { TextureFormat } from "./enums/TextureFormat";
@@ -6,7 +6,7 @@ import { TextureWrapMode } from "./enums/TextureWrapMode";
 /**
  * The base class of texture, contains some common functions of texture-related classes.
  */
-export declare abstract class Texture extends RefObject {
+export declare abstract class Texture extends GraphicsResource {
     name: string;
     protected _format: TextureFormat;
     protected _width: number;
@@ -64,10 +64,6 @@ export declare abstract class Texture extends RefObject {
      * Generate multi-level textures based on the 0th level data.
      */
     generateMipmaps(): void;
-    /**
-     * @override
-     */
-    _onDestroy(): void;
     /**
      * Get the maximum mip level of the corresponding size:rounding down.
      * @remarks http://download.nvidia.com/developer/Papers/2005/NP2_Mipmapping/NP2_Mipmap_Creation.pdf

package/types/trail/TrailRenderer.d.ts

@@ -1,6 +1,5 @@
 import { Entity } from "../Entity";
 import { MeshRenderer } from "../mesh/MeshRenderer";
-import { RenderContext } from "../RenderPipeline/RenderContext";
 import { Texture2D } from "../texture";
 /**
  * @deprecated
@@ -28,10 +27,6 @@ export declare class TrailRenderer extends MeshRenderer {
      * @param texture
      */
     setTexture(texture: Texture2D): void;
-    /**
-     * @override
-     */
-    protected _render(context: RenderContext): void;
     private _initGeometry;
     private _updateStrapVertices;
     private _updateStrapCoords;

package/types/utils/BoolUpdateFlag.d.ts

@@ -0,0 +1,12 @@
+import { UpdateFlag } from "./UpdateFlag";
+/**
+ * Bool update flag.
+ */
+export declare class BoolUpdateFlag extends UpdateFlag {
+    /** Bool flag. */
+    flag: boolean;
+    /**
+     * @inheritdoc
+     */
+    dispatch(): void;
+}

package/types/utils/DisorderedArray.d.ts

@@ -0,0 +1,18 @@
+/**
+ * High-performance unordered array, delete uses exchange method to improve performance, internal capacity only increases.
+ */
+export declare class DisorderedArray<T> {
+    _elements: T[];
+    length: number;
+    constructor(count?: number);
+    add(element: T): void;
+    delete(element: T): void;
+    get(index: number): T;
+    /**
+     *
+     * @param index
+     * @returns The replaced item is used to reset its index.
+     */
+    deleteByIndex(index: number): T;
+    garbageCollection(): void;
+}

package/types/utils/SafeLoopArray.d.ts

@@ -0,0 +1,41 @@
+export declare class SafeLoopArray<T> {
+    private _array;
+    private _loopArray;
+    private _loopArrayDirty;
+    /**
+     * Get the length of the array.
+     */
+    get length(): number;
+    /**
+     * Push item to the array.
+     * @param item - The item which want to be pushed
+     */
+    push(item: T): void;
+    /**
+     * Add item to the array.
+     * @param index - The index of the array
+     * @param item - The item which want to be added
+     */
+    add(index: number, item: T): void;
+    /**
+     * Remove item from the array.
+     * @param index - The index of the array
+     */
+    removeByIndex(index: number): void;
+    /**
+     * The index of the item.
+     * @param item - The item which want to get the index
+     * @returns Index of the item
+     */
+    indexOf(item: T): number;
+    /**
+     * Get the array.
+     * @returns The array
+     */
+    getArray(): ReadonlyArray<T>;
+    /**
+     * Get the array use for loop.
+     * @returns The array use for loop
+     */
+    getLoopArray(): ReadonlyArray<T>;
+}

package/types/utils/UpdateFlag.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Used to update tags.
+ */
+export declare abstract class UpdateFlag {
+    /**
+     * Dispatch.
+     * @param bit - Bit
+     * @param param - Parameter
+     */
+    abstract dispatch(bit?: number, param?: Object): void;
+    /**
+     * Clear.
+     */
+    clearFromManagers(): void;
+    /**
+     * Destroy.
+     */
+    destroy(): void;
+    private _removeFromManagers;
+}

package/types/utils/UpdateFlagManager.d.ts

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

package/types/utils/Utils.d.ts

@@ -0,0 +1,31 @@
+export declare class Utils {
+    /**
+     * Fast remove an element from array.
+     * @param array - Array
+     * @param item - Element
+     */
+    static removeFromArray(array: any[], item: any): boolean;
+    /**
+     * Decodes a given Uint8Array into a string.
+     */
+    static decodeText(array: Uint8Array): string;
+    /**
+     * Judge whether the url is absolute url.
+     * @param url - The url to be judged.
+     * @returns Whether the url is absolute url.
+     */
+    static isAbsoluteUrl(url: string): boolean;
+    /**
+     * Get the values of an object.
+     */
+    static objectValues(obj: any): any[];
+    /**
+     * Convert a relative URL to an absolute URL based on a given base URL.
+     * @param baseUrl - The base url.
+     * @param relativeUrl - The relative url.
+     * @returns The resolved url.
+     */
+    static resolveAbsoluteUrl(baseUrl: string, relativeUrl: string): string;
+    private static _stringToPath;
+    private static _formatRelativePath;
+}