@galacean/effects-plugin-stats 2.5.0-alpha.0 → 2.5.0-alpha.1

package/dist/monitor.d.ts

@@ -1,12 +1,33 @@
 import type { Disposable } from '@galacean/effects';
+import { EventEmitter } from '@galacean/effects';
+import type { PerformanceData } from './core';
+import { Core } from './core';
 import type { StatsOptions } from './stats';
-export declare class Monitor implements Disposable {
+/**
+ * Performance monitor event type.
+ */
+export type MonitorEvent = {
+    ['update']: [data: PerformanceData];
+};
+/**
+ * Performance monitor.
+ */
+export declare class Monitor extends EventEmitter<MonitorEvent> implements Disposable {
     private readonly options;
-    private core;
+    /**
+     * The core of the monitor, which handles the performance data collection.
+     */
+    core: Core;
     private doms;
     private container;
     private readonly items;
+    private visible;
     private data;
+    /**
+     * Create a new Monitor instance.
+     * @param gl
+     * @param options
+     */
     constructor(gl: WebGLRenderingContext | WebGL2RenderingContext, options: Required<StatsOptions>);
     private createContainer;
     private createStyle;
@@ -14,7 +35,13 @@ export declare class Monitor implements Disposable {
      * Update per frame
      */
     update(dt: number): void;
+    /**
+     * Hide the monitor
+     */
     hide(): void;
+    /**
+     * Show the monitor
+     */
     show(): void;
     /**
      * reset all hooks

package/dist/stats-component.d.ts

@@ -1,12 +1,22 @@
 import { Behaviour } from '@galacean/effects';
 import { Monitor } from './monitor';
 import type { StatsOptions } from './stats';
+/**
+ * Stats 组件，用于监控渲染性能
+ */
 export declare class StatsComponent extends Behaviour {
     /**
      * 监控对象
      */
     monitor: Monitor;
     init(options: Required<StatsOptions>): void;
+    /**
+     * 每帧更新
+     * @param dt
+     */
     onUpdate(dt: number): void;
+    /**
+     * 释放资源
+     */
     dispose(): void;
 }

package/dist/stats.d.ts

@@ -1,6 +1,8 @@
 import type { Player, Disposable } from '@galacean/effects';
+import { Deferred } from '@galacean/effects';
+import { StatsComponent } from './stats-component';
 /**
- *
+ * Options for the Stats plugin.
  */
 export interface StatsOptions {
     /**
@@ -17,21 +19,64 @@ export interface StatsOptions {
     container?: HTMLElement;
 }
 /**
+ * Stats plugin for the Player.
+ *
+ * @example
+ * ```ts
+ * // Simple usage of Stats plugin
+ * import { Stats } from '@galacean/effects-plugin-stats';
+ *
+ * const stats = new Stats(player);
+ * // Hide the stats monitor
+ * stats.hide();
+ * // Show the stats monitor
+ * stats.show();
+ * ```
  *
+ * @example
+ * ```ts
+ * // 自定义 Stats 组件的 onUpdate 方法
+ * // 可用于在每帧更新时获取性能数据
+ * const stats = new Stats(player, { visible: false });
+ * const [_, component] = await Promise.all([
+ *   player.loadScene(json),
+ *   stats.getComponent(),
+ * ]);
+ *
+ * component?.monitor.on('update', data => {
+ *   console.info(data);
+ * });
+ * ```
  */
 export declare class Stats implements Disposable {
     readonly player: Player;
     private readonly options?;
     private component?;
     private disposed;
+    protected readonly initialized: Deferred<void>;
     /**
-     *
+     * Create a new Stats instance.
      * @param player
      * @param options
      */
     constructor(player: Player, options?: StatsOptions | undefined);
     init(): Promise<void>;
+    /**
+     * Get the stats component.
+     * @returns
+     */
+    getComponent(): Promise<StatsComponent | undefined>;
+    /**
+     * Hide the stats monitor.
+     */
     hide(): void;
+    /**
+     * Show the stats monitor.
+     */
     show(): void;
+    /**
+     * Dispose the stats component and release resources.
+     * @returns
+     */
     dispose(): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-plugin-stats",
-  "version": "2.5.0-alpha.0",
+  "version": "2.5.0-alpha.1",
   "description": "Galacean Effects runtime stats for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
@@ -28,7 +28,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "devDependencies": {
-    "@galacean/effects": "2.5.0-alpha.0"
+    "@galacean/effects": "2.5.0-alpha.1"
   },
   "scripts": {
     "dev": "vite",