@galacean/engine-core 1.6.6 → 1.6.8

package/types/Engine.d.ts

@@ -1,150 +0,0 @@
-import { IHardwareRenderer, IInputOptions, IPhysics, IShaderLab, IXRDevice } from "@galacean/engine-design";
-import { Canvas } from "./Canvas";
-import { EngineSettings } from "./EngineSettings";
-import { Entity } from "./Entity";
-import { SceneManager } from "./SceneManager";
-import { ResourceManager } from "./asset/ResourceManager";
-import { EventDispatcher, Time } from "./base";
-import { InputManager } from "./input";
-import { ParticleBufferUtils } from "./particle/ParticleBufferUtils";
-import { PostProcessPass } from "./postProcess/PostProcessPass";
-import { XRManager } from "./xr/XRManager";
-/**
- * Engine.
- */
-export declare class Engine extends EventDispatcher {
-    /** Input manager of Engine. */
-    readonly inputManager: InputManager;
-    /** XR manager of Engine. */
-    readonly xrManager: XRManager;
-    _particleBufferUtils: ParticleBufferUtils;
-    private _settings;
-    private _resourceManager;
-    private _sceneManager;
-    private _vSyncCount;
-    private _targetFrameRate;
-    private _time;
-    private _isPaused;
-    private _requestId;
-    private _timeoutId;
-    private _vSyncCounter;
-    private _targetFrameInterval;
-    private _destroyed;
-    private _frameInProcess;
-    private _waitingDestroy;
-    private _waitingGC;
-    private _postProcessPasses;
-    private _activePostProcessPasses;
-    private _animate;
-    /**
-     * Settings of Engine.
-     */
-    get settings(): EngineSettings;
-    /**
-     * The canvas to use for rendering.
-     */
-    get canvas(): Canvas;
-    /**
-     * The resource manager.
-     */
-    get resourceManager(): ResourceManager;
-    /**
-     * The scene manager.
-     */
-    get sceneManager(): SceneManager;
-    /**
-     * The time information of the engine.
-     */
-    get time(): Time;
-    /**
-     * Whether the engine is paused.
-     */
-    get isPaused(): boolean;
-    /**
-     * The number of vertical synchronization means the number of vertical blanking for one frame.
-     * @remarks 0 means that the vertical synchronization is turned off.
-     */
-    get vSyncCount(): number;
-    set vSyncCount(value: number);
-    /**
-     * Set the target frame rate you want to achieve.
-     * @remarks
-     * It only takes effect when vSyncCount = 0 (ie, vertical synchronization is turned off).
-     * The larger the value, the higher the target frame rate, Number.POSITIVE_INFINITY represents the infinite target frame rate.
-     */
-    get targetFrameRate(): number;
-    set targetFrameRate(value: number);
-    /**
-     * All post process passes.
-     */
-    get postProcessPasses(): ReadonlyArray<PostProcessPass>;
-    /**
-     * Indicates whether the engine is destroyed.
-     */
-    get destroyed(): boolean;
-    protected constructor(canvas: Canvas, hardwareRenderer: IHardwareRenderer, configuration: EngineConfiguration);
-    /**
-     * Create an entity.
-     * @param name - The name of the entity
-     * @returns Entity
-     */
-    createEntity(name?: string): Entity;
-    /**
-     * Pause the engine.
-     */
-    pause(): void;
-    /**
-     * Resume the engine.
-     */
-    resume(): void;
-    /**
-     * Update the engine loop manually. If you call engine.run(), you generally don't need to call this function.
-     */
-    update(): void;
-    /**
-     * Execution engine loop.
-     */
-    run(): void;
-    /**
-     * Force lose graphic device.
-     * @remarks Used to simulate the phenomenon after the real loss of device.
-     */
-    forceLoseDevice(): void;
-    /**
-     * Force restore graphic device.
-     * @remarks Used to simulate the phenomenon after the real restore of device.
-     */
-    forceRestoreDevice(): void;
-    /**
-     * Add a post process pass.
-     * @param pass - Post process pass to add
-     */
-    addPostProcessPass(pass: PostProcessPass): void;
-    private _destroy;
-    /**
-     * Destroy engine.
-     * @remarks If call during frame execution will delay until the end of the frame
-     */
-    destroy(): void;
-    private _onDeviceLost;
-    private _onDeviceRestored;
-    private _gc;
-    /**
-     * @deprecated
-     * The first scene physics manager.
-     */
-    get physicsManager(): import("./physics").PhysicsScene;
-}
-/**
- * Engine configuration.
- */
-export interface EngineConfiguration {
-    /** Physics. */
-    physics?: IPhysics;
-    /** XR Device. */
-    xrDevice?: IXRDevice;
-    /** Shader lab. */
-    shaderLab?: IShaderLab;
-    /** Input options. */
-    input?: IInputOptions;
-}

