@galacean/engine-core 0.0.0-experimental-1.2-xr.0 → 0.0.0-experimental-1.3-xr.2

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

@@ -0,0 +1,94 @@
+import { Color } from "@galacean/engine-math";
+import { RenderContext } from "../../RenderPipeline/RenderContext";
+import { Material } from "../../material";
+import { Texture2D } from "../../texture";
+/**
+ * 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 {
+    private _uberMaterial;
+    static readonly SHADER_NAME = "PostProcessEffect Bloom";
+    private static _hqMacro;
+    private static _dirtMacro;
+    private static _bloomParams;
+    private static _lowMipTextureProp;
+    private static _lowMipTexelSizeProp;
+    private static _enableMacro;
+    private static _bloomTextureProp;
+    private static _dirtTextureProp;
+    private static _tintProp;
+    private static _bloomIntensityParams;
+    private static _dirtTilingOffsetProp;
+    private _bloomMaterial;
+    private _threshold;
+    private _scatter;
+    private _highQualityFiltering;
+    private _mipDownRT;
+    private _mipUpRT;
+    private _maxIterations;
+    private _enabled;
+    /**
+     * Controls the starting resolution that this effect begins processing.
+     */
+    downScale: BloomDownScaleMode;
+    /**
+     * Indicates whether the post process effect is enabled.
+     */
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    /**
+     * Set the level of brightness to filter out pixels under this level.
+     * @remarks This value is expressed in gamma-space.
+     */
+    get threshold(): number;
+    set threshold(value: number);
+    /**
+     * Controls the radius of the bloom effect.
+     */
+    get scatter(): number;
+    set scatter(value: number);
+    /**
+     * Controls the strength of the bloom effect.
+     */
+    get intensity(): number;
+    set intensity(value: number);
+    /**
+     * Specifies the tint of the bloom effect.
+     */
+    get tint(): Color;
+    set tint(value: Color);
+    /**
+     * 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.
+     */
+    get highQualityFiltering(): boolean;
+    set highQualityFiltering(value: boolean);
+    /**
+     * Specifies a Texture to add smudges or dust to the bloom effect.
+     */
+    get dirtTexture(): Texture2D;
+    set dirtTexture(value: Texture2D);
+    /**
+     * Controls the strength of the lens dirt.
+     */
+    get dirtIntensity(): number;
+    set dirtIntensity(value: number);
+    constructor(_uberMaterial: Material);
+    onRender(context: RenderContext, srcTexture: Texture2D): void;
+    private _calculateMipCount;
+    private _prefilter;
+    private _downsample;
+    private _upsample;
+    private _setupUber;
+    private _releaseRenderTargets;
+}

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

@@ -0,0 +1,35 @@
+import { Material } from "../../material";
+/**
+ * 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 {
+    private _uberMaterial;
+    private static _enableMacro;
+    private _mode;
+    private _enabled;
+    /**
+     * Indicates whether the post process effect is enabled.
+     */
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    /**
+     * Use this to select a tonemapping algorithm to use.
+     */
+    get mode(): TonemappingMode;
+    set mode(value: TonemappingMode);
+    constructor(_uberMaterial: Material);
+}

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

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

package/types/postProcess/index.d.ts

@@ -0,0 +1,3 @@
+import { _PostProcessManager } from "./PostProcessManager";
+export * from "./effects";
+export { _PostProcessManager };

package/types/shader/ShaderPass.d.ts

@@ -6,6 +6,11 @@ export declare class ShaderPass extends ShaderPart {
     private static _shaderPassCounter;
     private _vertexSource;
     private _fragmentSource;
+    private readonly _type;
+    private readonly _shaderLabSource;
+    private readonly _vertexEntry;
+    private readonly _fragmentEntry;
+    private _platformMacros;
     /**
      * Create a shader pass.
      * @param name - Shader pass name
@@ -21,4 +26,9 @@ export declare class ShaderPass extends ShaderPart {
      * @param tags - Tags
      */
     constructor(vertexSource: string, fragmentSource: string, tags?: Record<string, number | string | boolean>);
+    /**
+     * Shader Lab compilation
+     */
+    private _compileShaderProgram;
+    private _getCanonicalShaderProgram;
 }

