@galacean/engine-core 1.6.7 → 1.6.8

package/types/postProcess/PostProcessPass.d.ts

@@ -1,50 +0,0 @@
-import { EngineObject } from "../base";
-import { Camera } from "../Camera";
-import { RenderTarget, Texture2D } from "../texture";
-import { PostProcessManager } from "./PostProcessManager";
-/**
- * Controls when the post process pass executes.
- */
-export declare enum PostProcessPassEvent {
-    /** Before the uber pass. */
-    BeforeUber = 0,
-    /** After the uber pass. */
-    AfterUber = 100
-}
-/**
- * Post process pass.
- */
-export declare abstract class PostProcessPass extends EngineObject {
-    private _event;
-    private _isActive;
-    /**
-     * When the post process pass is rendered.
-     * @remarks
-     * Users can also inject pass events in a specific point by doing PostProcessPassEvent + offset.
-     */
-    get event(): PostProcessPassEvent;
-    set event(value: PostProcessPassEvent);
-    /**
-     * Whether the post process pass is active.
-     */
-    get isActive(): boolean;
-    set isActive(value: boolean);
-    /**
-     * Whether the post process pass is valid in current post process manager.
-     * @remarks
-     * This method can be overridden to control the pass's real validity.
-     * @param postProcessManager - The post process manager
-     */
-    isValid(postProcessManager: PostProcessManager): boolean;
-    /**
-     * Execute the post process pass if it is active.
-     * @param camera - The camera used to render
-     * @param srcTexture - The source texture from last render target
-     * @param destTarget - The destination render target
-     */
-    abstract onRender(camera: Camera, srcTexture: Texture2D, destTarget: RenderTarget): void;
-    /**
-     * @inheritdoc
-     */
-    _onDestroy(): void;
-}

package/types/postProcess/PostProcessUberPass.d.ts

@@ -1,25 +0,0 @@
-import { Camera } from "../Camera";
-import { Engine } from "../Engine";
-import { RenderTarget, Texture2D } from "../texture";
-import { PostProcessManager } from "./PostProcessManager";
-import { PostProcessPass } from "./PostProcessPass";
-export declare class PostProcessUberPass extends PostProcessPass {
-    static readonly UBER_SHADER_NAME = "UberPost";
-    private _uberMaterial;
-    private _bloomMaterial;
-    private _mipDownRT;
-    private _mipUpRT;
-    constructor(engine: Engine);
-    /** @inheritdoc */
-    isValid(postProcessManager: PostProcessManager): boolean;
-    /**
-     * @inheritdoc
-     */
-    onRender(camera: Camera, srcTexture: Texture2D, destTarget: RenderTarget): void;
-    /**
-     * @inheritdoc
-     */
-    _onDestroy(): void;
-    private _setupBloom;
-    private _releaseBloomRenderTargets;
-}

package/types/postProcess/effects/BloomEffect.d.ts

@@ -1,50 +0,0 @@
-import { PostProcessEffect } from "../PostProcessEffect";
-import { PostProcessEffectBoolParameter, PostProcessEffectColorParameter, PostProcessEffectEnumParameter, PostProcessEffectFloatParameter, PostProcessEffectTextureParameter } from "../PostProcessEffectParameter";
-/**
- * This controls the size of the bloom texture.
- */
-export declare enum BloomDownScaleMode {
-    /** Use this to select half size as the starting resolution. */
-    Half = 0,
-    /** Use this to select quarter size as the starting resolution. */
-    Quarter = 1
-}
-export declare class BloomEffect extends PostProcessEffect {
-    static readonly SHADER_NAME = "PostProcessEffect Bloom";
-    /**
-     * Controls whether to use bicubic sampling instead of bilinear sampling for the upSampling passes.
-     * @remarks This is slightly more expensive but helps getting smoother visuals.
-     */
-    highQualityFiltering: PostProcessEffectBoolParameter;
-    /**
-     * Controls the starting resolution that this effect begins processing.
-     */
-    downScale: PostProcessEffectEnumParameter<BloomDownScaleMode>;
-    /**
-     * Specifies a Texture to add smudges or dust to the bloom effect.
-     */
-    dirtTexture: PostProcessEffectTextureParameter;
-    /**
-     * Set the level of brightness to filter out pixels under this level.
-     * @remarks This value is expressed in linear.
-     */
-    threshold: PostProcessEffectFloatParameter;
-    /**
-     * Controls the radius of the bloom effect.
-     */
-    scatter: PostProcessEffectFloatParameter;
-    /**
-     * Controls the strength of the bloom effect.
-     */
-    intensity: PostProcessEffectFloatParameter;
-    /**
-     * Controls the strength of the lens dirt.
-     */
-    dirtIntensity: PostProcessEffectFloatParameter;
-    /**
-     * Specifies the tint of the bloom effect.
-     */
-    tint: PostProcessEffectColorParameter;
-    /** @inheritdoc */
-    isValid(): boolean;
-}