package/types/EngineSettings.d.ts

@@ -1,5 +0,0 @@
-/**
- * Render settings.
- */
-export interface EngineSettings {
-}

package/types/Entity.d.ts

@@ -1,171 +0,0 @@
-import { Matrix } from "@galacean/engine-math";
-import { BoolUpdateFlag } from "./BoolUpdateFlag";
-import { Component } from "./Component";
-import { Engine } from "./Engine";
-import { Layer } from "./Layer";
-import { Scene } from "./Scene";
-import { Transform } from "./Transform";
-import { EngineObject } from "./base";
-/**
- * Entity, be used as components container.
- */
-export declare class Entity extends EngineObject {
-    /** The name of entity. */
-    name: string;
-    /** The layer the entity belongs to. */
-    layer: Layer;
-    private _transform;
-    private _templateResource;
-    private _parent;
-    private _activeChangedComponents;
-    private _modifyFlagManager;
-    /**
-     * The transform of this entity.
-     */
-    get transform(): Transform;
-    /**
-     * Whether to activate locally.
-     */
-    get isActive(): boolean;
-    set isActive(value: boolean);
-    /**
-     * Whether it is active in the hierarchy.
-     */
-    get isActiveInHierarchy(): boolean;
-    /**
-     * The parent entity.
-     */
-    get parent(): Entity;
-    set parent(value: Entity);
-    /**
-     * The children entities
-     */
-    get children(): Readonly<Entity[]>;
-    /**
-     * @deprecated Please use `children.length` property instead.
-     * Number of the children entities
-     */
-    get childCount(): number;
-    /**
-     * The scene the entity belongs to.
-     */
-    get scene(): Scene;
-    /**
-     * The sibling index.
-     */
-    get siblingIndex(): number;
-    set siblingIndex(value: number);
-    /**
-     * Create a entity.
-     * @param engine - The engine the entity belongs to
-     * @param name - The name of the entity
-     * @param components - The types of components you wish to add
-     */
-    constructor(engine: Engine, name?: string, ...components: ComponentConstructor[]);
-    /**
-     * Add component based on the component type.
-     * @param type - The type of the component
-     * @param args - The arguments of the component
-     * @returns	The component which has been added
-     */
-    addComponent<T extends new (entity: Entity, ...args: any[]) => Component>(type: T, ...args: ComponentArguments<T>): InstanceType<T>;
-    /**
-     * Get component which match the type.
-     * @param type - The type of the component
-     * @returns	The first component which match type
-     */
-    getComponent<T extends Component>(type: new (entity: Entity) => T): T | null;
-    /**
-     * Get components which match the type.
-     * @param type - The type of the component
-     * @param results - The components which match type
-     * @returns	The components which match type
-     */
-    getComponents<T extends Component>(type: new (entity: Entity) => T, results: T[]): T[];
-    /**
-     * Get the components which match the type of the entity and it's children.
-     * @param type - The component type
-     * @param results - The components collection
-     * @returns	The components collection which match the type
-     */
-    getComponentsIncludeChildren<T extends Component>(type: new (entity: Entity) => T, results: T[]): T[];
-    /**
-     * Add child entity.
-     * @param child - The child entity which want to be added
-     */
-    addChild(child: Entity): void;
-    /**
-     * Add child entity at specified index.
-     * @param index - specified index
-     * @param child - The child entity which want to be added
-     */
-    addChild(index: number, child: Entity): void;
-    /**
-     * Remove child entity.
-     * @param child - The child entity which want to be removed
-     */
-    removeChild(child: Entity): void;
-    /**
-     * @deprecated Please use `children` property instead.
-     * Find child entity by index.
-     * @param index - The index of the child entity
-     * @returns	The component which be found
-     */
-    getChild(index: number): Entity;
-    /**
-     * Find entity by name.
-     * @param name - The name of the entity which want to be found
-     * @returns The component which be found
-     */
-    findByName(name: string): Entity;
-    /**
-     * Find the entity by path.
-     * @param path - The path of the entity eg: /entity
-     * @returns The component which be found
-     */
-    findByPath(path: string): Entity;
-    /**
-     * Create child entity.
-     * @param name - The child entity's name
-     * @returns The child entity
-     */
-    createChild(name?: string): Entity;
-    /**
-     * Clear children entities.
-     */
-    clearChildren(): void;
-    /**
-     * Clone this entity include children and components.
-     * @returns Cloned entity
-     */
-    clone(): Entity;
-    /**
-     * Listen for changes in the world pose of this `Entity`.
-     * @returns Change flag
-     */
-    registerWorldChangeFlag(): BoolUpdateFlag;
-    private _createCloneEntity;
-    private _parseCloneEntity;
-    /**
-     * Destroy self.
-     */
-    destroy(): void;
-    private _dispatchModify;
-    private _addToChildrenList;
-    private _setParent;
-    private _getComponentsInChildren;
-    private _setActiveComponents;
-    private _setActiveInHierarchy;
-    private _setInActiveInHierarchy;
-    private _setSiblingIndex;
-    private _setTransform;
-    private _invModelMatrix;
-    private _inverseWorldMatFlag;
-    /**
-     * @deprecated
-     */
-    getInvModelMatrix(): Matrix;
-}
-type ComponentArguments<T extends new (entity: Entity, ...args: any[]) => Component> = T extends new (entity: Entity, ...args: infer P) => Component ? P : never;
-type ComponentConstructor = new (entity: Entity) => Component;
-export {};

