@galacean/engine-core 1.6.7 → 1.6.8

package/types/2d/text/TextRenderer.d.ts

@@ -1,122 +0,0 @@
-import { BoundingBox, Color } from "@galacean/engine-math";
-import { Entity } from "../../Entity";
-import { RenderContext } from "../../RenderPipeline/RenderContext";
-import { Renderer } from "../../Renderer";
-import { TransformModifyFlags } from "../../Transform";
-import { FontStyle } from "../enums/FontStyle";
-import { SpriteMaskInteraction } from "../enums/SpriteMaskInteraction";
-import { TextHorizontalAlignment, TextVerticalAlignment } from "../enums/TextAlignment";
-import { OverflowMode } from "../enums/TextOverflow";
-import { Font } from "./Font";
-import { ITextRenderer } from "./ITextRenderer";
-import { SpriteMaskLayer } from "../../enums/SpriteMaskLayer";
-/**
- * Renders a text for 2D graphics.
- */
-export declare class TextRenderer extends Renderer implements ITextRenderer {
-    private static _textureProperty;
-    private static _tempVec30;
-    private static _tempVec31;
-    private static _worldPositions;
-    private static _charRenderInfos;
-    private _textChunks;
-    private _color;
-    private _text;
-    private _width;
-    private _height;
-    private _localBounds;
-    private _font;
-    private _fontSize;
-    private _fontStyle;
-    private _lineSpacing;
-    private _horizontalAlignment;
-    private _verticalAlignment;
-    private _enableWrapping;
-    private _overflowMode;
-    /**
-     * Rendering color for the Text.
-     */
-    get color(): Color;
-    set color(value: Color);
-    /**
-     * Rendering string for the Text.
-     */
-    get text(): string;
-    set text(value: string);
-    /**
-     * The width of the TextRenderer (in 3D world coordinates).
-     */
-    get width(): number;
-    set width(value: number);
-    /**
-     * The height of the TextRenderer (in 3D world coordinates).
-     */
-    get height(): number;
-    set height(value: number);
-    /**
-     * The font of the Text.
-     */
-    get font(): Font;
-    set font(value: Font);
-    /**
-     * The font size of the Text.
-     */
-    get fontSize(): number;
-    set fontSize(value: number);
-    /**
-     * The style of the font.
-     */
-    get fontStyle(): FontStyle;
-    set fontStyle(value: FontStyle);
-    /**
-     * The space between two lines (in pixels).
-     */
-    get lineSpacing(): number;
-    set lineSpacing(value: number);
-    /**
-     * The horizontal alignment.
-     */
-    get horizontalAlignment(): TextHorizontalAlignment;
-    set horizontalAlignment(value: TextHorizontalAlignment);
-    /**
-     * The vertical alignment.
-     */
-    get verticalAlignment(): TextVerticalAlignment;
-    set verticalAlignment(value: TextVerticalAlignment);
-    /**
-     * Whether wrap text to next line when exceeds the width of the container.
-     */
-    get enableWrapping(): boolean;
-    set enableWrapping(value: boolean);
-    /**
-     * The overflow mode.
-     */
-    get overflowMode(): OverflowMode;
-    set overflowMode(value: OverflowMode);
-    /**
-     * Interacts with the masks.
-     */
-    get maskInteraction(): SpriteMaskInteraction;
-    set maskInteraction(value: SpriteMaskInteraction);
-    /**
-     * The mask layer the sprite renderer belongs to.
-     */
-    get maskLayer(): SpriteMaskLayer;
-    set maskLayer(value: SpriteMaskLayer);
-    /**
-     * The bounding volume of the TextRenderer.
-     */
-    get bounds(): BoundingBox;
-    constructor(entity: Entity);
-    protected _updateBounds(worldBounds: BoundingBox): void;
-    protected _render(context: RenderContext): void;
-    private _resetSubFont;
-    private _updatePosition;
-    private _updateColor;
-    private _updateLocalData;
-    protected _onTransformChanged(bit: TransformModifyFlags): void;
-    private _isTextNoVisible;
-    private _buildChunk;
-    private _freeTextChunks;
-    private _onColorChanged;
-}

