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

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;
@@ -79,17 +79,12 @@ export declare class RenderTarget extends EngineObject {
      */
     constructor(engine: Engine, width: number, height: number, colorTextures: Texture[], depthTexture: Texture, antiAliasing?: number);
     /**
-     *
      * Get the render color texture by index.
-     * @param index
+     * @param index - Render color texture index
      */
     getColorTexture(index?: number): Texture | null;
     /**
      * 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,16 +1,18 @@
-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";
+import { TextureUsage } from "./enums/TextureUsage";
 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;
     protected _height: number;
+    protected _usage: TextureUsage;
     protected _mipmapCount: number;
     private _wrapModeU;
     private _wrapModeV;
@@ -30,6 +32,10 @@ export declare abstract class Texture extends RefObject {
      * The height of the texture.
      */
     get height(): number;
+    /**
+     * The usage of the texture.
+     */
+    get usage(): TextureUsage;
     /**
      * Wrapping mode for texture coordinate S.
      */
@@ -64,10 +70,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/texture/Texture2D.d.ts

@@ -1,5 +1,6 @@
 import { Engine } from "../Engine";
 import { TextureFormat } from "./enums/TextureFormat";
+import { TextureUsage } from "./enums/TextureUsage";
 import { Texture } from "./Texture";
 /**
  * Two-dimensional texture.
@@ -12,8 +13,9 @@ export declare class Texture2D extends Texture {
      * @param height - Texture height
      * @param format - Texture format. default  `TextureFormat.R8G8B8A8`
      * @param mipmap - Whether to use multi-level texture
+     * @param usage - Texture usage
      */
-    constructor(engine: Engine, width: number, height: number, format?: TextureFormat, mipmap?: boolean);
+    constructor(engine: Engine, width: number, height: number, format?: TextureFormat, mipmap?: boolean, usage?: TextureUsage);
     /**
      * Setting pixels data through color buffer data, designated area and texture mipmapping level,it's also applicable to compressed formats.
      * @remarks If it is the WebGL1.0 platform and the texture format is compressed, the first upload must be filled with textures.
@@ -34,7 +36,7 @@ export declare class Texture2D extends Texture {
      * @param x - X coordinate of area start
      * @param y - Y coordinate of area start
      */
-    setImageSource(imageSource: TexImageSource | OffscreenCanvas, mipLevel?: number, flipY?: boolean, premultiplyAlpha?: boolean, x?: number, y?: number): void;
+    setImageSource(imageSource: TexImageSource, mipLevel?: number, flipY?: boolean, premultiplyAlpha?: boolean, x?: number, y?: number): void;
     /**
      * Get pixel color buffer.
      * @param out - Color buffer

package/types/texture/Texture2DArray.d.ts

@@ -43,7 +43,7 @@ export declare class Texture2DArray extends Texture {
      * @param x - X coordinate of area start
      * @param y - Y coordinate of area start
      */
-    setImageSource(elementIndex: number, imageSource: TexImageSource | OffscreenCanvas, mipLevel?: number, flipY?: boolean, premultiplyAlpha?: boolean, x?: number, y?: number): void;
+    setImageSource(elementIndex: number, imageSource: TexImageSource, mipLevel?: number, flipY?: boolean, premultiplyAlpha?: boolean, x?: number, y?: number): void;
     /**
      * Get pixel color buffer.
      * @param elementIndex - The texture array element index

package/types/texture/TextureCube.d.ts

@@ -36,7 +36,7 @@ export declare class TextureCube extends Texture {
      * @param x - X coordinate of area start
      * @param y - Y coordinate of area start
      */
-    setImageSource(face: TextureCubeFace, imageSource: TexImageSource | OffscreenCanvas, mipLevel?: number, flipY?: boolean, premultiplyAlpha?: boolean, x?: number, y?: number): void;
+    setImageSource(face: TextureCubeFace, imageSource: TexImageSource, mipLevel?: number, flipY?: boolean, premultiplyAlpha?: boolean, x?: number, y?: number): void;
     /**
      * Get pixel color buffer.
      * @param out - Color buffer

package/types/texture/enums/TextureFormat.d.ts

@@ -2,68 +2,74 @@
  * Texture format enumeration.
  */
 export declare enum TextureFormat {
-    /** RGB format,8 bits per channel. */
+    /** RGB format, 8 bits per channel. */
     R8G8B8 = 0,
-    /** RGBA format,8 bits per channel. */
+    /** RGBA format, 8 bits per channel. */
     R8G8B8A8 = 1,
-    /** RGBA format,4 bits per channel. */
+    /** RGBA format, 4 bits per channel. */
     R4G4B4A4 = 2,
-    /** RGBA format,5 bits in R channel,5 bits in G channel,5 bits in B channel, 1 bit in A channel. */
+    /** RGBA format, 5 bits in R channel, 5 bits in G channel, 5 bits in B channel, 1 bit in A channel. */
     R5G5B5A1 = 3,
-    /** RGB format,5 bits in R channel,6 bits in G channel,5 bits in B channel. */
+    /** RGB format, 5 bits in R channel, 6 bits in G channel, 5 bits in B channel. */
     R5G6B5 = 4,
-    /** Transparent format,8 bits. */
+    /** Transparent format, 8 bits. */
     Alpha8 = 5,
     /** Luminance/alpha in RGB channel, alpha in A channel. */
     LuminanceAlpha = 6,
-    /** RGBA format,16 bits per channel. */
+    /** RGBA format, 16 bits per channel. */
     R16G16B16A16 = 7,
-    /** RGBA format,32 bits per channel. */
+    /** RGBA format, 32 bits per channel. */
     R32G32B32A32 = 8,
-    /** RGB compressed format。*/
-    DXT1 = 9,
-    /** RGBA compressed format。*/
-    DXT5 = 10,
-    /** RGB compressed format,4 bits per pixel。*/
-    ETC1_RGB = 11,
-    /** RGB compressed format,4 bits per pixel。*/
-    ETC2_RGB = 12,
-    /** RGBA compressed format,5 bits per pixel,4 bit in RGB, 1 bit in A. */
-    ETC2_RGBA5 = 13,
-    /** RGB compressed format,8 bits per pixel. */
-    ETC2_RGBA8 = 14,
-    /** RGB compressed format,2 bits per pixel. */
-    PVRTC_RGB2 = 15,
-    /** RGBA compressed format,2 bits per pixel. */
-    PVRTC_RGBA2 = 16,
-    /** RGB compressed format,4 bits per pixel. */
-    PVRTC_RGB4 = 17,
-    /** RGBA compressed format,4 bits per pixel. */
-    PVRTC_RGBA4 = 18,
-    /** RGB(A) compressed format,128 bits per 4x4 pixel block. */
-    ASTC_4x4 = 19,
-    /** RGB(A) compressed format,128 bits per 5x5 pixel block. */
-    ASTC_5x5 = 20,
-    /** RGB(A) compressed format,128 bits per 6x6 pixel block. */
-    ASTC_6x6 = 21,
-    /** RGB(A) compressed format,128 bits per 8x8 pixel block. */
-    ASTC_8x8 = 22,
-    /** RGB(A) compressed format,128 bits per 10x10 pixel block. */
-    ASTC_10x10 = 23,
-    /** RGB(A) compressed format,128 bits per 12x12 pixel block. */
-    ASTC_12x12 = 24,
-    /** Automatic depth format,engine will automatically select the supported precision. */
-    Depth = 25,
-    /** Automatic depth setncil format, engine will automatically select the supported precision. */
-    DepthStencil = 26,
+    /** RGB compressed format, 4 bits per pixel. */
+    BC1 = 9,
+    /** RGBA compressed format, 8 bits per pixel. */
+    BC3 = 10,
+    /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
+    BC7 = 11,
+    /** RGB compressed format, 4 bits per pixel. */
+    ETC1_RGB = 12,
+    /** RGB compressed format, 4 bits per pixel. */
+    ETC2_RGB = 13,
+    /** RGBA compressed format, 5 bits per pixel, 4 bit in RGB, 1 bit in A. */
+    ETC2_RGBA5 = 14,
+    /** RGB compressed format, 8 bits per pixel. */
+    ETC2_RGBA8 = 15,
+    /** RGB compressed format, 2 bits per pixel. */
+    PVRTC_RGB2 = 16,
+    /** RGBA compressed format, 2 bits per pixel. */
+    PVRTC_RGBA2 = 17,
+    /** RGB compressed format, 4 bits per pixel. */
+    PVRTC_RGB4 = 18,
+    /** RGBA compressed format, 4 bits per pixel. */
+    PVRTC_RGBA4 = 19,
+    /** RGB(A) compressed format, 128 bits per 4x4 pixel block. */
+    ASTC_4x4 = 20,
+    /** RGB(A) compressed format, 128 bits per 5x5 pixel block. */
+    ASTC_5x5 = 21,
+    /** RGB(A) compressed format, 128 bits per 6x6 pixel block. */
+    ASTC_6x6 = 22,
+    /** RGB(A) compressed format, 128 bits per 8x8 pixel block. */
+    ASTC_8x8 = 23,
+    /** RGB(A) compressed format, 128 bits per 10x10 pixel block. */
+    ASTC_10x10 = 24,
+    /** RGB(A) compressed format, 128 bits per 12x12 pixel block. */
+    ASTC_12x12 = 25,
+    /** Automatic depth format, engine will automatically select the supported precision. */
+    Depth = 26,
+    /** Automatic depth stencil format, engine will automatically select the supported precision. */
+    DepthStencil = 27,
     /** 16-bit depth format. */
-    Depth16 = 27,
+    Depth16 = 28,
     /** 24-bit depth format. */
-    Depth24 = 28,
+    Depth24 = 29,
     /** 32-bit depth format. */
-    Depth32 = 29,
+    Depth32 = 30,
     /** 16-bit depth + 8-bit stencil format. */
-    Depth24Stencil8 = 30,
+    Depth24Stencil8 = 31,
     /** 32-bit depth + 8-bit stencil format. */
-    Depth32Stencil8 = 31
+    Depth32Stencil8 = 32,
+    /** @deprecated Use `TextureFormat.BC1` instead. */
+    DXT1 = 33,
+    /** @deprecated Use `TextureFormat.BC3` instead. */
+    DXT5 = 34
 }

package/types/texture/enums/TextureUsage.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Texture usage.
+ */
+export declare enum TextureUsage {
+    /** The content of the texture is intended to be specified once.  */
+    Static = 0,
+    /** The content of the texture is intended to be updated frequently, with better performance. */
+    Dynamic = 1
+}

package/types/texture/index.d.ts

@@ -3,6 +3,7 @@ export { TextureCubeFace } from "./enums/TextureCubeFace";
 export { TextureDepthCompareFunction } from "./enums/TextureDepthCompareFunction";
 export { TextureFilterMode } from "./enums/TextureFilterMode";
 export { TextureFormat } from "./enums/TextureFormat";
+export { TextureUsage } from "./enums/TextureUsage";
 export { TextureWrapMode } from "./enums/TextureWrapMode";
 export { RenderTarget } from "./RenderTarget";
 export { Texture } from "./Texture";

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/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>;
+}