package/types/Layer.d.ts

@@ -1,73 +0,0 @@
-/**
- * Layer, used for bit operations.
- */
-export declare enum Layer {
-    /** Layer 0. */
-    Layer0 = 1,
-    /** Layer 1. */
-    Layer1 = 2,
-    /** Layer 2. */
-    Layer2 = 4,
-    /** Layer 3. */
-    Layer3 = 8,
-    /** Layer 4. */
-    Layer4 = 16,
-    /** Layer 5. */
-    Layer5 = 32,
-    /** Layer 6. */
-    Layer6 = 64,
-    /** Layer 7. */
-    Layer7 = 128,
-    /** Layer 8. */
-    Layer8 = 256,
-    /** Layer 9. */
-    Layer9 = 512,
-    /** Layer 10. */
-    Layer10 = 1024,
-    /** Layer 11. */
-    Layer11 = 2048,
-    /** Layer 12. */
-    Layer12 = 4096,
-    /** Layer 13. */
-    Layer13 = 8192,
-    /** Layer 14. */
-    Layer14 = 16384,
-    /** Layer 15. */
-    Layer15 = 32768,
-    /** Layer 16. */
-    Layer16 = 65536,
-    /** Layer 17. */
-    Layer17 = 131072,
-    /** Layer 18. */
-    Layer18 = 262144,
-    /** Layer 19. */
-    Layer19 = 524288,
-    /** Layer 20. */
-    Layer20 = 1048576,
-    /** Layer 21. */
-    Layer21 = 2097152,
-    /** Layer 22. */
-    Layer22 = 4194304,
-    /** Layer 23. */
-    Layer23 = 8388608,
-    /** Layer 24. */
-    Layer24 = 16777216,
-    /** Layer 25. */
-    Layer25 = 33554432,
-    /** Layer 26. */
-    Layer26 = 67108864,
-    /** Layer 27. */
-    Layer27 = 134217728,
-    /** Layer 28. */
-    Layer28 = 268435456,
-    /** Layer 29. */
-    Layer29 = 536870912,
-    /** Layer 30. */
-    Layer30 = 1073741824,
-    /** Layer 31. */
-    Layer31 = 2147483648,
-    /** All layers. */
-    Everything = 4294967295,
-    /** None layer. */
-    Nothing = 0
-}

