@galacean/engine-core 1.2.0-alpha.13 → 1.2.0-alpha.14

package/package.json

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

package/types/Camera.d.ts

@@ -3,6 +3,8 @@ import { Component } from "./Component";
 import { Layer } from "./Layer";
 import { CameraClearFlags } from "./enums/CameraClearFlags";
 import { DepthTextureMode } from "./enums/DepthTextureMode";
+import { Downsampling } from "./enums/Downsampling";
+import { MSAASamples } from "./enums/MSAASamples";
 import { Shader } from "./shader/Shader";
 import { ShaderData } from "./shader/ShaderData";
 import { ShaderTagKey } from "./shader/ShaderTagKey";
@@ -22,6 +24,7 @@ export declare class Camera extends Component {
     enableFrustumCulling: boolean;
     /**
      * Determining what to clear when rendering by a Camera.
+     *
      * @defaultValue `CameraClearFlags.All`
      */
     clearFlags: CameraClearFlags;
@@ -32,9 +35,23 @@ export declare class Camera extends Component {
     cullingMask: Layer;
     /**
      * Depth texture mode.
+     * If `DepthTextureMode.PrePass` is used, the depth texture can be accessed in the shader using `camera_DepthTexture`.
+     *
      * @defaultValue `DepthTextureMode.None`
      */
     depthTextureMode: DepthTextureMode;
+    /**
+     * Opacity texture down sampling.
+     *
+     * @defaultValue `Downsampling.TwoX`
+     */
+    opaqueTextureDownsampling: Downsampling;
+    /**
+     * Multi-sample anti-aliasing samples when use independent canvas mode.
+     *
+     * @remarks The `independentCanvasEnabled` property should be `true` to take effect, otherwise it will be invalid.
+     */
+    msaaSamples: MSAASamples;
     private _priority;
     private _shaderData;
     private _isCustomViewMatrix;
@@ -46,6 +63,8 @@ export declare class Camera extends Component {
     private _customAspectRatio;
     private _renderTarget;
     private _depthBufferParams;
+    private _customIndependentCanvas;
+    private _opaqueTextureEnabled;
     private _frustumChangeFlag;
     private _transform;
     private _isViewMatrixDirty;
@@ -54,6 +73,23 @@ export declare class Camera extends Component {
     private _pixelViewport;
     private _inverseProjectionMatrix;
     private _invViewProjMat;
+    /**
+     * Whether to enable opaque texture.
+     * If enabled, the opaque texture can be accessed in the shader using `camera_OpaqueTexture`.
+     *
+     * @defaultValue `false`
+     *
+     * @remarks If enabled, the `independentCanvasEnabled` property will be forced to be true.
+     */
+    get opaqueTextureEnabled(): boolean;
+    set opaqueTextureEnabled(value: boolean);
+    /**
+     * Whether to use an independent canvas in viewport area.
+     *
+     * @remarks If true, the msaa in viewport can turn or off independently by `msaaSamples` property.
+     */
+    get independentCanvasEnabled(): boolean;
+    set independentCanvasEnabled(value: boolean);
     /**
      * Shader data.
      */
@@ -252,5 +288,7 @@ export declare class Camera extends Component {
      * The inverse of the projection matrix.
      */
     private _getInverseProjectionMatrix;
+    private _forceUseInternalCanvas;
     private _onPixelViewportChanged;
+    private _checkMainCanvasAntialiasWaste;
 }

package/types/RenderPipeline/BasicRenderPipeline.d.ts

@@ -1,49 +1,23 @@
 import { Camera } from "../Camera";
-import { Layer } from "../Layer";
 import { CameraClearFlags } from "../enums/CameraClearFlags";
-import { Material } from "../material";
-import { RenderTarget, TextureCubeFace } from "../texture";
+import { TextureCubeFace } from "../texture";
 import { RenderContext } from "./RenderContext";
 import { RenderData } from "./RenderData";
-import { RenderPass } from "./RenderPass";
 /**
  * Basic render pipeline.
  */
 export declare class BasicRenderPipeline {
     private _camera;
-    private _defaultPass;
-    private _renderPassArray;
     private _lastCanvasSize;
-    private _cascadedShadowCaster;
+    private _internalColorTarget;
+    private _cascadedShadowCasterPass;
     private _depthOnlyPass;
+    private _opaqueTexturePass;
     /**
      * Create a basic render pipeline.
      * @param camera - Camera
      */
     constructor(camera: Camera);
-    /**
-     * Default render pass.
-     */
-    get defaultRenderPass(): RenderPass;
-    /**
-     * Add render pass.
-     * @param nameOrPass - The name of this Pass or RenderPass object. When it is a name, the following parameters need to be provided
-     * @param priority - Priority, less than 0 before the default pass, greater than 0 after the default pass
-     * @param renderTarget - The specified Render Target
-     * @param replaceMaterial -  Replaced material
-     * @param mask - Perform bit and operations with Entity.Layer to filter the objects that this Pass needs to render
-     */
-    addRenderPass(nameOrPass: string | RenderPass, priority?: number, renderTarget?: RenderTarget, replaceMaterial?: Material, mask?: Layer): void;
-    /**
-     * Remove render pass by name or render pass object.
-     * @param nameOrPass - Render pass name or render pass object
-     */
-    removeRenderPass(nameOrPass: string | RenderPass): void;
-    /**
-     * Get render pass by name.
-     * @param  name - Render pass name
-     */
-    getRenderPass(name: string): RenderPass;
     /**
      * Destroy internal resources.
      */

package/types/RenderPipeline/RenderQueue.d.ts

@@ -1,6 +1,5 @@
 import { Camera } from "../Camera";
 import { Engine } from "../Engine";
-import { Layer } from "../Layer";
 import { RenderQueueType } from "../shader";
 import { RenderElement } from "./RenderElement";
 /**
@@ -15,7 +14,7 @@ export declare class RenderQueue {
      * Push a render element.
      */
     pushRenderElement(element: RenderElement): void;
-    render(camera: Camera, mask: Layer, pipelineStageTagValue: string): void;
+    render(camera: Camera, pipelineStageTagValue: string): void;
     /**
      * Clear collection.
      */

package/types/RenderPipeline/index.d.ts

@@ -1,4 +1,3 @@
 export { BasicRenderPipeline } from "./BasicRenderPipeline";
 export { PipelineStage } from "./enums/PipelineStage";
-export { RenderPass } from "./RenderPass";
 export { RenderQueue } from "./RenderQueue";

package/types/Renderer.d.ts

@@ -1,5 +1,6 @@
-import { BoundingBox, Vector4 } from "@galacean/engine-math";
+import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
+import { RenderContext } from "./RenderPipeline/RenderContext";
 import { IComponentCustomClone } from "./clone/ComponentCloner";
 import { Material } from "./material";
 import { ShaderData } from "./shader/ShaderData";
@@ -110,5 +111,7 @@ export declare class Renderer extends Component implements IComponentCustomClone
      */
     setMaterials(materials: Material[]): void;
     update(deltaTime: number): void;
+    protected _updateTransformShaderData(context: RenderContext, worldMatrix: Matrix): void;
+    protected _updateMVPShaderData(context: RenderContext, worldMatrix: Matrix): void;
     private _setMaterial;
 }

package/types/animation/AnimatorLayerMask.d.ts

@@ -27,7 +27,7 @@ export declare class AnimatorLayerMask {
      * Removes a path mask from the AnimatorLayerMask.
      * @param path - The path of the mask to remove
      */
-    removePathMask(path: any): void;
+    removePathMask(path: string): void;
     /**
      * Get a path mask based on the given path.
      * @param path - The path of the mask to get

package/types/index.d.ts

@@ -30,6 +30,8 @@ export { DepthTextureMode } from "./enums/DepthTextureMode";
 export { FogMode } from "./enums/FogMode";
 export { CameraClearFlags } from "./enums/CameraClearFlags";
 export { CameraType } from "./enums/CameraType";
+export { MSAASamples } from "./enums/MSAASamples";
+export { Downsampling } from "./enums/Downsampling";
 export { ColorSpace } from "./enums/ColorSpace";
 export { BackgroundTextureFillMode } from "./enums/BackgroundTextureFillMode";
 export { XRManager } from "./xr/XRManager";

package/types/mesh/SkinnedMeshRenderer.d.ts

@@ -1,5 +1,6 @@
 import { BoundingBox } from "@galacean/engine-math";
 import { Entity } from "../Entity";
+import { RenderContext } from "../RenderPipeline/RenderContext";
 import { MeshRenderer } from "./MeshRenderer";
 import { Skin } from "./Skin";
 /**
@@ -38,6 +39,7 @@ export declare class SkinnedMeshRenderer extends MeshRenderer {
      */
     get bones(): ReadonlyArray<Entity>;
     set bones(value: ReadonlyArray<Entity>);
+    _updateShaderData(context: RenderContext, onlyMVP: boolean): void;
     private _checkBlendShapeWeightLength;
     private _onLocalBoundsChanged;
     private _getEntityHierarchyPath;

package/types/renderingHardwareInterface/IPlatformRenderTarget.d.ts

@@ -5,10 +5,10 @@ import { TextureCubeFace } from "../texture";
 export interface IPlatformRenderTarget {
     /**
      * Set which face and mipLevel of the cube texture to render to.
-     * @param faceIndex - Cube texture face
      * @param mipLevel - Set mip level the data want to write
+     * @param faceIndex - Cube texture face
      */
-    setRenderTargetInfo(faceIndex: TextureCubeFace, mipLevel: number): void;
+    activeRenderTarget(mipLevel: number, faceIndex?: TextureCubeFace): void;
     /**
      * Blit FBO.
      */

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

@@ -6,9 +6,9 @@ export declare class DepthState {
     private static _getGLCompareFunction;
     /** Whether to enable the depth test. */
     enabled: boolean;
-    /** Whether the depth value can be written.*/
-    writeEnabled: boolean;
     /** Depth comparison function. */
     compareFunction: CompareFunction;
+    /** Whether the depth value can be written.*/
+    writeEnabled: boolean;
     private _platformApply;
 }

package/types/texture/RenderTarget.d.ts

@@ -1,6 +1,7 @@
 import { GraphicsResource } from "../asset/GraphicsResource";
 import { Engine } from "../Engine";
 import { RenderBufferDepthFormat } from "./enums/RenderBufferDepthFormat";
+import { TextureFormat } from "./enums/TextureFormat";
 import { Texture } from "./Texture";
 /**
  * The render target used for off-screen rendering.
@@ -43,10 +44,10 @@ export declare class RenderTarget extends GraphicsResource {
      * @param width - Render target width
      * @param height - Render target height
      * @param colorTexture - Render color texture
-     * @param depthFormat - Depth format. default RenderBufferDepthFormat.Depth, engine will automatically select the supported precision
+     * @param depthFormat - Depth format. default TextureFormat.Depth, engine will automatically select the supported precision
      * @param antiAliasing - Anti-aliasing level, default is 1
      */
-    constructor(engine: Engine, width: number, height: number, colorTexture: Texture, depthFormat?: RenderBufferDepthFormat | null, antiAliasing?: number);
+    constructor(engine: Engine, width: number, height: number, colorTexture: Texture, depthFormat?: TextureFormat | null | RenderBufferDepthFormat, antiAliasing?: number);
     /**
      * Create a render target through color texture and depth format.
      * @remarks If the color texture is not transmitted, only the depth texture is generated.
@@ -64,10 +65,10 @@ export declare class RenderTarget extends GraphicsResource {
      * @param width - Render target width
      * @param height - Render target height
      * @param colorTextures - Render color texture array
-     * @param depthFormat - Depth format. default RenderBufferDepthFormat.Depth,engine will automatically select the supported precision
+     * @param depthFormat - Depth format. default TextureFormat.Depth,engine will automatically select the supported precision
      * @param antiAliasing - Anti-aliasing level, default is 1
      */
-    constructor(engine: Engine, width: number, height: number, colorTextures: Texture[], depthFormat?: RenderBufferDepthFormat | null, antiAliasing?: number);
+    constructor(engine: Engine, width: number, height: number, colorTextures: Texture[], depthFormat?: TextureFormat | null | RenderBufferDepthFormat, antiAliasing?: number);
     /**
      * Create a render target with color texture array and depth texture.
      * @param engine - Define the engine to use for this off-screen rendering

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

@@ -1,21 +1,23 @@
 /**
+ * @deprecated Please use `TextureFormat` instead.
+ *
  * Render buffer depth format enumeration.
  */
 export declare enum RenderBufferDepthFormat {
     /** Render to depth buffer,engine will automatically select the supported precision. */
-    Depth = 0,
-    /** Render to depth stencil buffer, engine will automatically select the supported precision. */
-    DepthStencil = 1,
+    Depth = 27,
     /** Render to stencil buffer. */
-    Stencil = 2,
+    Stencil = 28,
+    /** Render to depth stencil buffer, engine will automatically select the supported precision. */
+    DepthStencil = 29,
     /** Force 16-bit depth buffer. */
-    Depth16 = 3,
+    Depth16 = 30,
     /** Force 24-bit depth buffer. */
-    Depth24 = 4,
+    Depth24 = 31,
     /** Force 32-bit depth buffer. */
-    Depth32 = 5,
+    Depth32 = 32,
     /** Force 16-bit depth + 8-bit stencil buffer. */
-    Depth24Stencil8 = 6,
+    Depth24Stencil8 = 33,
     /** Force 32-bit depth + 8-bit stencil buffer. */
-    Depth32Stencil8 = 7
+    Depth32Stencil8 = 34
 }

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

@@ -58,20 +58,22 @@ export declare enum TextureFormat {
     ASTC_12x12 = 26,
     /** Automatic depth format, engine will automatically select the supported precision. */
     Depth = 27,
+    /** Render to stencil buffer. */
+    Stencil = 28,
     /** Automatic depth stencil format, engine will automatically select the supported precision. */
-    DepthStencil = 28,
+    DepthStencil = 29,
     /** 16-bit depth format. */
-    Depth16 = 29,
+    Depth16 = 30,
     /** 24-bit depth format. */
-    Depth24 = 30,
+    Depth24 = 31,
     /** 32-bit depth format. */
-    Depth32 = 31,
+    Depth32 = 32,
     /** 16-bit depth + 8-bit stencil format. */
-    Depth24Stencil8 = 32,
+    Depth24Stencil8 = 33,
     /** 32-bit depth + 8-bit stencil format. */
-    Depth32Stencil8 = 33,
+    Depth32Stencil8 = 34,
     /** @deprecated Use `TextureFormat.BC1` instead. */
-    DXT1 = 34,
+    DXT1 = 10,
     /** @deprecated Use `TextureFormat.BC3` instead. */
-    DXT5 = 35
+    DXT5 = 11
 }