@xviewer.js/core 1.0.0-alpha.46 → 1.0.0-alpha.48

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xviewer.js/core",
-  "version": "1.0.0-alpha.46",
+  "version": "1.0.0-alpha.48",
   "license": "MIT",
   "type": "module",
   "sideEffects": false,

package/types/Viewer.d.ts

@@ -77,6 +77,8 @@ export declare class Viewer extends EventEmitter {
     };
     get rootRotated(): boolean;
     get input(): DeviceInput;
+    get targetFrameRate(): number;
+    set targetFrameRate(v: number);
     constructor({ root, canvas, autoStart, autoResize, shadows, camera, targetFrameRate, colorSpace, toneMapping, toneMappingExposure, maxDPR, path, resourcePath, dracoPath, orientation, loader, tasker, ...webglOpts }?: {
         root?: HTMLElement;
         canvas?: HTMLCanvasElement;

package/types/components/index.d.ts

@@ -1,2 +1 @@
 export { Reflector } from "./Reflector";
-export { PerformanceMonitor } from "./PerformanceMonitor";

package/types/passes/cubeuv/MergeInfo.d.ts

@@ -1,6 +1,6 @@
 import { WebGLRenderTarget } from "three";
 export interface MergeInfo {
-    performance: number;
+    quality: number;
     envMapTarget: WebGLRenderTarget;
     envMapIntensity: number;
     blurIntensity: number;

package/types/passes/cubeuv/utils.d.ts

@@ -2,10 +2,11 @@ import { OrthographicCamera, ShaderMaterial, Vector3, WebGLRenderTarget } from "
 export declare const LOD_MIN = 4;
 export declare const _flatCamera: OrthographicCamera;
 export declare const _axisDirections: Vector3[];
-export declare const _Performance: {
-    HIGH: number;
-    MEDIUM: number;
+export declare const _Quality: {
     LOW: number;
+    MEDIUM: number;
+    HIGH: number;
+    ULTRA: number;
 };
 export declare function _setViewport(target: WebGLRenderTarget, x: number, y: number, width: number, height: number): void;
 export declare function _getCommonVertexShader(): string;

package/types/plugins/EnvironmentPlugin.d.ts

@@ -1,10 +1,11 @@
 import { Object3D, Scene, Texture, TextureDataType, Vector3 } from "three";
 import { Plugin } from "../Plugin";
 export declare class EnvironmentPlugin extends Plugin {
-    static Performance: {
-        HIGH: number;
-        MEDIUM: number;
+    static readonly Quality: {
         LOW: number;
+        MEDIUM: number;
+        HIGH: number;
+        ULTRA: number;
     };
     private _scene;
     private _cubeCamera;
@@ -16,11 +17,12 @@ export declare class EnvironmentPlugin extends Plugin {
     private _elapsed;
     get debug(): boolean;
     set debug(v: boolean);
-    performance: number;
+    quality: number;
     envMapIntensity: number;
     reflectExposure: number;
     reflectBlurIntensity: number;
     interval: number;
+    manual: boolean;
     constructor({ envMap, scene, near, far, layer, resolution, floatType, position, }?: {
         envMap?: Texture;
         scene?: Scene | Object3D;
@@ -33,5 +35,6 @@ export declare class EnvironmentPlugin extends Plugin {
         position?: Vector3;
     });
     onRender(dt: number): void;
+    manualFrame(): void;
     private _renderFrame;
 }

package/types/plugins/PerformanceMonitorPlugin.d.ts

@@ -0,0 +1,48 @@
+import { Plugin } from "../Plugin";
+type PerformanceMonitorProps = {
+    /** How much time in milliseconds to collect an average fps, 250 */
+    ms?: number;
+    /** How many interations of averages to collect, 10 */
+    iterations?: number;
+    /** The percentage of iterations that are matched against the lower and upper bounds, 0.75 */
+    threshold?: number;
+    /** A function that receive the max device refreshrate to determine lower and upper bounds which create a margin where neither incline nor decline should happen, (refreshrate) => (refreshrate > 90 ? [50, 90] : [50, 60]) */
+    bounds?: (refreshrate: number) => [lower: number, upper: number];
+    /** How many times it can inline or decline before onFallback is called, Infinity */
+    flipflops?: number;
+    /** The factor increases and decreases between 0-1, this prop sets the starting value, 0.5 */
+    factor?: number;
+    /** The step that gets added or subtracted to or from the factor on each incline/decline, 0.1 */
+    step?: number;
+    /** When performance is higher than the upper bound (good!) */
+    onIncline?: (monitor: PerformanceMonitorPlugin) => void;
+    /** When performance is lower than the upper bound (bad!) */
+    onDecline?: (monitor: PerformanceMonitorPlugin) => void;
+    /** Incline and decline will change the factor, this will trigger when that happened */
+    onChange?: (monitor: PerformanceMonitorPlugin) => void;
+    /** Called after when the number of flipflops is reached, it indicates instability, use the function to set a fixed baseline */
+    onFallback?: (monitor: PerformanceMonitorPlugin) => void;
+};
+type PerformanceMonitorSubscriber = {
+    onIncline?: (monitor: PerformanceMonitorPlugin) => void;
+    /** When performance is lower than the upper bound (bad!) */
+    onDecline?: (monitor: PerformanceMonitorPlugin) => void;
+    /** Incline and decline will change the factor, this will trigger when that happened */
+    onChange?: (monitor: PerformanceMonitorPlugin) => void;
+    /** Called after when the number of flipflops is reached, it indicates instability, use the function to set a fixed baseline */
+    onFallback?: (monitor: PerformanceMonitorPlugin) => void;
+};
+export declare class PerformanceMonitorPlugin extends Plugin {
+    fps: number;
+    index: number;
+    factor: number;
+    flipped: number;
+    refreshrate: number;
+    fallback: boolean;
+    frames: any[];
+    averages: any[];
+    subscriptions: Map<any, any>;
+    subscribe(subscriber: PerformanceMonitorSubscriber): void;
+    constructor({ iterations, ms, threshold, step, factor: _factor, flipflops, bounds, onIncline, onDecline, onChange, onFallback, }: PerformanceMonitorProps);
+}
+export {};

package/types/plugins/index.d.ts

@@ -1,3 +1,4 @@
 export { DebugPlugin } from "./DebugPlugin";
 export { EnvironmentPlugin } from "./EnvironmentPlugin";
 export { BoxProjectionPlugin } from "./BoxProjectionPlugin";
+export { PerformanceMonitorPlugin } from "./PerformanceMonitorPlugin";