package/types/Platform.d.ts

@@ -1,15 +0,0 @@
-/**
- * The platform (including operating system and hardware) is running on.
- */
-export declare enum Platform {
-    /** Android platform. */
-    Android = 0,
-    /** IPhone platform. */
-    IPhone = 1,
-    /** IPad platform. */
-    IPad = 2,
-    /** Mac platform. */
-    Mac = 3,
-    /** Unknown platform. */
-    Unknown = 4
-}

package/types/Polyfill.d.ts

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

package/types/RenderPipeline/BasicRenderPipeline.d.ts

@@ -1,55 +0,0 @@
-import { Camera } from "../Camera";
-import { CameraClearFlags } from "../enums/CameraClearFlags";
-import { TextureCubeFace } from "../texture";
-import { RenderContext } from "./RenderContext";
-import { RenderElement } from "./RenderElement";
-/**
- * Basic render pipeline.
- */
-export declare class BasicRenderPipeline {
-    private _camera;
-    private _lastCanvasSize;
-    private _internalColorTarget;
-    private _cascadedShadowCasterPass;
-    private _depthOnlyPass;
-    private _saoPass;
-    private _opaqueTexturePass;
-    private _finalPass;
-    private _copyBackgroundTexture;
-    private _canUseBlitFrameBuffer;
-    private _shouldCopyBackgroundColor;
-    /**
-     * Create a basic render pipeline.
-     * @param camera - Camera
-     */
-    constructor(camera: Camera);
-    /**
-     * Destroy internal resources.
-     */
-    destroy(): void;
-    /**
-     * Perform scene rendering.
-     * @param context - Render context
-     * @param cubeFace - Render surface of cube texture
-     * @param mipLevel - Set mip level the data want to write
-     * @param ignoreClear - Ignore clear flag
-     */
-    render(context: RenderContext, cubeFace?: TextureCubeFace, mipLevel?: number, ignoreClear?: CameraClearFlags): void;
-    private _drawRenderPass;
-    /**
-     * Push render data to render queue.
-     * @param context - Render context
-     * @param renderElement - Render element
-     */
-    pushRenderElement(context: RenderContext, renderElement: RenderElement): void;
-    private pushRenderElementByType;
-    private _drawBackgroundTexture;
-    private _prepareRender;
-}
-export declare enum RenderQueueFlags {
-    None = 0,
-    Opaque = 1,
-    AlphaTest = 2,
-    Transparent = 4,
-    All = 7
-}

package/types/RenderPipeline/BatchUtils.d.ts

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

package/types/RenderPipeline/BatcherManager.d.ts

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

package/types/RenderPipeline/Blitter.d.ts

@@ -1,28 +0,0 @@
-import { Vector4 } from "@galacean/engine-math";
-import { Engine } from "../Engine";
-import { Material } from "../material";
-import { RenderTarget, Texture2D } from "../texture";
-/**
- * A helper class to blit texture to destination render target.
- */
-export declare class Blitter {
-    private static _blitTextureProperty;
-    private static _blitMipLevelProperty;
-    private static _blitTexelSizeProperty;
-    private static _sourceScaleOffsetProperty;
-    private static _rendererShaderData;
-    private static _texelSize;
-    private static _defaultScaleOffset;
-    /**
-     * Blit texture to destination render target using a triangle.
-     * @param engine - Engine
-     * @param source - Source texture
-     * @param destination - Destination render target
-     * @param mipLevel - Mip level to blit
-     * @param viewport - Viewport
-     * @param material - The material to use when blit
-     * @param passIndex - Pass index to use of the provided material
-     * @param sourceScaleOffset - Source scale and offset
-     */
-    static blitTexture(engine: Engine, source: Texture2D, destination: RenderTarget | null, mipLevel?: number, viewport?: Vector4, material?: Material, passIndex?: number, sourceScaleOffset?: Vector4): void;
-}

package/types/RenderPipeline/CullingResults.d.ts

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