package/types/2d/text/TextUtils.d.ts

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

package/types/2d/text/index.d.ts

@@ -1,5 +0,0 @@
-export { Font } from "./Font";
-export { TextRenderer } from "./TextRenderer";
-export { CharRenderInfo } from "./CharRenderInfo";
-export { SubFont } from "./SubFont";
-export { TextUtils } from "./TextUtils";

package/types/Background.d.ts

@@ -1,53 +0,0 @@
-import { Color } from "@galacean/engine-math";
-import { Engine } from "./Engine";
-import { BackgroundMode } from "./enums/BackgroundMode";
-import { BackgroundTextureFillMode } from "./enums/BackgroundTextureFillMode";
-import { Sky } from "./sky/Sky";
-import { Texture2D } from "./texture";
-/**
- * Background of scene.
- */
-export declare class Background {
-    private _engine;
-    /**
-     * Background mode.
-     * @defaultValue `BackgroundMode.SolidColor`
-     * @remarks If using `BackgroundMode.Sky` mode and material or mesh of the `sky` is not defined, it will downgrade to `BackgroundMode.SolidColor`.
-     */
-    mode: BackgroundMode;
-    /**
-     * Background sky.
-     * @remarks When `mode` is `BackgroundMode.Sky`, the property will take effects.
-     */
-    readonly sky: Sky;
-    private _solidColor;
-    private _texture;
-    /**
-     * Background solid color.
-     * @defaultValue `new Color(0.05, 0.05, 0.05, 1.0)`
-     * @remarks When `mode` is `BackgroundMode.SolidColor`, the property will take effects.
-     */
-    get solidColor(): Color;
-    set solidColor(value: Color);
-    /**
-     * Background texture.
-     * @remarks When `mode` is `BackgroundMode.Texture`, the property will take effects.
-     */
-    get texture(): Texture2D;
-    set texture(value: Texture2D);
-    /**
-     * Background texture fill mode.
-     * @remarks When `mode` is `BackgroundMode.Texture`, the property will take effects.
-     * @defaultValue `BackgroundTextureFillMode.FitHeight`
-     */
-    get textureFillMode(): BackgroundTextureFillMode;
-    set textureFillMode(value: BackgroundTextureFillMode);
-    /**
-     * Constructor of Background.
-     * @param _engine Engine Which the background belongs to.
-     */
-    constructor(_engine: Engine);
-    private _initMesh;
-    private _initMaterial;
-    private _createPlane;
-}

package/types/BasicResources.d.ts

@@ -1,2 +0,0 @@
-import { RenderStateElementKey } from "./shader/enums/RenderStateElementKey";
-export type RenderStateElementMap = Record<RenderStateElementKey, number | boolean>;

package/types/BoolUpdateFlag.d.ts

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

package/types/Camera.d.ts