package/types/postProcess/effects/TonemappingEffect.d.ts

@@ -1,25 +0,0 @@
-import { PostProcessEffect } from "../PostProcessEffect";
-import { PostProcessEffectEnumParameter } from "../PostProcessEffectParameter";
-/**
- * Options to select a tonemapping algorithm to use.
- */
-export declare enum TonemappingMode {
-    /**
-     * Neutral tonemapper.
-     * @remarks Use this option if you only want range-remapping with minimal impact on color hue and saturation.
-     */
-    Neutral = 0,
-    /**
-     * ACES Filmic reference tonemapper (custom approximation).
-     * @remarks
-     * Use this option to apply a close approximation of the reference ACES tonemapper for a more filmic look.
-     * It is more contrasted than Neutral and has an effect on actual color hue and saturation.
-     */
-    ACES = 1
-}
-export declare class TonemappingEffect extends PostProcessEffect {
-    /**
-     * Use this to select a tonemapping algorithm to use.
-     */
-    mode: PostProcessEffectEnumParameter<TonemappingMode>;
-}

package/types/postProcess/effects/index.d.ts

@@ -1,2 +0,0 @@
-export { BloomDownScaleMode, BloomEffect } from "./BloomEffect";
-export { TonemappingEffect, TonemappingMode } from "./TonemappingEffect";

package/types/postProcess/index.d.ts

@@ -1,8 +0,0 @@
-export * from "./effects";
-export { PostProcess } from "./PostProcess";
-export { PostProcessEffect } from "./PostProcessEffect";
-export { PostProcessEffectBoolParameter, PostProcessEffectColorParameter, PostProcessEffectEnumParameter, PostProcessEffectFloatParameter, PostProcessEffectParameter, PostProcessEffectTextureParameter, PostProcessEffectVector2Parameter, PostProcessEffectVector3Parameter, PostProcessEffectVector4Parameter } from "./PostProcessEffectParameter";
-export { PostProcessManager } from "./PostProcessManager";
-export { PostProcessPass, PostProcessPassEvent } from "./PostProcessPass";
-export { PostProcessUberPass } from "./PostProcessUberPass";
-export { FinalPass } from "./FinalPass";

package/types/renderingHardwareInterface/IPlatformBuffer.d.ts

@@ -1,7 +0,0 @@
-import { SetDataOptions } from "../graphic";
-export interface IPlatformBuffer {
-    bind(): void;
-    setData(byteLength: number, data: ArrayBuffer | ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number, options?: SetDataOptions): void;
-    getData(data: ArrayBufferView, bufferByteOffset?: number, dataOffset?: number, dataLength?: number): void;
-    destroy(): void;
-}

package/types/renderingHardwareInterface/IPlatformRenderTarget.d.ts

@@ -1,20 +0,0 @@
-import { TextureCubeFace } from "../texture";
-/**
- * Off-screen rendering target specification.
- */
-export interface IPlatformRenderTarget {
-    /**
-     * Set which face and mipLevel of the cube texture to render to.
-     * @param mipLevel - Set mip level the data want to write
-     * @param faceIndex - Cube texture face
-     */
-    activeRenderTarget(mipLevel: number, faceIndex?: TextureCubeFace): void;
-    /**
-     * Blit FBO.
-     */
-    blitRenderTarget(): void;
-    /**
-     * Destroy render target.
-     */
-    destroy(): void;
-}