package/types/RenderPipeline/DepthOnlyPass.d.ts

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

package/types/RenderPipeline/MaskManager.d.ts

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

package/types/RenderPipeline/OpaqueTexturePass.d.ts

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

package/types/RenderPipeline/PipelinePass.d.ts

@@ -1,16 +0,0 @@
-import { Engine } from "../Engine";
-import { CullingResults } from "../RenderPipeline/CullingResults";
-import { RenderContext } from "../RenderPipeline/RenderContext";
-/**
- * PipelinePass is a base class for all pipeline passes.
- */
-export declare abstract class PipelinePass {
-    readonly engine: Engine;
-    constructor(engine: Engine);
-    /**
-     * Called before rendering a camera, override this method to configure the camera If you need to configure the camera clear flag or render target.
-     * @param context - Rendering context
-     * @param cullingResults - Culling results
-     */
-    abstract onRender(context: RenderContext, cullingResults: CullingResults): void;
-}

package/types/RenderPipeline/PipelineUtils.d.ts

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

package/types/RenderPipeline/PrimitiveChunk.d.ts

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

package/types/RenderPipeline/PrimitiveChunkManager.d.ts

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

package/types/RenderPipeline/RenderContext.d.ts

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

package/types/RenderPipeline/RenderElement.d.ts

@@ -1,12 +0,0 @@
-import { IPoolElement } from "../utils/ObjectPool";
-import { RenderQueueFlags } from "./BasicRenderPipeline";
-import { SubRenderElement } from "./SubRenderElement";
-export declare class RenderElement implements IPoolElement {
-    priority: number;
-    distanceForSort: number;
-    subRenderElements: SubRenderElement[];
-    renderQueueFlags: RenderQueueFlags;
-    set(priority: number, distanceForSort: number): void;
-    addSubRenderElement(element: SubRenderElement): void;
-    dispose(): void;
-}

package/types/RenderPipeline/RenderQueue.d.ts

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

package/types/RenderPipeline/SubPrimitiveChunk.d.ts

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

package/types/RenderPipeline/SubRenderElement.d.ts

@@ -1,22 +0,0 @@
-import { Renderer } from "../Renderer";
-import { Primitive, SubMesh } from "../graphic";
-import { Material } from "../material";
-import { ShaderData, ShaderPass } from "../shader";
-import { Texture2D } from "../texture";
-import { IPoolElement } from "../utils/ObjectPool";
-import { RenderQueueFlags } from "./BasicRenderPipeline";
-import { SubPrimitiveChunk } from "./SubPrimitiveChunk";
-export declare class SubRenderElement implements IPoolElement {
-    component: Renderer;
-    primitive: Primitive;
-    material: Material;
-    subPrimitive: SubMesh;
-    shaderPasses: ReadonlyArray<ShaderPass>;
-    shaderData?: ShaderData;
-    batched: boolean;
-    renderQueueFlags: RenderQueueFlags;
-    texture?: Texture2D;
-    subChunk?: SubPrimitiveChunk;
-    set(component: Renderer, material: Material, primitive: Primitive, subPrimitive: SubMesh, texture?: Texture2D, subChunk?: SubPrimitiveChunk): void;
-    dispose(): void;
-}

package/types/RenderPipeline/VertexArea.d.ts

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

package/types/RenderPipeline/enums/PipelineStage.d.ts

@@ -1,11 +0,0 @@
-/**
- * Pipeline stage.
- */
-export declare enum PipelineStage {
-    /** DepthOnly stage. */
-    DepthOnly = "DepthOnly",
-    /** Shadow caster stage. */
-    ShadowCaster = "ShadowCaster",
-    /** Forward shading stage. */
-    Forward = "Forward"
-}

package/types/RenderPipeline/enums/RenderQueueMaskType.d.ts

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

package/types/RenderPipeline/index.d.ts

@@ -1,5 +0,0 @@
-export { BasicRenderPipeline, RenderQueueFlags } from "./BasicRenderPipeline";
-export { BatchUtils } from "./BatchUtils";
-export { Blitter } from "./Blitter";
-export { RenderQueue } from "./RenderQueue";
-export { PipelineStage } from "./enums/PipelineStage";