@galacean/engine-core 1.4.0-alpha.0 → 1.4.0-alpha.2

package/package.json

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

package/types/Camera.d.ts

@@ -34,6 +34,10 @@ export declare class Camera extends Component {
      * @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`.
@@ -50,7 +54,7 @@ export declare class Camera extends Component {
     /**
      * 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.
+     * @remarks It will take effect when `independentCanvasEnabled` property is `true`, otherwise it will be invalid.
      */
     msaaSamples: MSAASamples;
     private _priority;
@@ -68,7 +72,6 @@ export declare class Camera extends Component {
     private _enableHDR;
     private _enablePostProcess;
     private _frustumChangeFlag;
-    private _transform;
     private _isViewMatrixDirty;
     private _isInvViewProjDirty;
     private _viewport;
@@ -86,7 +89,6 @@ export declare class Camera extends Component {
     set opaqueTextureEnabled(value: boolean);
     /**
      * Whether independent canvas is enabled.
-     *
      * @remarks If true, the msaa in viewport can turn or off independently by `msaaSamples` property.
      */
     get independentCanvasEnabled(): boolean;

package/types/Engine.d.ts

@@ -9,6 +9,7 @@ import { ColorSpace } from "./enums/ColorSpace";
 import { InputManager } from "./input";
 import { ParticleBufferUtils } from "./particle/ParticleBufferUtils";
 import { PhysicsScene } from "./physics/PhysicsScene";
+import { PostProcessPass } from "./postProcess/PostProcessPass";
 import { XRManager } from "./xr/XRManager";
 /**
  * Engine.
@@ -35,6 +36,8 @@ export declare class Engine extends EventDispatcher {
     private _waitingDestroy;
     private _isDeviceLost;
     private _waitingGC;
+    private _postProcessPasses;
+    private _activePostProcessPasses;
     private _animate;
     /**
      * Settings of Engine.
@@ -74,6 +77,10 @@ export declare class Engine extends EventDispatcher {
      */
     get targetFrameRate(): number;
     set targetFrameRate(value: number);
+    /**
+     * All post process passes.
+     */
+    get postProcessPasses(): ReadonlyArray<PostProcessPass>;
     /**
      * Indicates whether the engine is destroyed.
      */
@@ -111,6 +118,11 @@ export declare class Engine extends EventDispatcher {
      * @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.

package/types/Entity.d.ts

@@ -1,4 +1,5 @@
 import { Matrix } from "@galacean/engine-math";
+import { BoolUpdateFlag } from "./BoolUpdateFlag";
 import { Component } from "./Component";
 import { Engine } from "./Engine";
 import { Layer } from "./Layer";
@@ -13,11 +14,14 @@ export declare class Entity extends EngineObject {
     name: string;
     /** The layer the entity belongs to. */
     layer: Layer;
-    /** Transform component. */
-    readonly transform: Transform;
+    private _transform;
     private _templateResource;
     private _parent;
     private _activeChangedComponents;
+    /**
+     * The transform of this entity.
+     */
+    get transform(): Transform;
     /**
      * Whether to activate locally.
      */
@@ -53,8 +57,10 @@ export declare class Entity extends EngineObject {
     /**
      * 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);
+    constructor(engine: Engine, name?: string, ...components: ComponentConstructor[]);
     /**
      * Add component based on the component type.
      * @param type - The type of the component
@@ -132,6 +138,11 @@ export declare class Entity extends EngineObject {
      * @returns Cloned entity
      */
     clone(): Entity;
+    /**
+     * Listen for changes in the world pose of this `Entity`.
+     * @returns Change flag
+     */
+    registerWorldChangeFlag(): BoolUpdateFlag;
     private _createCloneEntity;
     private _parseCloneEntity;
     /**
@@ -153,4 +164,5 @@ export declare class Entity extends EngineObject {
     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/Polyfill.d.ts

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

package/types/RenderPipeline/BasicRenderPipeline.d.ts

@@ -13,6 +13,10 @@ export declare class BasicRenderPipeline {
     private _cascadedShadowCasterPass;
     private _depthOnlyPass;
     private _opaqueTexturePass;
+    private _grabTexture;
+    private _canUseBlitFrameBuffer;
+    private _shouldGrabColor;
+    private _sourceScaleOffset;
     /**
      * Create a basic render pipeline.
      * @param camera - Camera

package/types/RenderPipeline/Blitter.d.ts

@@ -0,0 +1,28 @@
+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 flipYOfSource - Whether flip Y axis of source texture
+     */
+    static blitTexture(engine: Engine, source: Texture2D, destination: RenderTarget | null, mipLevel?: number, viewport?: Vector4, material?: Material, passIndex?: number, sourceScaleOffset?: Vector4): void;
+}

package/types/RenderPipeline/index.d.ts

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

package/types/Renderer.d.ts

@@ -1,7 +1,6 @@
 import { BoundingBox, Matrix, Vector4 } from "@galacean/engine-math";
 import { Component } from "./Component";
 import { RenderContext } from "./RenderPipeline/RenderContext";
-import { Transform } from "./Transform";
 import { IComponentCustomClone } from "./clone/ComponentCloner";
 import { Material } from "./material";
 import { ShaderData } from "./shader/ShaderData";
@@ -24,7 +23,6 @@ export declare class Renderer extends Component implements IComponentCustomClone
     protected _materials: Material[];
     protected _dirtyUpdateFlag: number;
     protected _rendererLayer: Vector4;
-    protected _transform: Transform;
     private _shaderData;
     private _mvMatrix;
     private _mvpMatrix;

package/types/Scene.d.ts

@@ -7,6 +7,7 @@ import { FogMode } from "./enums/FogMode";
 import { DirectLight } from "./lighting";
 import { AmbientLight } from "./lighting/AmbientLight";
 import { PhysicsScene } from "./physics/PhysicsScene";
+import { PostProcessManager } from "./postProcess";
 import { ShaderData } from "./shader/ShaderData";
 import { ShadowCascadesMode } from "./shadow/enum/ShadowCascadesMode";
 import { ShadowResolution } from "./shadow/enum/ShadowResolution";
@@ -35,6 +36,8 @@ export declare class Scene extends EngineObject {
      * @remarks Value 0 is used for no shadow fade.
      */
     shadowFadeBorder: number;
+    /** Post process manager. */
+    readonly postProcessManager: PostProcessManager;
     private _background;
     private _shaderData;
     private _shadowCascades;

package/types/Transform.d.ts

@@ -18,9 +18,11 @@ export declare class Transform extends Component {
     private _rotation;
     private _rotationQuaternion;
     private _scale;
+    private _localUniformScaling;
     private _worldPosition;
     private _worldRotation;
     private _worldRotationQuaternion;
+    private _worldUniformScaling;
     private _lossyWorldScale;
     private _localMatrix;
     private _worldMatrix;
@@ -69,8 +71,8 @@ export declare class Transform extends Component {
     set scale(value: Vector3);
     /**
      * Local lossy scaling.
-     * @remarks The value obtained may not be correct under certain conditions(for example, the parent node has scaling,
-     * and the child node has a rotation), the scaling will be tilted. Vector3 cannot be used to correctly represent the scaling. Must use Matrix3x3.
+     * @remarks The value obtained may not be correct under certain conditions(for example, the parent node has non-uniform world scaling,
+     * and the child node has a rotation), the scaling will be tilted.
      */
     get lossyWorldScale(): Vector3;
     /**
@@ -190,11 +192,6 @@ export declare class Transform extends Component {
      * @param worldUp - Up direction in world space, default is Vector3(0, 1, 0)
      */
     lookAt(targetPosition: Vector3, worldUp?: Vector3): void;
-    /**
-     * Register world transform change flag.
-     * @returns Change flag
-     */
-    registerWorldChangeFlag(): BoolUpdateFlag;
     protected _onDestroy(): void;
     /**
      * Get worldMatrix: Will trigger the worldMatrix update of itself and all parent entities.
@@ -207,6 +204,7 @@ export declare class Transform extends Component {
      * Get worldPosition: Will trigger the worldMatrix, local position update of itself and the worldMatrix update of all parent entities.
      * Get worldRotationQuaternion: Will trigger the world rotation (in quaternion) update of itself and all parent entities.
      * Get worldRotation: Will trigger the world rotation(in euler and quaternion) update of itself and world rotation(in quaternion) update of all parent entities.
+     * Get worldScale: Will trigger the scaling update of itself and all parent entities.
      * In summary, any update of related variables will cause the dirty mark of one of the full process (worldMatrix or worldRotationQuaternion) to be false.
      */
     private _updateWorldRotationFlag;
@@ -215,7 +213,9 @@ export declare class Transform extends Component {
      * Get worldPosition: Will trigger the worldMatrix, local position update of itself and the worldMatrix update of all parent entities.
      * Get worldRotationQuaternion: Will trigger the world rotation (in quaternion) update of itself and all parent entities.
      * Get worldRotation: Will trigger the world rotation(in euler and quaternion) update of itself and world rotation(in quaternion) update of all parent entities.
+     * Get worldScale: Will trigger the scaling update of itself and all parent entities.
      * In summary, any update of related variables will cause the dirty mark of one of the full process (worldMatrix or worldRotationQuaternion) to be false.
+     * @param flags - Dirty flag
      */
     private _updateWorldPositionAndRotationFlag;
     /**
@@ -223,6 +223,7 @@ export declare class Transform extends Component {
      * Get worldPosition: Will trigger the worldMatrix, local position update of itself and the worldMatrix update of all parent entities.
      * Get worldScale: Will trigger the scaling update of itself and all parent entities.
      * In summary, any update of related variables will cause the dirty mark of one of the full process (worldMatrix) to be false.
+     * @param flags - Dirty flag
      */
     private _updateWorldScaleFlag;
     /**
@@ -230,10 +231,12 @@ export declare class Transform extends Component {
      * Get worldPosition: Will trigger the worldMatrix, local position update of itself and the worldMatrix update of all parent entities.
      * Get worldScale: Will trigger the scaling update of itself and all parent entities.
      * In summary, any update of related variables will cause the dirty mark of one of the full process (worldMatrix) to be false.
+     * @param flags - Dirty flag
      */
     private _updateWorldPositionAndScaleFlag;
     /**
      * Update all world transform property dirty flag, the principle is the same as above.
+     * @param flags - Dirty flag
      */
     private _updateAllWorldFlag;
     private _getParentTransform;
@@ -253,4 +256,11 @@ export declare class Transform extends Component {
     private _onRotationQuaternionChanged;
     private _onWorldRotationQuaternionChanged;
     private _onScaleChanged;
+    private _getWorldUniformScaling;
+    /**
+     * @deprecated
+     * Listen for changes in the world pose of this `Entity`.
+     * @returns Change flag
+     */
+    registerWorldChangeFlag(): BoolUpdateFlag;
 }

package/types/asset/AssetType.d.ts

@@ -55,8 +55,12 @@ export declare enum AssetType {
     HDR = "HDR",
     /** Font. */
     Font = "Font",
-    /** Source Font, include ttf、 otf and woff. */
+    /** Source Font, include ttf, otf and woff. */
     SourceFont = "SourceFont",
+    /** AudioClip, include ogg, wav and mp3. */
+    Audio = "Audio",
     /** Project asset. */
-    Project = "project"
+    Project = "project",
+    /** PhysicsMaterial. */
+    PhysicsMaterial = "PhysicsMaterial"
 }

package/types/asset/request.d.ts

@@ -1,4 +1,10 @@
 import { AssetPromise } from "./AssetPromise";
+/**
+ * Configuration options for `request`.
+ * @remarks
+ * This type extends the standard `RequestInit` options with additional
+ * properties for handling retries, timeouts, and custom response types.
+ */
 export type RequestConfig = {
     type?: XMLHttpRequestResponseType | "image";
     retryCount?: number;
@@ -6,9 +12,10 @@ export type RequestConfig = {
     timeout?: number;
 } & RequestInit;
 /**
- * Web request.
- * @param url - The link
- * @param config - Load configuration
+ * Sends a request to the specified URL and returns a promise for the response.
+ * @param url - The URL to send the request to
+ * @param config - Configuration options for the request
+ * @returns A promise that resolves with the response of type `T`
  */
 export declare function request<T>(url: string, config?: RequestConfig): AssetPromise<T>;
 export declare class MultiExecutor {

package/types/audio/AudioClip.d.ts

@@ -0,0 +1,24 @@
+import { Engine } from "../Engine";
+import { ReferResource } from "../asset/ReferResource";
+/**
+ * Audio Clip.
+ */
+export declare class AudioClip extends ReferResource {
+    private _audioBuffer;
+    /** Name of clip. */
+    name: string;
+    /**
+     * Number of discrete audio channels.
+     */
+    get channels(): number;
+    /**
+     * Sample rate, in samples per second.
+     */
+    get sampleRate(): number;
+    /**
+     * Duration, in seconds.
+     */
+    get duration(): number;
+    constructor(engine: Engine, name?: string);
+    protected _onDestroy(): void;
+}

package/types/audio/AudioManager.d.ts

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

package/types/audio/AudioSource.d.ts

@@ -0,0 +1,72 @@
+import { Component } from "../Component";
+import { AudioClip } from "./AudioClip";
+/**
+ * Audio Source Component.
+ */
+export declare class AudioSource extends Component {
+    /** If set to true, the audio component automatically begins to play on startup. */
+    playOnEnabled: boolean;
+    private _isPlaying;
+    private _clip;
+    private _gainNode;
+    private _sourceNode;
+    private _pausedTime;
+    private _playTime;
+    private _volume;
+    private _lastVolume;
+    private _playbackRate;
+    private _loop;
+    /**
+     * The audio clip to play.
+     */
+    get clip(): AudioClip;
+    set clip(value: AudioClip);
+    /**
+     * Whether the clip playing right now.
+     */
+    get isPlaying(): boolean;
+    /**
+     * The volume of the audio source, ranging from 0 to 1.
+     * @defaultValue `1`
+     */
+    get volume(): number;
+    set volume(value: number);
+    /**
+     * The playback rate of the audio source.
+     * @defaultValue `1`
+     */
+    get playbackRate(): number;
+    set playbackRate(value: number);
+    /**
+     * Mutes or unmute the audio source.
+     * Mute sets volume as 0, unmute restore volume.
+     */
+    get mute(): boolean;
+    set mute(value: boolean);
+    /**
+     * Whether the audio clip looping.
+     * @defaultValue `false`
+     */
+    get loop(): boolean;
+    set loop(value: boolean);
+    /**
+     * Playback position in seconds.
+     */
+    get time(): number;
+    /**
+     * Play the clip.
+     */
+    play(): void;
+    /**
+     * Stops playing the clip.
+     */
+    stop(): void;
+    /**
+     * Pauses playing the clip.
+     */
+    pause(): void;
+    private _onPlayEnd;
+    private _initSourceNode;
+    private _clearSourceNode;
+    private _canPlay;
+}

package/types/audio/index.d.ts

@@ -0,0 +1,3 @@
+export { AudioClip } from "./AudioClip";
+export { AudioSource } from "./AudioSource";
+export { AudioManager } from "./AudioManager";

package/types/index.d.ts

@@ -16,6 +16,7 @@ export { BoolUpdateFlag } from "./BoolUpdateFlag";
 export type { EngineSettings } from "./EngineSettings";
 export type { EngineConfiguration } from "./Engine";
 export { request } from "./asset/request";
+export type { RequestConfig } from "./asset/request";
 export { Loader } from "./asset/Loader";
 export { ContentRestorer } from "./asset/ContentRestorer";
 export { ResourceManager, resourceLoader } from "./asset/ResourceManager";
@@ -59,5 +60,6 @@ export * from "./clone/CloneManager";
 export * from "./renderingHardwareInterface/index";
 export * from "./physics/index";
 export * from "./Utils";
+export * from "./audio/index";
 export { ShaderMacroCollection } from "./shader/ShaderMacroCollection";
 export * from "./postProcess";

package/types/material/BaseMaterial.d.ts

@@ -16,10 +16,10 @@ export declare class BaseMaterial extends Material {
     protected static _normalIntensityProp: ShaderProperty;
     protected static _emissiveColorProp: ShaderProperty;
     protected static _emissiveTextureProp: ShaderProperty;
-    private static _alphaCutoffProp;
+    protected static _alphaCutoffProp: ShaderProperty;
     private static _alphaCutoffMacro;
     private _renderFace;
-    private _isTransparent;
+    protected _isTransparent: boolean;
     private _blendMode;
     /**
      * Shader used by the material.
@@ -83,4 +83,6 @@ export declare class BaseMaterial extends Material {
      * @param target - target material
      */
     cloneTo(target: BaseMaterial): void;
+    protected _seIsTransparent(value: boolean): void;
+    protected _setAlphaCutoff(value: number): void;
 }

package/types/material/PBRMaterial.d.ts

@@ -1,7 +1,8 @@
-import { Vector2 } from "@galacean/engine-math";
+import { Color, Vector2 } from "@galacean/engine-math";
 import { Engine } from "../Engine";
 import { Texture2D } from "../texture/Texture2D";
 import { PBRBaseMaterial } from "./PBRBaseMaterial";
+import { RefractionMode } from "./enums/Refraction";
 /**
  * PBR (Metallic-Roughness Workflow) Material.
  */
@@ -12,11 +13,27 @@ export declare class PBRMaterial extends PBRBaseMaterial {
     private static _iorProp;
     private static _anisotropyInfoProp;
     private static _anisotropyTextureProp;
-    private _anisotropyRotation;
     private static _iridescenceInfoProp;
     private static _iridescenceThicknessTextureProp;
     private static _iridescenceTextureProp;
+    private static _sheenColorProp;
+    private static _sheenRoughnessProp;
+    private static _sheenTextureProp;
+    private static _sheenRoughnessTextureProp;
+    private static _transmissionMacro;
+    private static _thicknessMacro;
+    private static _thicknessTextureMacro;
+    private static _transmissionTextureMacro;
+    private static _transmissionProp;
+    private static _transmissionTextureProp;
+    private static _attenuationColorProp;
+    private static _attenuationDistanceProp;
+    private static _thicknessProp;
+    private static _thicknessTextureProp;
+    private _refractionMode;
+    private _anisotropyRotation;
     private _iridescenceRange;
+    private _sheenEnabled;
     /**
      * Index Of Refraction.
      * @defaultValue `1.5`
@@ -80,7 +97,7 @@ export declare class PBRMaterial extends PBRBaseMaterial {
     set iridescenceIOR(value: number);
     /**
      * The range of iridescence thickness, x is minimum, y is maximum.
-     *  @defaultValue `[100, 400]`.
+     *  @defaultValue `[100, 400]`
      */
     get iridescenceThicknessRange(): Vector2;
     set iridescenceThicknessRange(value: Vector2);
@@ -92,14 +109,90 @@ export declare class PBRMaterial extends PBRBaseMaterial {
      */
     get iridescenceThicknessTexture(): Texture2D;
     set iridescenceThicknessTexture(value: Texture2D);
+    /**
+     * Sheen color.
+     * @defaultValue `[0,0,0]`
+     */
+    get sheenColor(): Color;
+    set sheenColor(value: Color);
+    /**
+     * Sheen roughness, from 0.0 to 1.0.
+     * @defaultValue `0.0`
+     */
+    get sheenRoughness(): number;
+    set sheenRoughness(value: number);
+    /**
+     * Sheen color texture, multiply ‘sheenColor’.
+     */
+    get sheenColorTexture(): Texture2D;
+    set sheenColorTexture(value: Texture2D);
+    /**
+     * Sheen roughness texture.
+     * @remarks Use alpha channel, and multiply 'sheenRoughness'.
+     */
+    get sheenRoughnessTexture(): Texture2D;
+    set sheenRoughnessTexture(value: Texture2D);
+    /**
+     * Refraction switch.
+     * @remarks Use refractionMode to set the refraction shape.
+     */
+    get refractionMode(): RefractionMode;
+    set refractionMode(value: RefractionMode);
+    /**
+     * @inheritdoc
+     */
+    get isTransparent(): boolean;
+    set isTransparent(value: boolean);
+    /**
+     * @inheritdoc
+     */
+    get alphaCutoff(): number;
+    set alphaCutoff(value: number);
+    /**
+     * Transmission factor.
+     * @defaultValue `0.0`
+     */
+    get transmission(): number;
+    set transmission(value: number);
+    /**
+     * Transmission texture.
+     * @remarks Use red channel, and multiply 'transmission'.
+     */
+    get transmissionTexture(): Texture2D;
+    set transmissionTexture(value: Texture2D);
+    /**
+     * Attenuation color.
+     * @defaultValue `[1,1,1]`
+     */
+    get attenuationColor(): Color;
+    set attenuationColor(value: Color);
+    /**
+     * Attenuation distance, greater than 0.0.
+     * @defaultValue `infinity`
+     */
+    get attenuationDistance(): number;
+    set attenuationDistance(value: number);
+    /**
+     * Thickness, greater than or equal to 0.0.
+     * @defaultValue `0.0`
+     */
+    get thickness(): number;
+    set thickness(value: number);
+    /**
+     * Thickness texture.
+     * @remarks Use green channel, and multiply 'thickness', range is 0.0 to 1.0.
+     */
+    get thicknessTexture(): Texture2D;
+    set thicknessTexture(value: Texture2D);
     /**
      * Create a pbr metallic-roughness workflow material instance.
      * @param engine - Engine to which the material belongs
      */
     constructor(engine: Engine);
-    private _onIridescenceRangeChanged;
     /**
      * @inheritdoc
      */
     clone(): PBRMaterial;
+    private _onIridescenceRangeChanged;
+    private _onSheenColorChanged;
 }

package/types/material/enums/Refraction.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Refraction mode.
+ */
+export declare enum RefractionMode {
+    /** Use the sphere refraction model when light passes through the surface. */
+    Sphere = 0,
+    /** Use the planar refraction model when light passes through the surface. */
+    Planar = 1
+}

package/types/material/index.d.ts

@@ -8,3 +8,4 @@ export { PBRBaseMaterial } from "./PBRBaseMaterial";
 export { PBRMaterial } from "./PBRMaterial";
 export { PBRSpecularMaterial } from "./PBRSpecularMaterial";
 export { UnlitMaterial } from "./UnlitMaterial";
+export { RefractionMode } from "./enums/Refraction";