package/types/renderingHardwareInterface/IPlatformTexture.d.ts

@@ -1,36 +0,0 @@
-import { TextureFilterMode, TextureWrapMode } from "../texture";
-import { TextureDepthCompareFunction } from "../texture/enums/TextureDepthCompareFunction";
-/**
- * Texture interface specification.
- */
-export interface IPlatformTexture {
-    /**
-     * Wrapping mode for texture coordinate S.
-     */
-    wrapModeU: TextureWrapMode;
-    /**
-     * Wrapping mode for texture coordinate T.
-     */
-    wrapModeV: TextureWrapMode;
-    /**
-     * Filter mode for texture.
-     */
-    filterMode: TextureFilterMode;
-    /**
-     * Anisotropic level for texture.
-     */
-    anisoLevel: number;
-    /**
-     *  Filter mode when texture as depth Texture.
-     */
-    depthCompareFunction: TextureDepthCompareFunction;
-    /**
-     * Destroy texture.
-     */
-    destroy(): void;
-    /**
-     * Generate multi-level textures based on the 0th level data.
-     */
-    generateMipmaps(): void;
-    setUseDepthCompareMode(value: boolean): any;
-}

package/types/renderingHardwareInterface/IPlatformTexture2D.d.ts

@@ -1,37 +0,0 @@
-import { IPlatformTexture } from "./IPlatformTexture";
-/**
- * 2D texture interface specification.
- */
-export interface IPlatformTexture2D extends IPlatformTexture {
-    /**
-     * 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.
-     * @param colorBuffer - Color buffer data
-     * @param mipLevel - Texture mipmapping level
-     * @param x - X coordinate of area start
-     * @param y - Y coordinate of area start
-     * @param width - Data width. if it's empty, width is the width corresponding to mipLevel minus x , width corresponding to mipLevel is Math.max(1, this.width >> mipLevel)
-     * @param height - Data height. if it's empty, height is the height corresponding to mipLevel minus y , height corresponding to mipLevel is Math.max(1, this.height >> mipLevel)
-     */
-    setPixelBuffer(colorBuffer: ArrayBufferView, mipLevel: number, x: number, y: number, width?: number, height?: number): void;
-    /**
-     * Setting pixels data through TexImageSource, designated area and texture mipmapping level.
-     * @param imageSource - The source of texture
-     * @param mipLevel - Texture mipmapping level
-     * @param flipY - Whether to flip the Y axis
-     * @param premultiplyAlpha - Whether to premultiply the transparent channel
-     * @param x - X coordinate of area start
-     * @param y - Y coordinate of area start
-     */
-    setImageSource(imageSource: TexImageSource, mipLevel: number, flipY: boolean, premultiplyAlpha: boolean, x: number, y: number): void;
-    /**
-     * Get the pixel color buffer according to the specified area.
-     * @param x - X coordinate of area start
-     * @param y - Y coordinate of area start
-     * @param width - Area width
-     * @param height - Area height
-     * @param mipLevel - Set mip level the data want to get from
-     * @param out - Color buffer
-     */
-    getPixelBuffer(x: number, y: number, width: number, height: number, mipLevel: number, out: ArrayBufferView): void;
-}

package/types/renderingHardwareInterface/IPlatformTexture2DArray.d.ts