package/types/shader/enums/ShaderDataGroup.d.ts

@@ -8,6 +8,8 @@ export declare enum ShaderDataGroup {
     Camera = 1,
     /** Renderer group. */
     Renderer = 2,
-    /** material group. */
-    Material = 3
+    /** Material group. */
+    Material = 3,
+    /** Render element group. */
+    RenderElement = 4
 }

package/types/shader/enums/ShaderPlatformTarget.d.ts

@@ -0,0 +1,4 @@
+export declare enum ShaderPlatformTarget {
+    GLES100 = 0,
+    GLES300 = 1
+}

package/types/shader/enums/ShaderType.d.ts

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

package/types/shader/index.d.ts

@@ -7,6 +7,7 @@ export { RenderStateElementKey as RenderStateDataKey } from "./enums/RenderState
 export { RenderQueueType } from "./enums/RenderQueueType";
 export { ShaderPropertyType } from "./enums/ShaderPropertyType";
 export { StencilOperation } from "./enums/StencilOperation";
+export { ShaderPlatformTarget } from "./enums/ShaderPlatformTarget";
 export { Shader } from "./Shader";
 export { ShaderData } from "./ShaderData";
 export { ShaderMacro } from "./ShaderMacro";

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

@@ -17,4 +17,5 @@ export declare class RenderState {
     readonly rasterState: RasterState;
     /** Render queue type. */
     renderQueueType: RenderQueueType;
+    private _applyStatesByShaderData;
 }

package/types/shaderlib/ShaderFactory.d.ts

@@ -1,6 +1,7 @@
+import { ShaderMacro } from "../shader/ShaderMacro";
 export declare class ShaderFactory {
     private static readonly _has300OutInFragReg;
-    static parseCustomMacros(macros: string[]): string;
+    static parseCustomMacros(macros: ShaderMacro[]): string;
     static registerInclude(includeName: string, includeSource: string): void;
     static unRegisterInclude(includeName: string): void;
     /**

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

@@ -22,6 +22,8 @@ export declare enum TextureFormat {
     R32G32B32A32 = 8,
     /** RGBA unsigned integer format, 32 bits per channel. */
     R32G32B32A32_UInt = 9,
+    /** RGB unsigned float format, 11 bits in R channel, 11 bits in G channel, 10 bits in B channel. */
+    R11G11B10_UFloat = 35,
     /** RGB compressed format, 4 bits per pixel. */
     BC1 = 10,
     /** RGBA compressed format, 8 bits per pixel. */

package/types/utils/ClearableObjectPool.d.ts

@@ -5,6 +5,12 @@ import { IPoolElement, ObjectPool } from "./ObjectPool";
 export declare class ClearableObjectPool<T extends IPoolElement> extends ObjectPool<T> {
     private _usedElementCount;
     constructor(type: new () => T);
+    /**
+     * Get an object.
+     */
     get(): T;
+    /**
+     * Clear used object count to 0, not destroy any object, just change index.
+     */
     clear(): void;
 }

package/types/utils/ObjectPool.d.ts

@@ -5,6 +5,12 @@ export declare abstract class ObjectPool<T extends IPoolElement> {
     garbageCollection(): void;
     abstract get(): T;
 }
+/**
+ * The basic interface for Object Pool's element.
+ */
 export interface IPoolElement {
+    /**
+     * Called when the object need be release.
+     */
     dispose?(): void;
 }

package/types/utils/ReturnableObjectPool.d.ts

@@ -5,6 +5,12 @@ import { IPoolElement, ObjectPool } from "./ObjectPool";
 export declare class ReturnableObjectPool<T extends IPoolElement> extends ObjectPool<T> {
     private _lastElementIndex;
     constructor(type: new () => T, initializeCount?: number);
+    /**
+     * Get an object from the pool.
+     */
     get(): T;
+    /**
+     * Return an object to the pool.
+     */
     return(element: T): void;
 }

package/types/utils/index.d.ts

@@ -0,0 +1,3 @@
+export { ClearableObjectPool } from "./ClearableObjectPool";
+export type { IPoolElement } from "./ObjectPool";
+export { ReturnableObjectPool } from "./ReturnableObjectPool";