@eva/plugin-renderer 2.0.1-beta.27 → 2.0.1-beta.29

package/dist/plugin-renderer.cjs.js

@@ -44,12 +44,45 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+/**
+ * 渲染管理器类
+ *
+ * RendererManager 负责管理和协调所有渲染器。
+ * 它将组件变化事件分发给相应的渲染器，
+ * 并在每帧调用渲染器的更新方法。
+ *
+ * @example
+ * ```typescript
+ * const rendererManager = new RendererManager({
+ *   game,
+ *   rendererSystem
+ * });
+ *
+ * rendererManager.register(
+ *   new SpriteRenderer(),
+ *   new TextRenderer()
+ * );
+ * ```
+ */
 class RendererManager {
+    /**
+     * 构造渲染管理器
+     * @param game - 游戏实例
+     * @param rendererSystem - 渲染系统实例
+     */
     constructor({ game, rendererSystem }) {
+        /** 注册的渲染器列表 */
         this.renderers = [];
         this.game = game;
         this.rendererSystem = rendererSystem;
     }
+    /**
+     * 注册渲染器
+     *
+     * 将渲染器添加到管理器，并为其设置必要的引用。
+     *
+     * @param renderers - 要注册的渲染器列表
+     */
     register(...renderers) {
         for (const renderer of renderers) {
             renderer.game = this.game;
@@ -131,9 +164,11 @@ class ContainerManager {
             return;
         const { anchor, origin, position, rotation, scale, size, skew } = transform;
         container.rotation = rotation;
+        // @ts-ignore
         container.scale = scale;
         container.pivot.x = size.width * origin.x;
         container.pivot.y = size.height * origin.y;
+        // @ts-ignore
         container.skew = skew;
         let x = position.x;
         let y = position.y;
@@ -142,6 +177,7 @@ class ContainerManager {
             x = x + parent.size.width * anchor.x;
             y = y + parent.size.height * anchor.y;
         }
+        // @ts-ignore
         container.position = { x, y };
     }
 }
@@ -158,7 +194,12 @@ let Transform = class Transform extends EventEmitter__default {
     init(system) {
         this.system = system;
         this.on('changeScene', ({ scene, mode, application }) => {
+            // switch (mode) {
+            // case LOAD_SCENE_MODE.SINGLE:
             this.waitChangeScenes.push({ scene, mode, application });
+            // break;
+            // case LOAD_SCENE_MODE.MULTI_CANVAS:
+            // }
         });
     }
     update() {
@@ -167,6 +208,7 @@ let Transform = class Transform extends EventEmitter__default {
         }
         this.waitRemoveIds = [];
         for (const sceneInfo of this.waitChangeScenes) {
+            // set scene
             const container = this.containerManager.getContainer(sceneInfo.scene.id);
             if (container) {
                 sceneInfo.application.stage.removeChildren();
@@ -299,17 +341,20 @@ let Renderer$1 = class Renderer extends eva_js.System {
         });
     }
     registerObserver(observerInfo) {
+        // @ts-ignore
         const thisObserverInfo = this.constructor.observerInfo;
         for (const key in observerInfo) {
             if (!thisObserverInfo[key]) {
                 thisObserverInfo[key] = [];
             }
+            //@ts-ignore
             thisObserverInfo[key].push(...observerInfo[key]);
         }
     }
     createMultiApplication({ params }) {
         return __awaiter(this, void 0, void 0, function* () {
             const app = yield this.createApplication(params);
+            // @ts-ignore
             this.multiApps.push(app);
             return app;
         });
@@ -363,6 +408,7 @@ let Renderer$1 = class Renderer extends eva_js.System {
     resize(width, height) {
         this.params.width = width;
         this.params.height = height;
+        // @ts-ignore
         this.application.renderer.resize(width, height);
     }
     getApplicationByScene(scene) {
@@ -390,6 +436,7 @@ let Renderer$1 = class Renderer extends eva_js.System {
     resizeByScene(scene, width, height) {
         const app = this.getApplicationByScene(scene);
         if (app) {
+            // @ts-ignore
             app.renderer.resize(width, height);
         }
     }
@@ -409,7 +456,9 @@ function getSuportCompressedTextureFormats() {
     const canvas = document.createElement('canvas');
     const gl = canvas.getContext('webgl2');
     if (!gl) {
+        // #if _DEBUG
         console.warn('WebGL not available for compressed textures. Silently failing.');
+        // #endif
         return {
             s3tc: false,
             etc: false,
@@ -462,14 +511,29 @@ function registerKtx2CompressedTexture(params) {
     addPreProcessResourceHandler(eva_js.resource);
 }
 
+/* eslint-disable @typescript-eslint/no-unused-vars */
 class Renderer extends eva_js.System {
     constructor(params) {
         super(params);
         this.asyncIdMap = {};
+        // @ts-ignore
         this.observerInfo = this.constructor.observerInfo;
     }
+    // init(arg?: any): void;
+    /**
+     * 当监听的属性变化时候调用
+     *
+     * called while the observed component props change.
+     */
     componentChanged(_changed) { }
+    /**
+     * 每帧调用
+     *
+     * called by every loop
+     * @param _gameObject gameObject
+     */
     rendererUpdate(_gameObject) { }
+    // @ts-ignore
     update(e) {
         const changes = this.componentObserver.clear();
         for (const changed of changes) {
@@ -485,7 +549,19 @@ class Renderer extends eva_js.System {
     }
 }
 
+// import { BaseTexture, utils } from 'pixi.js';
 const mixinPIXI = () => {
+    // BaseTexture.prototype.destroy = function () {
+    //   if (this.imageUrl) {
+    //     delete utils.TextureCache[this.imageUrl];
+    //     this.imageUrl = null;
+    //   }
+    //   this.source = null;
+    //   this.dispose();
+    //   BaseTexture.removeFromCache(this);
+    //   this.textureCacheIds = null;
+    //   this._destroyed = true;
+    // };
 };
 
 mixinPIXI();

package/dist/plugin-renderer.d.ts

@@ -37,14 +37,40 @@ declare interface Params {
 export declare function registerKtx2CompressedTexture(params: Params): void;
 
 export declare class Renderer<T extends {} = {}> extends System<T> {
+    /**
+     * Renderer name
+     */
     name: string;
+    /**
+     * currentGame
+     */
     game: Game;
+    /**
+     * observer component props info
+     */
     static observerInfo: PureObserverInfo;
+    /**
+     * observer component props info
+     */
     observerInfo: PureObserverInfo;
+    /**
+     * containerManager
+     */
     containerManager: ContainerManager;
     rendererManager: RendererManager;
     constructor(params?: T);
+    /**
+     * 当监听的属性变化时候调用
+     *
+     * called while the observed component props change.
+     */
     componentChanged(_changed: ComponentChanged): void;
+    /**
+     * 每帧调用
+     *
+     * called by every loop
+     * @param _gameObject gameObject
+     */
     rendererUpdate(_gameObject: GameObject): void;
     update(e?: UpdateParams): void;
     protected asyncIdMap: Record<number, number>;
@@ -58,14 +84,49 @@ export declare enum RENDERER_TYPE {
     CANVAS = 2
 }
 
+/**
+ * 渲染管理器类
+ *
+ * RendererManager 负责管理和协调所有渲染器。
+ * 它将组件变化事件分发给相应的渲染器，
+ * 并在每帧调用渲染器的更新方法。
+ *
+ * @example
+ * ```typescript
+ * const rendererManager = new RendererManager({
+ *   game,
+ *   rendererSystem
+ * });
+ *
+ * rendererManager.register(
+ *   new SpriteRenderer(),
+ *   new TextRenderer()
+ * );
+ * ```
+ */
 export declare class RendererManager {
+    /** 游戏实例引用 */
     game: Game;
+    /** 渲染系统引用 */
     rendererSystem: RendererSystem;
+    /**
+     * 构造渲染管理器
+     * @param game - 游戏实例
+     * @param rendererSystem - 渲染系统实例
+     */
     constructor({ game, rendererSystem }: {
         game: any;
         rendererSystem: any;
     });
+    /** 注册的渲染器列表 */
     renderers: Renderer[];
+    /**
+     * 注册渲染器
+     *
+     * 将渲染器添加到管理器，并为其设置必要的引用。
+     *
+     * @param renderers - 要注册的渲染器列表
+     */
     register(...renderers: Renderer[]): void;
     componentChanged(changes: ComponentChanged[]): void;
     update(gameObject: GameObject): void;

package/dist/plugin-renderer.esm.js

@@ -35,12 +35,45 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
+/**
+ * 渲染管理器类
+ *
+ * RendererManager 负责管理和协调所有渲染器。
+ * 它将组件变化事件分发给相应的渲染器，
+ * 并在每帧调用渲染器的更新方法。
+ *
+ * @example
+ * ```typescript
+ * const rendererManager = new RendererManager({
+ *   game,
+ *   rendererSystem
+ * });
+ *
+ * rendererManager.register(
+ *   new SpriteRenderer(),
+ *   new TextRenderer()
+ * );
+ * ```
+ */
 class RendererManager {
+    /**
+     * 构造渲染管理器
+     * @param game - 游戏实例
+     * @param rendererSystem - 渲染系统实例
+     */
     constructor({ game, rendererSystem }) {
+        /** 注册的渲染器列表 */
         this.renderers = [];
         this.game = game;
         this.rendererSystem = rendererSystem;
     }
+    /**
+     * 注册渲染器
+     *
+     * 将渲染器添加到管理器，并为其设置必要的引用。
+     *
+     * @param renderers - 要注册的渲染器列表
+     */
     register(...renderers) {
         for (const renderer of renderers) {
             renderer.game = this.game;
@@ -122,9 +155,11 @@ class ContainerManager {
             return;
         const { anchor, origin, position, rotation, scale, size, skew } = transform;
         container.rotation = rotation;
+        // @ts-ignore
         container.scale = scale;
         container.pivot.x = size.width * origin.x;
         container.pivot.y = size.height * origin.y;
+        // @ts-ignore
         container.skew = skew;
         let x = position.x;
         let y = position.y;
@@ -133,6 +168,7 @@ class ContainerManager {
             x = x + parent.size.width * anchor.x;
             y = y + parent.size.height * anchor.y;
         }
+        // @ts-ignore
         container.position = { x, y };
     }
 }
@@ -149,7 +185,12 @@ let Transform = class Transform extends EventEmitter {
     init(system) {
         this.system = system;
         this.on('changeScene', ({ scene, mode, application }) => {
+            // switch (mode) {
+            // case LOAD_SCENE_MODE.SINGLE:
             this.waitChangeScenes.push({ scene, mode, application });
+            // break;
+            // case LOAD_SCENE_MODE.MULTI_CANVAS:
+            // }
         });
     }
     update() {
@@ -158,6 +199,7 @@ let Transform = class Transform extends EventEmitter {
         }
         this.waitRemoveIds = [];
         for (const sceneInfo of this.waitChangeScenes) {
+            // set scene
             const container = this.containerManager.getContainer(sceneInfo.scene.id);
             if (container) {
                 sceneInfo.application.stage.removeChildren();
@@ -290,17 +332,20 @@ let Renderer$1 = class Renderer extends System {
         });
     }
     registerObserver(observerInfo) {
+        // @ts-ignore
         const thisObserverInfo = this.constructor.observerInfo;
         for (const key in observerInfo) {
             if (!thisObserverInfo[key]) {
                 thisObserverInfo[key] = [];
             }
+            //@ts-ignore
             thisObserverInfo[key].push(...observerInfo[key]);
         }
     }
     createMultiApplication({ params }) {
         return __awaiter(this, void 0, void 0, function* () {
             const app = yield this.createApplication(params);
+            // @ts-ignore
             this.multiApps.push(app);
             return app;
         });
@@ -354,6 +399,7 @@ let Renderer$1 = class Renderer extends System {
     resize(width, height) {
         this.params.width = width;
         this.params.height = height;
+        // @ts-ignore
         this.application.renderer.resize(width, height);
     }
     getApplicationByScene(scene) {
@@ -381,6 +427,7 @@ let Renderer$1 = class Renderer extends System {
     resizeByScene(scene, width, height) {
         const app = this.getApplicationByScene(scene);
         if (app) {
+            // @ts-ignore
             app.renderer.resize(width, height);
         }
     }
@@ -400,7 +447,9 @@ function getSuportCompressedTextureFormats() {
     const canvas = document.createElement('canvas');
     const gl = canvas.getContext('webgl2');
     if (!gl) {
+        // #if _DEBUG
         console.warn('WebGL not available for compressed textures. Silently failing.');
+        // #endif
         return {
             s3tc: false,
             etc: false,
@@ -453,14 +502,29 @@ function registerKtx2CompressedTexture(params) {
     addPreProcessResourceHandler(resource);
 }
 
+/* eslint-disable @typescript-eslint/no-unused-vars */
 class Renderer extends System {
     constructor(params) {
         super(params);
         this.asyncIdMap = {};
+        // @ts-ignore
         this.observerInfo = this.constructor.observerInfo;
     }
+    // init(arg?: any): void;
+    /**
+     * 当监听的属性变化时候调用
+     *
+     * called while the observed component props change.
+     */
     componentChanged(_changed) { }
+    /**
+     * 每帧调用
+     *
+     * called by every loop
+     * @param _gameObject gameObject
+     */
     rendererUpdate(_gameObject) { }
+    // @ts-ignore
     update(e) {
         const changes = this.componentObserver.clear();
         for (const changed of changes) {
@@ -476,7 +540,19 @@ class Renderer extends System {
     }
 }
 
+// import { BaseTexture, utils } from 'pixi.js';
 const mixinPIXI = () => {
+    // BaseTexture.prototype.destroy = function () {
+    //   if (this.imageUrl) {
+    //     delete utils.TextureCache[this.imageUrl];
+    //     this.imageUrl = null;
+    //   }
+    //   this.source = null;
+    //   this.dispose();
+    //   BaseTexture.removeFromCache(this);
+    //   this.textureCacheIds = null;
+    //   this._destroyed = true;
+    // };
 };
 
 mixinPIXI();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eva/plugin-renderer",
-  "version": "2.0.1-beta.27",
+  "version": "2.0.1-beta.29",
   "description": "@eva/plugin-renderer",
   "main": "index.js",
   "module": "dist/plugin-renderer.esm.js",
@@ -18,8 +18,8 @@
   "license": "MIT",
   "homepage": "https://eva.js.org",
   "dependencies": {
-    "@eva/eva.js": "2.0.1-beta.27",
-    "@eva/renderer-adapter": "2.0.1-beta.27",
+    "@eva/eva.js": "2.0.1-beta.29",
+    "@eva/renderer-adapter": "2.0.1-beta.29",
     "eventemitter3": "^3.1.2",
     "lodash-es": "^4.17.21",
     "pixi.js": "^8.8.1"