@@ -1,40 +0,0 @@
-import { IPlatformTexture } from "./IPlatformTexture";
-/**
- * 2D texture array interface specification.
- */
-export interface IPlatformTexture2DArray extends IPlatformTexture {
-    /**
-     * Setting pixels data through color buffer data, designated area and texture mipmapping level,it's also applicable to compressed formats.
-     * @param offsetIndex - The texture array element offset index
-     * @param colorBuffer - Color buffer data
-     * @param mipLevel - Texture mipmapping level
-     * @param x - X coordinate of area start
-     * @param y - Y coordinate of area start
-     * @param width - Data width. if it's empty, width is the width corresponding to mipLevel minus x , width corresponding to mipLevel is Math.max(1, this.width >> mipLevel)
-     * @param height - Data height. if it's empty, height is the height corresponding to mipLevel minus y , height corresponding to mipLevel is Math.max(1, this.height >> mipLevel)
-     * @param length - Data length.
-     */
-    setPixelBuffer(offsetIndex: number, colorBuffer: ArrayBufferView, mipLevel: number, x: number, y: number, width?: number, height?: number, length?: number): void;
-    /**
-     * Setting pixels data through TexImageSource, designated area and texture mipmapping level.
-     * @param index - The texture array element index
-     * @param imageSource - The source of texture
-     * @param mipLevel - Texture mipmapping level
-     * @param flipY - Whether to flip the Y axis
-     * @param premultiplyAlpha - Whether to premultiply the transparent channel
-     * @param x - X coordinate of area start
-     * @param y - Y coordinate of area start
-     */
-    setImageSource(index: number, imageSource: TexImageSource, mipLevel: number, flipY: boolean, premultiplyAlpha: boolean, x: number, y: number): void;
-    /**
-     * Get the pixel color buffer according to the specified area.
-     * @param elementIndex - The texture array element index
-     * @param x - X coordinate of area start
-     * @param y - Y coordinate of area start
-     * @param width - Area width
-     * @param height - Area height
-     * @param mipLevel - Set mip level the data want to get from
-     * @param out - Color buffer
-     */
-    getPixelBuffer(elementIndex: number, x: number, y: number, width: number, height: number, mipLevel: number, out: ArrayBufferView): void;
-}

package/types/renderingHardwareInterface/IPlatformTextureCube.d.ts

@@ -1,41 +0,0 @@
-import { TextureCubeFace } from "../texture";
-import { IPlatformTexture } from "./IPlatformTexture";
-/**
- * Cube texture interface specification.
- */
-export interface IPlatformTextureCube extends IPlatformTexture {
-    /**
-     * Setting pixels data through cube face,color buffer data, designated area and texture mipmapping level,it's also applicable to compressed formats.
-     * @remarks When compressed texture is in WebGL1, the texture must be filled first before writing the sub-region
-     * @param face - Cube face
-     * @param colorBuffer - Color buffer data
-     * @param mipLevel - Texture mipmapping level
-     * @param x - X coordinate of area start
-     * @param y -  Y coordinate of area start
-     * @param width - Data width.if it's empty, width is the width corresponding to mipLevel minus x , width corresponding to mipLevel is Math.max(1, this.width >> mipLevel)
-     * @param height - Data height.if it's empty, height is the height corresponding to mipLevel minus y , height corresponding to mipLevel is Math.max(1, this.height >> mipLevel)
-     */
-    setPixelBuffer(face: TextureCubeFace, colorBuffer: ArrayBufferView, mipLevel: number, x: number, y: number, width?: number, height?: number): void;
-    /**
-     * Setting pixels data through cube face, TexImageSource, designated area and texture mipmapping level.
-     * @param face - Cube face
-     * @param imageSource - The source of texture
-     * @param mipLevel - Texture mipmapping level
-     * @param flipY - Whether to flip the Y axis
-     * @param premultiplyAlpha - Whether to premultiply the transparent channel
-     * @param x - X coordinate of area start
-     * @param y - Y coordinate of area start
-     */
-    setImageSource(face: TextureCubeFace, imageSource: TexImageSource, mipLevel: number, flipY: boolean, premultiplyAlpha: boolean, x: number, y: number): void;
-    /**
-     * Get the pixel color buffer according to the specified cube face and area.
-     * @param face - You can choose which cube face to read
-     * @param x - X coordinate of area start
-     * @param y - Y coordinate of area start
-     * @param width - Area width
-     * @param height - Area height
-     * @param mipLevel - Set mip level the data want to get from
-     * @param out - Color buffer
-     */
-    getPixelBuffer(face: TextureCubeFace, x: number, y: number, width: number, height: number, mipLevel: number, out: ArrayBufferView): void;
-}

package/types/renderingHardwareInterface/index.d.ts

@@ -1,6 +0,0 @@
-export type { IPlatformBuffer } from "./IPlatformBuffer";
-export type { IPlatformRenderTarget } from "./IPlatformRenderTarget";
-export type { IPlatformTexture } from "./IPlatformTexture";
-export type { IPlatformTexture2D } from "./IPlatformTexture2D";
-export type { IPlatformTexture2DArray } from "./IPlatformTexture2DArray";
-export type { IPlatformTextureCube } from "./IPlatformTextureCube";