@@ -1,321 +0,0 @@
-import { Matrix, Ray, Rect, Vector2, Vector3, Vector4 } from "@galacean/engine-math";
-import { Component } from "./Component";
-import { Layer } from "./Layer";
-import { AntiAliasing } from "./enums/AntiAliasing";
-import { CameraClearFlags } from "./enums/CameraClearFlags";
-import { DepthTextureMode } from "./enums/DepthTextureMode";
-import { Downsampling } from "./enums/Downsampling";
-import { MSAASamples } from "./enums/MSAASamples";
-import { ReplacementFailureStrategy } from "./enums/ReplacementFailureStrategy";
-import { Shader } from "./shader/Shader";
-import { ShaderData } from "./shader/ShaderData";
-import { ShaderTagKey } from "./shader/ShaderTagKey";
-import { RenderTarget } from "./texture/RenderTarget";
-import { TextureCubeFace } from "./texture/enums/TextureCubeFace";
-/**
- * Camera component, as the entrance to the three-dimensional world.
- * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
- */
-export declare class Camera extends Component {
-    private static _inverseViewMatrixProperty;
-    private static _cameraPositionProperty;
-    private static _cameraForwardProperty;
-    private static _cameraUpProperty;
-    private static _cameraDepthBufferParamsProperty;
-    /** Whether to enable frustum culling, it is enabled by default. */
-    enableFrustumCulling: boolean;
-    /**
-     * Determining what to clear when rendering by a Camera.
-     *
-     * @defaultValue `CameraClearFlags.All`
-     */
-    clearFlags: CameraClearFlags;
-    /**
-     * Culling mask - which layers the camera renders.
-     * @remarks Support bit manipulation, corresponding to `Layer`.
-     */
-    cullingMask: Layer;
-    /**
-     * Determines which PostProcess to use.
-     */
-    postProcessMask: 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;
-    /**
-     * The screen-space anti-aliasing mode applied after the camera renders the final image.
-     * Unlike MSAA, it can smooth all pixels, including by shader-generated specular, alpha-cutoff edge.
-     *
-     * @defaultValue `AntiAliasing.None`
-     */
-    antiAliasing: AntiAliasing;
-    /**
-     * Determines whether to preserve the alpha channel in the output.
-     * When set to true, the alpha channel is always preserved.
-     * When set to false, the engine automatically decides whether to preserve it.
-     *
-     * @remarks
-     * Set to true if you need to ensure the alpha channel is preserved, for example, when performing canvas transparent blending.
-     *
-     * @defaultValue `false`
-     */
-    isAlphaOutputRequired: boolean;
-    private _priority;
-    private _isCustomViewMatrix;
-    private _isCustomProjectionMatrix;
-    private _fieldOfView;
-    private _orthographicSize;
-    private _isProjectionDirty;
-    private _isInvProjMatDirty;
-    private _customAspectRatio;
-    private _opaqueTextureEnabled;
-    private _enableHDR;
-    private _enablePostProcess;
-    private _msaaSamples;
-    private _renderTarget;
-    private _updateFlagManager;
-    private _frustumChangeFlag;
-    private _isViewMatrixDirty;
-    private _isInvViewProjDirty;
-    private _shaderData;
-    private _depthBufferParams;
-    private _viewport;
-    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`
-     */
-    get opaqueTextureEnabled(): boolean;
-    set opaqueTextureEnabled(value: boolean);
-    /**
-     * Shader data.
-     */
-    get shaderData(): ShaderData;
-    /**
-     * Near clip plane - the closest point to the camera when rendering occurs.
-     */
-    get nearClipPlane(): number;
-    set nearClipPlane(value: number);
-    /**
-     * Far clip plane - the furthest point to the camera when rendering occurs.
-     */
-    get farClipPlane(): number;
-    set farClipPlane(value: number);
-    /**
-     * The camera's view angle. activating when camera use perspective projection.
-     */
-    get fieldOfView(): number;
-    set fieldOfView(value: number);
-    /**
-     * Aspect ratio. The default is automatically calculated by the viewport's aspect ratio. If it is manually set,
-     * the manual value will be kept. Call resetAspectRatio() to restore it.
-     */
-    get aspectRatio(): number;
-    set aspectRatio(value: number);
-    /**
-     * The viewport of the camera in normalized coordinates on the screen.
-     * In normalized screen coordinates, the upper-left corner is (0, 0), and the lower-right corner is (1.0, 1.0).
-     * @remarks Re-assignment is required after modification to ensure that the modification takes effect.
-     */
-    get viewport(): Vector4;
-    set viewport(value: Vector4);
-    /**
-     * The viewport of the camera in pixel coordinates on the screen.
-     * In pixel screen coordinates, the upper-left corner is (0, 0), and the lower-right corner is (1.0, 1.0).
-     */
-    get pixelViewport(): Rect;
-    /**
-     * Rendering priority, higher priority will be rendered on top of a camera with lower priority.
-     */
-    get priority(): number;
-    set priority(value: number);
-    /**
-     * Whether it is orthogonal, the default is false. True will use orthographic projection, false will use perspective projection.
-     */
-    get isOrthographic(): boolean;
-    set isOrthographic(value: boolean);
-    /**
-     * Half the size of the camera in orthographic mode.
-     */
-    get orthographicSize(): number;
-    set orthographicSize(value: number);
-    /**
-     * View matrix.
-     */
-    get viewMatrix(): Readonly<Matrix>;
-    set viewMatrix(value: Matrix);
-    /**
-     * The projection matrix is ​​calculated by the relevant parameters of the camera by default.
-     * If it is manually set, the manual value will be maintained. Call resetProjectionMatrix() to restore it.
-     */
-    get projectionMatrix(): Readonly<Matrix>;
-    set projectionMatrix(value: Matrix);
-    /**
-     * Whether to enable HDR.
-     * @defaultValue `false`
-     */
-    get enableHDR(): boolean;
-    set enableHDR(value: boolean);
-    /**
-     * Whether to enable post process.
-     * @defaultValue `false`
-     */
-    get enablePostProcess(): boolean;
-    set enablePostProcess(value: boolean);
-    /**
-     * RenderTarget. After setting, it will be rendered to the renderTarget. If it is empty, it will be rendered to the main canvas.
-     */
-    get renderTarget(): RenderTarget | null;
-    set renderTarget(value: RenderTarget | null);
-    /**
-     * The number of samples used for hardware multisample anti-aliasing (MSAA) to smooth geometry edges during rasterization.
-     * Higher sample counts (e.g., 2x, 4x, 8x) produce smoother edges.
-     *
-     * @defaultValue `MSAASamples.FourX`
-     */
-    get msaaSamples(): MSAASamples;
-    set msaaSamples(value: MSAASamples);
-    /**
-     * Restore the view matrix to the world matrix of the entity.
-     */
-    resetViewMatrix(): void;
-    /**
-     * Restore the automatic calculation of projection matrix through fieldOfView, nearClipPlane and farClipPlane.
-     */
-    resetProjectionMatrix(): void;
-    /**
-     * Restore the automatic calculation of the aspect ratio through the viewport aspect ratio.
-     */
-    resetAspectRatio(): void;
-    /**
-     * Transform a point from world space to viewport space.
-     * @param point - Point in world space
-     * @param out - Point in viewport space, X and Y are the camera viewport space coordinates, Z is in world space units from the plane that camera forward is normal to
-     * @returns Point in viewport space
-     */
-    worldToViewportPoint(point: Vector3, out: Vector3): Vector3;
-    /**
-     * Transform a point from viewport space to world space.
-     * @param point - Point in viewport space, X and Y are the camera viewport space coordinates, Z is in world space units from the plane that camera forward is normal to
-     * @param out - Point in world space
-     * @returns Point in world space
-     */
-    viewportToWorldPoint(point: Vector3, out: Vector3): Vector3;
-    /**
-     * Generate a ray by a point in viewport.
-     * @param point - Point in viewport space, X and Y are the camera viewport space coordinates
-     * @param out - Ray
-     * @returns Ray
-     */
-    viewportPointToRay(point: Vector2, out: Ray): Ray;
-    /**
-     * Transform the X and Y coordinates of a point from screen space to viewport space
-     * @param point - Point in screen space
-     * @param out - Point in viewport space
-     * @returns Point in viewport space
-     */
-    screenToViewportPoint<T extends Vector2 | Vector3>(point: Vector3 | Vector2, out: T): T;
-    /**
-     * Transform the X and Y coordinates of a point from viewport space to screen space.
-     * @param point - Point in viewport space
-     * @param out - Point in screen space
-     * @returns Point in screen space
-     */
-    viewportToScreenPoint<T extends Vector2 | Vector3 | Vector4>(point: T, out: T): T;
-    /**
-     * Transform a point from world space to screen space.
-     *
-     * @remarks
-     * Screen space is defined in pixels, the left-top of the screen is (0,0), the right-top is (canvasPixelWidth,canvasPixelHeight).
-     *
-     * @param point - Point in world space
-     * @param out - The result will be stored
-     * @returns X and Y are the coordinates of the point in screen space, Z is the distance from the camera in world space
-     */
-    worldToScreenPoint(point: Vector3, out: Vector3): Vector3;
-    /**
-     * Transform a point from screen space to world space.
-     *
-     * @param point - Screen space point, the top-left of the screen is (0,0), the right-bottom is (pixelWidth,pixelHeight), The z position is in world units from the camera
-     * @param out - Point in world space
-     * @returns Point in world space
-     */
-    screenToWorldPoint(point: Vector3, out: Vector3): Vector3;
-    /**
-     * Generate a ray by a point in screen.
-     * @param point - Point in screen space, the top-left of the screen is (0,0), the right-bottom is (pixelWidth,pixelHeight)
-     * @param out - Ray
-     * @returns Ray
-     */
-    screenPointToRay(point: Vector2, out: Ray): Ray;
-    /**
-     * Manually call the rendering of the camera.
-     * @param cubeFace - Cube rendering surface collection
-     * @param mipLevel - Set mip level the data want to write, only take effect in webgl2.0
-     */
-    render(cubeFace?: TextureCubeFace, mipLevel?: number): void;
-    /**
-     * Set the replacement shader.
-     * @param shader - Replacement shader
-     * @param replacementTagName - Sub shader tag name
-     * @param failureStrategy - Replacement failure strategy, @defaultValue `ReplacementFailureStrategy.KeepOriginalShader`
-     *
-     * @remarks
-     * If replacementTagName is not specified, the first sub shader will be replaced.
-     * If replacementTagName is specified, the replacement shader will find the first sub shader which has the same tag value get by replacementTagKey. If failed to find the sub shader, the strategy will be determined by failureStrategy.
-     */
-    setReplacementShader(shader: Shader, replacementTagName?: string, failureStrategy?: ReplacementFailureStrategy): any;
-    /**
-     * Set the replacement shader.
-     * @param shader - Replacement shader
-     * @param replacementTag - Sub shader tag
-     * @param failureStrategy - Replacement failure strategy, @defaultValue `ReplacementFailureStrategy.KeepOriginalShader`
-     *
-     * @remarks
-     * If replacementTag is not specified, the first sub shader will be replaced.
-     * If replacementTag is specified, the replacement shader will find the first sub shader which has the same tag value get by replacementTagKey. If failed to find the sub shader, the strategy will be determined by failureStrategy.
-     */
-    setReplacementShader(shader: Shader, replacementTag?: ShaderTagKey, failureStrategy?: ReplacementFailureStrategy): any;
-    /**
-     * Reset and clear the replacement shader.
-     */
-    resetReplacementShader(): void;
-    /**
-     * @inheritdoc
-     */
-    _onEnableInScene(): void;
-    /**
-     * @inheritdoc
-     */
-    _onDisableInScene(): void;
-    private _updatePixelViewport;
-    private _adjustPixelViewport;
-    private _viewMatrixChange;
-    private _projectionMatrixChange;
-    private _innerViewportToWorldPoint;
-    private _updateShaderData;
-    /**
-     * The inverse matrix of view projection matrix.
-     */
-    private _getInvViewProjMat;
-    /**
-     * The inverse of the projection matrix.
-     */
-    private _getInverseProjectionMatrix;
-    private _onPixelViewportChanged;
-    private _dispatchModify;
-}

package/types/Canvas.d.ts

@@ -1,19 +0,0 @@
-/**
- * Canvas.
- */
-export declare abstract class Canvas {
-    private _width;
-    private _height;
-    /**
-     * The width of the canvas.
-     */
-    get width(): number;
-    set width(value: number);
-    /**
-     *The height of the canvas.
-     */
-    get height(): number;
-    set height(value: number);
-    protected abstract _onWidthChanged(value: number): void;
-    protected abstract _onHeightChange(value: number): void;
-}

package/types/Component.d.ts

@@ -1,27 +0,0 @@
-import { IReferable } from "./asset/IReferable";
-import { EngineObject } from "./base";
-import { Entity } from "./Entity";
-import { Scene } from "./Scene";
-/**
- * The base class of the components.
- */
-export declare class Component extends EngineObject {
-    protected _phasedActiveInScene: boolean;
-    private _phasedActive;
-    private _enabled;
-    /**
-     * Indicates whether the component is enabled.
-     */
-    get enabled(): boolean;
-    set enabled(value: boolean);
-    /**
-     * The entity which the component belongs to.
-     */
-    get entity(): Entity;
-    /**
-     * The scene which the component's entity belongs to.
-     */
-    get scene(): Scene;
-    constructor(entity: Entity);
-    protected _addResourceReferCount(resource: IReferable, count: number): void;
-}

package/types/ComponentsDependencies.d.ts

@@ -1,25 +0,0 @@
-import { Component } from "./Component";
-import { Entity } from "./Entity";
-type ComponentConstructor = new (entity: Entity) => Component;
-/**
- * Declare dependent component.
- * @param component - Dependent component
- * @param dependentMode - Dependent mode
- */
-export declare function dependentComponents(component: ComponentConstructor, dependentMode?: DependentMode): any;
-/**
- * Declare dependent components.
- * @param components - Dependent components
- * @param dependentMode - Dependent mode
- */
-export declare function dependentComponents(components: ComponentConstructor[], dependentMode?: DependentMode): any;
-/**
- * Dependent mode.
- */
-export declare enum DependentMode {
-    /** Check only, throw error if dependent components do not exist. */
-    CheckOnly = 0,
-    /** Auto add if dependent components do not exist. */
-    AutoAdd = 1
-}
-export {};

package/types/ComponentsManager.d.ts

@@ -1,52 +0,0 @@
-import { Camera } from "./Camera";
-import { Component } from "./Component";
-import { Renderer } from "./Renderer";
-import { Script } from "./Script";
-import { Animator } from "./animation";
-import { IUICanvas } from "./ui/IUICanvas";
-/**
- * The manager of the components.
- */
-export declare class ComponentsManager {
-    private _onStartScripts;
-    private _onUpdateScripts;
-    private _onLateUpdateScripts;
-    private _onPhysicsUpdateScripts;
-    private _pendingDestroyScripts;
-    private _disposeDestroyScripts;
-    private _onUpdateAnimations;
-    private _onUpdateRenderers;
-    private _componentsContainerPool;
-    addCamera(camera: Camera): void;
-    removeCamera(camera: Camera): void;
-    sortCameras(): void;
-    addRenderer(renderer: Renderer): void;
-    removeRenderer(renderer: Renderer): void;
-    addUICanvas(uiCanvas: IUICanvas, isOverlay: boolean): void;
-    removeUICanvas(uiCanvas: IUICanvas, isOverlay: boolean): void;
-    sortOverlayUICanvases(): void;
-    addOnStartScript(script: Script): void;
-    removeOnStartScript(script: Script): void;
-    addOnUpdateScript(script: Script): void;
-    removeOnUpdateScript(script: Script): void;
-    addOnLateUpdateScript(script: Script): void;
-    removeOnLateUpdateScript(script: Script): void;
-    addOnPhysicsUpdateScript(script: Script): void;
-    removeOnPhysicsUpdateScript(script: Script): void;
-    addOnUpdateAnimations(animation: Animator): void;
-    removeOnUpdateAnimations(animation: Animator): void;
-    addOnUpdateRenderers(renderer: Renderer): void;
-    removeOnUpdateRenderers(renderer: Renderer): void;
-    addPendingDestroyScript(component: Script): void;
-    callScriptOnStart(): void;
-    callScriptOnUpdate(deltaTime: number): void;
-    callScriptOnLateUpdate(deltaTime: number): void;
-    callScriptOnPhysicsUpdate(): void;
-    callAnimationUpdate(deltaTime: number): void;
-    callRendererOnUpdate(deltaTime: number): void;
-    handlingInvalidScripts(): void;
-    callCameraOnBeginRender(camera: Camera): void;
-    callCameraOnEndRender(camera: Camera): void;
-    getActiveChangedTempList(): Component[];
-    putActiveChangedTempList(componentContainer: Component[]): void;
-}