package/types/shader/Shader.d.ts

@@ -1,119 +0,0 @@
-import { Engine } from "../Engine";
-import { IReferable } from "../asset/IReferable";
-import { ShaderMacro } from "./ShaderMacro";
-import { ShaderPass } from "./ShaderPass";
-import { ShaderProperty } from "./ShaderProperty";
-import { SubShader } from "./SubShader";
-import { ShaderLanguage } from "./enums/ShaderLanguage";
-/**
- * Shader for rendering.
- */
-export declare class Shader implements IReferable {
-    readonly name: string;
-    private static _shaderMap;
-    /**
-     * Create a shader by source code.
-     *
-     * @remarks
-     *
-     * ShaderLab must be enabled first as follows:
-     * ```ts
-     * // Import shaderLab
-     * import { ShaderLab } from "@galacean/engine-shaderlab";
-     * // Create engine with shaderLab
-     * const engine = await WebGLEngine.create({ canvas: "canvas", shader: new ShaderLab() });
-     * ...
-     * ```
-     *
-     * @param shaderSource - Shader code
-     * @param platformTarget - Shader platform target, @defaultValue ShaderLanguage.GLSLES300
-     * @param path - Shader location path
-     * @returns Shader
-     *
-     * @throws
-     * Throw string exception if shaderLab has not been enabled properly.
-     */
-    static create(shaderSource: string, platformTarget?: ShaderLanguage, path?: string): Shader;
-    /**
-     * Create a shader.
-     * @param name - Name of the shader
-     * @param vertexSource - Vertex source code
-     * @param fragmentSource - Fragment source code
-     * @returns Shader
-     */
-    static create(name: string, vertexSource: string, fragmentSource: string): Shader;
-    /**
-     * Create a shader.
-     * @param name - Name of the shader
-     * @param shaderPasses - Shader passes
-     * @returns Shader
-     */
-    static create(name: string, shaderPasses: ShaderPass[]): Shader;
-    /**
-     * Create a shader.
-     * @param name - Name of the shader
-     * @param subShaders - Sub shaders
-     * @returns Shader
-     */
-    static create(name: string, subShaders: SubShader[]): Shader;
-    /**
-     * Find a shader by name.
-     * @param name - Name of the shader
-     */
-    static find(name: string): Shader;
-    private static _applyConstRenderStates;
-    private _refCount;
-    private _destroyed;
-    private _subShaders;
-    /**
-     * Sub shaders of the shader.
-     */
-    get subShaders(): ReadonlyArray<SubShader>;
-    /**
-     * Whether it has been destroyed.
-     */
-    get destroyed(): boolean;
-    private constructor();
-    /**
-     * Compile shader variant by macro name list.
-     *
-     * @remarks
-     * Usually a shader contains some macros,any combination of macros is called shader variant.
-     *
-     * @param engine - Engine to which the shader variant belongs
-     * @param macros - Macro name list
-     * @returns Is the compiled shader variant valid
-     */
-    compileVariant(engine: Engine, macros: string[]): boolean;
-    /**
-     * Destroy the shader.
-     * @param force - Whether to force the destruction, if it is false, refCount = 0 can be released successfully.
-     * @returns Whether the release was successful.
-     */
-    destroy(force?: boolean): boolean;
-    /**
-     * @deprecated Please use `ShaderMacro.getByName` instead
-     *
-     * Get shader macro by name.
-     * @param name - Name of the shader macro
-     * @returns Shader macro
-     */
-    static getMacroByName(name: string): ShaderMacro;
-    /**
-     * @deprecated Please use `ShaderMacro.getByName` instead
-     *
-     * Get shader macro by name.
-     * @param name - Name of the shader macro
-     * @param value - Value of the shader macro
-     * @returns Shader macro
-     */
-    static getMacroByName(name: string, value: string): ShaderMacro;
-    /**
-     * @deprecated Please use `ShaderProperty.getByName` instead
-     *
-     * Get shader property by name.
-     * @param name - Name of the shader property
-     * @returns Shader property
-     */
-    static getPropertyByName(name: string): ShaderProperty;
-}